course/tests/externallib_test.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * External course functions unit tests
  19  *
  20  * @package    core_course
  21  * @category   external
  22  * @copyright  2012 Jerome Mouneyrac
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 global $CFG;
  29
  30 require_once($CFG->dirroot . '/webservice/tests/helpers.php');
  31
  32 /**
  33  * External course functions unit tests
  34  *
  35  * @package    core_course
  36  * @category   external
  37  * @copyright  2012 Jerome Mouneyrac
  38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 class core_course_externallib_testcase extends externallib_advanced_testcase {
  41
  42     /**
  43      * Tests set up
  44      */
  45     protected function setUp() {
  46         global $CFG;
  47         require_once($CFG->dirroot . '/course/externallib.php');
  48     }
  49
  50     /**
  51      * Test create_categories
  52      */
  53     public function test_create_categories() {
  54
  55         global $DB;
  56
  57         $this->resetAfterTest(true);
  58
  59         // Set the required capabilities by the external function
  60         $contextid = context_system::instance()->id;
  61         $roleid = $this->assignUserCapability('moodle/category:manage', $contextid);
  62
  63         // Create base categories.
  64         $category1 = new stdClass();
  65         $category1->name = 'Root Test Category 1';
  66         $category2 = new stdClass();
  67         $category2->name = 'Root Test Category 2';
  68         $category2->idnumber = 'rootcattest2';
  69         $category2->desc = 'Description for root test category 1';
  70         $category2->theme = 'bootstrapbase';
  71         $categories = array(
  72             array('name' => $category1->name, 'parent' => 0),
  73             array('name' => $category2->name, 'parent' => 0, 'idnumber' => $category2->idnumber,
  74                 'description' => $category2->desc, 'theme' => $category2->theme)
  75         );
  76
  77         $createdcats = core_course_external::create_categories($categories);
  78
  79         // We need to execute the return values cleaning process to simulate the web service server.
  80         $createdcats = external_api::clean_returnvalue(core_course_external::create_categories_returns(), $createdcats);
  81
  82         // Initially confirm that base data was inserted correctly.
  83         $this->assertEquals($category1->name, $createdcats[0]['name']);
  84         $this->assertEquals($category2->name, $createdcats[1]['name']);
  85
  86         // Save the ids.
  87         $category1->id = $createdcats[0]['id'];
  88         $category2->id = $createdcats[1]['id'];
  89
  90         // Create on sub category.
  91         $category3 = new stdClass();
  92         $category3->name = 'Sub Root Test Category 3';
  93         $subcategories = array(
  94             array('name' => $category3->name, 'parent' => $category1->id)
  95         );
  96
  97         $createdsubcats = core_course_external::create_categories($subcategories);
  98
  99         // We need to execute the return values cleaning process to simulate the web service server.
 100         $createdsubcats = external_api::clean_returnvalue(core_course_external::create_categories_returns(), $createdsubcats);
 101
 102         // Confirm that sub categories were inserted correctly.
 103         $this->assertEquals($category3->name, $createdsubcats[0]['name']);
 104
 105         // Save the ids.
 106         $category3->id = $createdsubcats[0]['id'];
 107
 108         // Calling the ws function should provide a new sortorder to give category1,
 109         // category2, category3. New course categories are ordered by id not name.
 110         $category1 = $DB->get_record('course_categories', array('id' => $category1->id));
 111         $category2 = $DB->get_record('course_categories', array('id' => $category2->id));
 112         $category3 = $DB->get_record('course_categories', array('id' => $category3->id));
 113
 114         // sortorder sequence (and sortorder) must be:
 115         // category 1
 116         //   category 3
 117         // category 2
 118         $this->assertGreaterThan($category1->sortorder, $category3->sortorder);
 119         $this->assertGreaterThan($category3->sortorder, $category2->sortorder);
 120
 121         // Call without required capability
 122         $this->unassignUserCapability('moodle/category:manage', $contextid, $roleid);
 123         $this->expectException('required_capability_exception');
 124         $createdsubcats = core_course_external::create_categories($subcategories);
 125
 126     }
 127
 128     /**
 129      * Test delete categories
 130      */
 131     public function test_delete_categories() {
 132         global $DB;
 133
 134         $this->resetAfterTest(true);
 135
 136         // Set the required capabilities by the external function
 137         $contextid = context_system::instance()->id;
 138         $roleid = $this->assignUserCapability('moodle/category:manage', $contextid);
 139
 140         $category1  = self::getDataGenerator()->create_category();
 141         $category2  = self::getDataGenerator()->create_category(
 142                 array('parent' => $category1->id));
 143         $category3  = self::getDataGenerator()->create_category();
 144         $category4  = self::getDataGenerator()->create_category(
 145                 array('parent' => $category3->id));
 146         $category5  = self::getDataGenerator()->create_category(
 147                 array('parent' => $category4->id));
 148
 149         //delete category 1 and 2 + delete category 4, category 5 moved under category 3
 150         core_course_external::delete_categories(array(
 151             array('id' => $category1->id, 'recursive' => 1),
 152             array('id' => $category4->id)
 153         ));
 154
 155         //check $category 1 and 2 are deleted
 156         $notdeletedcount = $DB->count_records_select('course_categories',
 157             'id IN ( ' . $category1->id . ',' . $category2->id . ',' . $category4->id . ')');
 158         $this->assertEquals(0, $notdeletedcount);
 159
 160         //check that $category5 as $category3 for parent
 161         $dbcategory5 = $DB->get_record('course_categories', array('id' => $category5->id));
 162         $this->assertEquals($dbcategory5->path, $category3->path . '/' . $category5->id);
 163
 164          // Call without required capability
 165         $this->unassignUserCapability('moodle/category:manage', $contextid, $roleid);
 166         $this->expectException('required_capability_exception');
 167         $createdsubcats = core_course_external::delete_categories(
 168                 array(array('id' => $category3->id)));
 169     }
 170
 171     /**
 172      * Test get categories
 173      */
 174     public function test_get_categories() {
 175         global $DB;
 176
 177         $this->resetAfterTest(true);
 178
 179         $generatedcats = array();
 180         $category1data['idnumber'] = 'idnumbercat1';
 181         $category1data['name'] = 'Category 1 for PHPunit test';
 182         $category1data['description'] = 'Category 1 description';
 183         $category1data['descriptionformat'] = FORMAT_MOODLE;
 184         $category1  = self::getDataGenerator()->create_category($category1data);
 185         $generatedcats[$category1->id] = $category1;
 186         $category2  = self::getDataGenerator()->create_category(
 187                 array('parent' => $category1->id));
 188         $generatedcats[$category2->id] = $category2;
 189         $category6  = self::getDataGenerator()->create_category(
 190                 array('parent' => $category1->id, 'visible' => 0));
 191         $generatedcats[$category6->id] = $category6;
 192         $category3  = self::getDataGenerator()->create_category();
 193         $generatedcats[$category3->id] = $category3;
 194         $category4  = self::getDataGenerator()->create_category(
 195                 array('parent' => $category3->id));
 196         $generatedcats[$category4->id] = $category4;
 197         $category5  = self::getDataGenerator()->create_category(
 198                 array('parent' => $category4->id));
 199         $generatedcats[$category5->id] = $category5;
 200
 201         // Set the required capabilities by the external function.
 202         $context = context_system::instance();
 203         $roleid = $this->assignUserCapability('moodle/category:manage', $context->id);
 204
 205         // Retrieve category1 + sub-categories except not visible ones
 206         $categories = core_course_external::get_categories(array(
 207             array('key' => 'id', 'value' => $category1->id),
 208             array('key' => 'visible', 'value' => 1)), 1);
 209
 210         // We need to execute the return values cleaning process to simulate the web service server.
 211         $categories = external_api::clean_returnvalue(core_course_external::get_categories_returns(), $categories);
 212
 213         // Check we retrieve the good total number of categories.
 214         $this->assertEquals(2, count($categories));
 215
 216         // Check the return values
 217         foreach ($categories as $category) {
 218             $generatedcat = $generatedcats[$category['id']];
 219             $this->assertEquals($category['idnumber'], $generatedcat->idnumber);
 220             $this->assertEquals($category['name'], $generatedcat->name);
 221             // Description was converted to the HTML format.
 222             $this->assertEquals($category['description'], format_text($generatedcat->description, FORMAT_MOODLE, array('para' => false)));
 223             $this->assertEquals($category['descriptionformat'], FORMAT_HTML);
 224         }
 225
 226         // Check categories by ids.
 227         $ids = implode(',', array_keys($generatedcats));
 228         $categories = core_course_external::get_categories(array(
 229             array('key' => 'ids', 'value' => $ids)), 0);
 230
 231         // We need to execute the return values cleaning process to simulate the web service server.
 232         $categories = external_api::clean_returnvalue(core_course_external::get_categories_returns(), $categories);
 233
 234         // Check we retrieve the good total number of categories.
 235         $this->assertEquals(6, count($categories));
 236         // Check ids.
 237         $returnedids = [];
 238         foreach ($categories as $category) {
 239             $returnedids[] = $category['id'];
 240         }
 241         // Sort the arrays upon comparision.
 242         $this->assertEquals(array_keys($generatedcats), $returnedids, '', 0.0, 10, true);
 243
 244         // Check different params.
 245         $categories = core_course_external::get_categories(array(
 246             array('key' => 'id', 'value' => $category1->id),
 247             array('key' => 'ids', 'value' => $category1->id),
 248             array('key' => 'idnumber', 'value' => $category1->idnumber),
 249             array('key' => 'visible', 'value' => 1)), 0);
 250
 251         // We need to execute the return values cleaning process to simulate the web service server.
 252         $categories = external_api::clean_returnvalue(core_course_external::get_categories_returns(), $categories);
 253
 254         $this->assertEquals(1, count($categories));
 255
 256         // Same query, but forcing a parameters clean.
 257         $categories = core_course_external::get_categories(array(
 258             array('key' => 'id', 'value' => "$category1->id"),
 259             array('key' => 'idnumber', 'value' => $category1->idnumber),
 260             array('key' => 'name', 'value' => $category1->name . "<br/>"),
 261             array('key' => 'visible', 'value' => '1')), 0);
 262         $categories = external_api::clean_returnvalue(core_course_external::get_categories_returns(), $categories);
 263
 264         $this->assertEquals(1, count($categories));
 265
 266         // Retrieve categories from parent.
 267         $categories = core_course_external::get_categories(array(
 268             array('key' => 'parent', 'value' => $category3->id)), 1);
 269         $categories = external_api::clean_returnvalue(core_course_external::get_categories_returns(), $categories);
 270
 271         $this->assertEquals(2, count($categories));
 272
 273         // Retrieve all categories.
 274         $categories = core_course_external::get_categories();
 275
 276         // We need to execute the return values cleaning process to simulate the web service server.
 277         $categories = external_api::clean_returnvalue(core_course_external::get_categories_returns(), $categories);
 278
 279         $this->assertEquals($DB->count_records('course_categories'), count($categories));
 280
 281         $this->unassignUserCapability('moodle/category:manage', $context->id, $roleid);
 282
 283         // Ensure maxdepthcategory is 2 and retrieve all categories without category:manage capability. It should retrieve all
 284         // visible categories as well.
 285         set_config('maxcategorydepth', 2);
 286         $categories = core_course_external::get_categories();
 287
 288         // We need to execute the return values cleaning process to simulate the web service server.
 289         $categories = external_api::clean_returnvalue(core_course_external::get_categories_returns(), $categories);
 290
 291         $this->assertEquals($DB->count_records('course_categories', array('visible' => 1)), count($categories));
 292
 293         // Call without required capability (it will fail cause of the search on idnumber).
 294         $this->expectException('moodle_exception');
 295         $categories = core_course_external::get_categories(array(
 296             array('key' => 'id', 'value' => $category1->id),
 297             array('key' => 'idnumber', 'value' => $category1->idnumber),
 298             array('key' => 'visible', 'value' => 1)), 0);
 299     }
 300
 301     /**
 302      * Test update_categories
 303      */
 304     public function test_update_categories() {
 305         global $DB;
 306
 307         $this->resetAfterTest(true);
 308
 309         // Set the required capabilities by the external function
 310         $contextid = context_system::instance()->id;
 311         $roleid = $this->assignUserCapability('moodle/category:manage', $contextid);
 312
 313         // Create base categories.
 314         $category1data['idnumber'] = 'idnumbercat1';
 315         $category1data['name'] = 'Category 1 for PHPunit test';
 316         $category1data['description'] = 'Category 1 description';
 317         $category1data['descriptionformat'] = FORMAT_MOODLE;
 318         $category1  = self::getDataGenerator()->create_category($category1data);
 319         $category2  = self::getDataGenerator()->create_category(
 320                 array('parent' => $category1->id));
 321         $category3  = self::getDataGenerator()->create_category();
 322         $category4  = self::getDataGenerator()->create_category(
 323                 array('parent' => $category3->id));
 324         $category5  = self::getDataGenerator()->create_category(
 325                 array('parent' => $category4->id));
 326
 327         // We update all category1 attribut.
 328         // Then we move cat4 and cat5 parent: cat3 => cat1
 329         $categories = array(
 330             array('id' => $category1->id,
 331                 'name' => $category1->name . '_updated',
 332                 'idnumber' => $category1->idnumber . '_updated',
 333                 'description' => $category1->description . '_updated',
 334                 'descriptionformat' => FORMAT_HTML,
 335                 'theme' => $category1->theme),
 336             array('id' => $category4->id, 'parent' => $category1->id));
 337
 338         core_course_external::update_categories($categories);
 339
 340         // Check the values were updated.
 341         $dbcategories = $DB->get_records_select('course_categories',
 342                 'id IN (' . $category1->id . ',' . $category2->id . ',' . $category2->id
 343                 . ',' . $category3->id . ',' . $category4->id . ',' . $category5->id .')');
 344         $this->assertEquals($category1->name . '_updated',
 345                 $dbcategories[$category1->id]->name);
 346         $this->assertEquals($category1->idnumber . '_updated',
 347                 $dbcategories[$category1->id]->idnumber);
 348         $this->assertEquals($category1->description . '_updated',
 349                 $dbcategories[$category1->id]->description);
 350         $this->assertEquals(FORMAT_HTML, $dbcategories[$category1->id]->descriptionformat);
 351
 352         // Check that category4 and category5 have been properly moved.
 353         $this->assertEquals('/' . $category1->id . '/' . $category4->id,
 354                 $dbcategories[$category4->id]->path);
 355         $this->assertEquals('/' . $category1->id . '/' . $category4->id . '/' . $category5->id,
 356                 $dbcategories[$category5->id]->path);
 357
 358         // Call without required capability.
 359         $this->unassignUserCapability('moodle/category:manage', $contextid, $roleid);
 360         $this->expectException('required_capability_exception');
 361         core_course_external::update_categories($categories);
 362     }
 363
 364     /**
 365      * Test create_courses numsections
 366      */
 367     public function test_create_course_numsections() {
 368         global $DB;
 369
 370         $this->resetAfterTest(true);
 371
 372         // Set the required capabilities by the external function.
 373         $contextid = context_system::instance()->id;
 374         $roleid = $this->assignUserCapability('moodle/course:create', $contextid);
 375         $this->assignUserCapability('moodle/course:visibility', $contextid, $roleid);
 376
 377         $numsections = 10;
 378         $category  = self::getDataGenerator()->create_category();
 379
 380         // Create base categories.
 381         $course1['fullname'] = 'Test course 1';
 382         $course1['shortname'] = 'Testcourse1';
 383         $course1['categoryid'] = $category->id;
 384         $course1['courseformatoptions'][] = array('name' => 'numsections', 'value' => $numsections);
 385
 386         $courses = array($course1);
 387
 388         $createdcourses = core_course_external::create_courses($courses);
 389         foreach ($createdcourses as $createdcourse) {
 390             $existingsections = $DB->get_records('course_sections', array('course' => $createdcourse['id']));
 391             $modinfo = get_fast_modinfo($createdcourse['id']);
 392             $sections = $modinfo->get_section_info_all();
 393             $this->assertEquals(count($sections), $numsections + 1); // Includes generic section.
 394             $this->assertEquals(count($existingsections), $numsections + 1); // Includes generic section.
 395         }
 396     }
 397
 398     /**
 399      * Test create_courses
 400      */
 401     public function test_create_courses() {
 402         global $DB;
 403
 404         $this->resetAfterTest(true);
 405
 406         // Enable course completion.
 407         set_config('enablecompletion', 1);
 408         // Enable course themes.
 409         set_config('allowcoursethemes', 1);
 410
 411         // Set the required capabilities by the external function
 412         $contextid = context_system::instance()->id;
 413         $roleid = $this->assignUserCapability('moodle/course:create', $contextid);
 414         $this->assignUserCapability('moodle/course:visibility', $contextid, $roleid);
 415         $this->assignUserCapability('moodle/course:setforcedlanguage', $contextid, $roleid);
 416
 417         $category  = self::getDataGenerator()->create_category();
 418
 419         // Create base categories.
 420         $course1['fullname'] = 'Test course 1';
 421         $course1['shortname'] = 'Testcourse1';
 422         $course1['categoryid'] = $category->id;
 423         $course2['fullname'] = 'Test course 2';
 424         $course2['shortname'] = 'Testcourse2';
 425         $course2['categoryid'] = $category->id;
 426         $course2['idnumber'] = 'testcourse2idnumber';
 427         $course2['summary'] = 'Description for course 2';
 428         $course2['summaryformat'] = FORMAT_MOODLE;
 429         $course2['format'] = 'weeks';
 430         $course2['showgrades'] = 1;
 431         $course2['newsitems'] = 3;
 432         $course2['startdate'] = 1420092000; // 01/01/2015.
 433         $course2['enddate'] = 1422669600; // 01/31/2015.
 434         $course2['numsections'] = 4;
 435         $course2['maxbytes'] = 100000;
 436         $course2['showreports'] = 1;
 437         $course2['visible'] = 0;
 438         $course2['hiddensections'] = 0;
 439         $course2['groupmode'] = 0;
 440         $course2['groupmodeforce'] = 0;
 441         $course2['defaultgroupingid'] = 0;
 442         $course2['enablecompletion'] = 1;
 443         $course2['completionnotify'] = 1;
 444         $course2['lang'] = 'en';
 445         $course2['forcetheme'] = 'bootstrapbase';
 446         $course2['courseformatoptions'][] = array('name' => 'automaticenddate', 'value' => 0);
 447         $course3['fullname'] = 'Test course 3';
 448         $course3['shortname'] = 'Testcourse3';
 449         $course3['categoryid'] = $category->id;
 450         $course3['format'] = 'topics';
 451         $course3options = array('numsections' => 8,
 452             'hiddensections' => 1,
 453             'coursedisplay' => 1);
 454         $course3['courseformatoptions'] = array();
 455         foreach ($course3options as $key => $value) {
 456             $course3['courseformatoptions'][] = array('name' => $key, 'value' => $value);
 457         }
 458         $courses = array($course1, $course2, $course3);
 459
 460         $createdcourses = core_course_external::create_courses($courses);
 461
 462         // We need to execute the return values cleaning process to simulate the web service server.
 463         $createdcourses = external_api::clean_returnvalue(core_course_external::create_courses_returns(), $createdcourses);
 464
 465         // Check that right number of courses were created.
 466         $this->assertEquals(3, count($createdcourses));
 467
 468         // Check that the courses were correctly created.
 469         foreach ($createdcourses as $createdcourse) {
 470             $courseinfo = course_get_format($createdcourse['id'])->get_course();
 471
 472             if ($createdcourse['shortname'] == $course2['shortname']) {
 473                 $this->assertEquals($courseinfo->fullname, $course2['fullname']);
 474                 $this->assertEquals($courseinfo->shortname, $course2['shortname']);
 475                 $this->assertEquals($courseinfo->category, $course2['categoryid']);
 476                 $this->assertEquals($courseinfo->idnumber, $course2['idnumber']);
 477                 $this->assertEquals($courseinfo->summary, $course2['summary']);
 478                 $this->assertEquals($courseinfo->summaryformat, $course2['summaryformat']);
 479                 $this->assertEquals($courseinfo->format, $course2['format']);
 480                 $this->assertEquals($courseinfo->showgrades, $course2['showgrades']);
 481                 $this->assertEquals($courseinfo->newsitems, $course2['newsitems']);
 482                 $this->assertEquals($courseinfo->startdate, $course2['startdate']);
 483                 $this->assertEquals($courseinfo->enddate, $course2['enddate']);
 484                 $this->assertEquals(course_get_format($createdcourse['id'])->get_last_section_number(), $course2['numsections']);
 485                 $this->assertEquals($courseinfo->maxbytes, $course2['maxbytes']);
 486                 $this->assertEquals($courseinfo->showreports, $course2['showreports']);
 487                 $this->assertEquals($courseinfo->visible, $course2['visible']);
 488                 $this->assertEquals($courseinfo->hiddensections, $course2['hiddensections']);
 489                 $this->assertEquals($courseinfo->groupmode, $course2['groupmode']);
 490                 $this->assertEquals($courseinfo->groupmodeforce, $course2['groupmodeforce']);
 491                 $this->assertEquals($courseinfo->defaultgroupingid, $course2['defaultgroupingid']);
 492                 $this->assertEquals($courseinfo->completionnotify, $course2['completionnotify']);
 493                 $this->assertEquals($courseinfo->lang, $course2['lang']);
 494                 $this->assertEquals($courseinfo->theme, $course2['forcetheme']);
 495
 496                 // We enabled completion at the beginning of the test.
 497                 $this->assertEquals($courseinfo->enablecompletion, $course2['enablecompletion']);
 498
 499             } else if ($createdcourse['shortname'] == $course1['shortname']) {
 500                 $courseconfig = get_config('moodlecourse');
 501                 $this->assertEquals($courseinfo->fullname, $course1['fullname']);
 502                 $this->assertEquals($courseinfo->shortname, $course1['shortname']);
 503                 $this->assertEquals($courseinfo->category, $course1['categoryid']);
 504                 $this->assertEquals($courseinfo->summaryformat, FORMAT_HTML);
 505                 $this->assertEquals($courseinfo->format, $courseconfig->format);
 506                 $this->assertEquals($courseinfo->showgrades, $courseconfig->showgrades);
 507                 $this->assertEquals($courseinfo->newsitems, $courseconfig->newsitems);
 508                 $this->assertEquals($courseinfo->maxbytes, $courseconfig->maxbytes);
 509                 $this->assertEquals($courseinfo->showreports, $courseconfig->showreports);
 510                 $this->assertEquals($courseinfo->groupmode, $courseconfig->groupmode);
 511                 $this->assertEquals($courseinfo->groupmodeforce, $courseconfig->groupmodeforce);
 512                 $this->assertEquals($courseinfo->defaultgroupingid, 0);
 513             } else if ($createdcourse['shortname'] == $course3['shortname']) {
 514                 $this->assertEquals($courseinfo->fullname, $course3['fullname']);
 515                 $this->assertEquals($courseinfo->shortname, $course3['shortname']);
 516                 $this->assertEquals($courseinfo->category, $course3['categoryid']);
 517                 $this->assertEquals($courseinfo->format, $course3['format']);
 518                 $this->assertEquals($courseinfo->hiddensections, $course3options['hiddensections']);
 519                 $this->assertEquals(course_get_format($createdcourse['id'])->get_last_section_number(),
 520                     $course3options['numsections']);
 521                 $this->assertEquals($courseinfo->coursedisplay, $course3options['coursedisplay']);
 522             } else {
 523                 throw new moodle_exception('Unexpected shortname');
 524             }
 525         }
 526
 527         // Call without required capability
 528         $this->unassignUserCapability('moodle/course:create', $contextid, $roleid);
 529         $this->expectException('required_capability_exception');
 530         $createdsubcats = core_course_external::create_courses($courses);
 531     }
 532
 533     /**
 534      * Test delete_courses
 535      */
 536     public function test_delete_courses() {
 537         global $DB, $USER;
 538
 539         $this->resetAfterTest(true);
 540
 541         // Admin can delete a course.
 542         $this->setAdminUser();
 543         // Validate_context() will fail as the email is not set by $this->setAdminUser().
 544         $USER->email = 'emailtopass@example.com';
 545
 546         $course1  = self::getDataGenerator()->create_course();
 547         $course2  = self::getDataGenerator()->create_course();
 548         $course3  = self::getDataGenerator()->create_course();
 549
 550         // Delete courses.
 551         $result = core_course_external::delete_courses(array($course1->id, $course2->id));
 552         $result = external_api::clean_returnvalue(core_course_external::delete_courses_returns(), $result);
 553         // Check for 0 warnings.
 554         $this->assertEquals(0, count($result['warnings']));
 555
 556         // Check $course 1 and 2 are deleted.
 557         $notdeletedcount = $DB->count_records_select('course',
 558             'id IN ( ' . $course1->id . ',' . $course2->id . ')');
 559         $this->assertEquals(0, $notdeletedcount);
 560
 561         // Try to delete non-existent course.
 562         $result = core_course_external::delete_courses(array($course1->id));
 563         $result = external_api::clean_returnvalue(core_course_external::delete_courses_returns(), $result);
 564         // Check for 1 warnings.
 565         $this->assertEquals(1, count($result['warnings']));
 566
 567         // Try to delete Frontpage course.
 568         $result = core_course_external::delete_courses(array(0));
 569         $result = external_api::clean_returnvalue(core_course_external::delete_courses_returns(), $result);
 570         // Check for 1 warnings.
 571         $this->assertEquals(1, count($result['warnings']));
 572
 573          // Fail when the user has access to course (enrolled) but does not have permission or is not admin.
 574         $student1 = self::getDataGenerator()->create_user();
 575         $studentrole = $DB->get_record('role', array('shortname' => 'student'));
 576         $this->getDataGenerator()->enrol_user($student1->id,
 577                                               $course3->id,
 578                                               $studentrole->id);
 579         $this->setUser($student1);
 580         $result = core_course_external::delete_courses(array($course3->id));
 581         $result = external_api::clean_returnvalue(core_course_external::delete_courses_returns(), $result);
 582         // Check for 1 warnings.
 583         $this->assertEquals(1, count($result['warnings']));
 584
 585          // Fail when the user is not allow to access the course (enrolled) or is not admin.
 586         $this->setGuestUser();
 587         $this->expectException('require_login_exception');
 588
 589         $result = core_course_external::delete_courses(array($course3->id));
 590         $result = external_api::clean_returnvalue(core_course_external::delete_courses_returns(), $result);
 591     }
 592
 593     /**
 594      * Test get_courses
 595      */
 596     public function test_get_courses () {
 597         global $DB;
 598
 599         $this->resetAfterTest(true);
 600
 601         $generatedcourses = array();
 602         $coursedata['idnumber'] = 'idnumbercourse1';
 603         // Adding tags here to check that format_string is applied.
 604         $coursedata['fullname'] = '<b>Course 1 for PHPunit test</b>';
 605         $coursedata['shortname'] = '<b>Course 1 for PHPunit test</b>';
 606         $coursedata['summary'] = 'Course 1 description';
 607         $coursedata['summaryformat'] = FORMAT_MOODLE;
 608         $course1  = self::getDataGenerator()->create_course($coursedata);
 609
 610         $generatedcourses[$course1->id] = $course1;
 611         $course2  = self::getDataGenerator()->create_course();
 612         $generatedcourses[$course2->id] = $course2;
 613         $course3  = self::getDataGenerator()->create_course(array('format' => 'topics'));
 614         $generatedcourses[$course3->id] = $course3;
 615
 616         // Set the required capabilities by the external function.
 617         $context = context_system::instance();
 618         $roleid = $this->assignUserCapability('moodle/course:view', $context->id);
 619         $this->assignUserCapability('moodle/course:update',
 620                 context_course::instance($course1->id)->id, $roleid);
 621         $this->assignUserCapability('moodle/course:update',
 622                 context_course::instance($course2->id)->id, $roleid);
 623         $this->assignUserCapability('moodle/course:update',
 624                 context_course::instance($course3->id)->id, $roleid);
 625
 626         $courses = core_course_external::get_courses(array('ids' =>
 627             array($course1->id, $course2->id)));
 628
 629         // We need to execute the return values cleaning process to simulate the web service server.
 630         $courses = external_api::clean_returnvalue(core_course_external::get_courses_returns(), $courses);
 631
 632         // Check we retrieve the good total number of categories.
 633         $this->assertEquals(2, count($courses));
 634
 635         foreach ($courses as $course) {
 636             $coursecontext = context_course::instance($course['id']);
 637             $dbcourse = $generatedcourses[$course['id']];
 638             $this->assertEquals($course['idnumber'], $dbcourse->idnumber);
 639             $this->assertEquals($course['fullname'], external_format_string($dbcourse->fullname, $coursecontext->id));
 640             $this->assertEquals($course['displayname'], external_format_string(get_course_display_name_for_list($dbcourse),
 641                 $coursecontext->id));
 642             // Summary was converted to the HTML format.
 643             $this->assertEquals($course['summary'], format_text($dbcourse->summary, FORMAT_MOODLE, array('para' => false)));
 644             $this->assertEquals($course['summaryformat'], FORMAT_HTML);
 645             $this->assertEquals($course['shortname'], external_format_string($dbcourse->shortname, $coursecontext->id));
 646             $this->assertEquals($course['categoryid'], $dbcourse->category);
 647             $this->assertEquals($course['format'], $dbcourse->format);
 648             $this->assertEquals($course['showgrades'], $dbcourse->showgrades);
 649             $this->assertEquals($course['newsitems'], $dbcourse->newsitems);
 650             $this->assertEquals($course['startdate'], $dbcourse->startdate);
 651             $this->assertEquals($course['enddate'], $dbcourse->enddate);
 652             $this->assertEquals($course['numsections'], course_get_format($dbcourse)->get_last_section_number());
 653             $this->assertEquals($course['maxbytes'], $dbcourse->maxbytes);
 654             $this->assertEquals($course['showreports'], $dbcourse->showreports);
 655             $this->assertEquals($course['visible'], $dbcourse->visible);
 656             $this->assertEquals($course['hiddensections'], $dbcourse->hiddensections);
 657             $this->assertEquals($course['groupmode'], $dbcourse->groupmode);
 658             $this->assertEquals($course['groupmodeforce'], $dbcourse->groupmodeforce);
 659             $this->assertEquals($course['defaultgroupingid'], $dbcourse->defaultgroupingid);
 660             $this->assertEquals($course['completionnotify'], $dbcourse->completionnotify);
 661             $this->assertEquals($course['lang'], $dbcourse->lang);
 662             $this->assertEquals($course['forcetheme'], $dbcourse->theme);
 663             $this->assertEquals($course['enablecompletion'], $dbcourse->enablecompletion);
 664             if ($dbcourse->format === 'topics') {
 665                 $this->assertEquals($course['courseformatoptions'], array(
 666                     array('name' => 'hiddensections', 'value' => $dbcourse->hiddensections),
 667                     array('name' => 'coursedisplay', 'value' => $dbcourse->coursedisplay),
 668                 ));
 669             }
 670         }
 671
 672         // Get all courses in the DB
 673         $courses = core_course_external::get_courses(array());
 674
 675         // We need to execute the return values cleaning process to simulate the web service server.
 676         $courses = external_api::clean_returnvalue(core_course_external::get_courses_returns(), $courses);
 677
 678         $this->assertEquals($DB->count_records('course'), count($courses));
 679     }
 680
 681     /**
 682      * Test get_courses without capability
 683      */
 684     public function test_get_courses_without_capability() {
 685         $this->resetAfterTest(true);
 686
 687         $course1 = $this->getDataGenerator()->create_course();
 688         $this->setUser($this->getDataGenerator()->create_user());
 689
 690         // No permissions are required to get the site course.
 691         $courses = core_course_external::get_courses(array('ids' => [SITEID]));
 692         $courses = external_api::clean_returnvalue(core_course_external::get_courses_returns(), $courses);
 693
 694         $this->assertEquals(1, count($courses));
 695         $this->assertEquals('PHPUnit test site', $courses[0]['fullname']);
 696         $this->assertEquals('site', $courses[0]['format']);
 697
 698         // Requesting course without being enrolled or capability to view it will throw an exception.
 699         try {
 700             core_course_external::get_courses(array('ids' => [$course1->id]));
 701             $this->fail('Exception expected');
 702         } catch (moodle_exception $e) {
 703             $this->assertEquals(1, preg_match('/Course or activity not accessible. \(Not enrolled\)/', $e->getMessage()));
 704         }
 705     }
 706
 707     /**
 708      * Test search_courses
 709      */
 710     public function test_search_courses () {
 711
 712         global $DB;
 713
 714         $this->resetAfterTest(true);
 715         $this->setAdminUser();
 716         $generatedcourses = array();
 717         $coursedata1['fullname'] = 'FIRST COURSE';
 718         $course1  = self::getDataGenerator()->create_course($coursedata1);
 719
 720         $page = new moodle_page();
 721         $page->set_course($course1);
 722         $page->blocks->add_blocks([BLOCK_POS_LEFT => ['news_items'], BLOCK_POS_RIGHT => []], 'course-view-*');
 723
 724         $coursedata2['fullname'] = 'SECOND COURSE';
 725         $course2  = self::getDataGenerator()->create_course($coursedata2);
 726
 727         $page = new moodle_page();
 728         $page->set_course($course2);
 729         $page->blocks->add_blocks([BLOCK_POS_LEFT => ['news_items'], BLOCK_POS_RIGHT => []], 'course-view-*');
 730         // Search by name.
 731         $results = core_course_external::search_courses('search', 'FIRST');
 732         $results = external_api::clean_returnvalue(core_course_external::search_courses_returns(), $results);
 733         $this->assertEquals($coursedata1['fullname'], $results['courses'][0]['fullname']);
 734         $this->assertCount(1, $results['courses']);
 735
 736         // Create the forum.
 737         $record = new stdClass();
 738         $record->introformat = FORMAT_HTML;
 739         $record->course = $course2->id;
 740         // Set Aggregate type = Average of ratings.
 741         $forum = self::getDataGenerator()->create_module('forum', $record);
 742
 743         // Search by module.
 744         $results = core_course_external::search_courses('modulelist', 'forum');
 745         $results = external_api::clean_returnvalue(core_course_external::search_courses_returns(), $results);
 746         $this->assertEquals(1, $results['total']);
 747
 748         // Enable coursetag option.
 749         set_config('block_tags_showcoursetags', true);
 750         // Add tag 'TAG-LABEL ON SECOND COURSE' to Course2.
 751         core_tag_tag::set_item_tags('core', 'course', $course2->id, context_course::instance($course2->id),
 752                 array('TAG-LABEL ON SECOND COURSE'));
 753         $taginstance = $DB->get_record('tag_instance',
 754                 array('itemtype' => 'course', 'itemid' => $course2->id), '*', MUST_EXIST);
 755         // Search by tagid.
 756         $results = core_course_external::search_courses('tagid', $taginstance->tagid);
 757         $results = external_api::clean_returnvalue(core_course_external::search_courses_returns(), $results);
 758         $this->assertEquals($coursedata2['fullname'], $results['courses'][0]['fullname']);
 759
 760         // Search by block (use news_items default block).
 761         $blockid = $DB->get_field('block', 'id', array('name' => 'news_items'));
 762         $results = core_course_external::search_courses('blocklist', $blockid);
 763         $results = external_api::clean_returnvalue(core_course_external::search_courses_returns(), $results);
 764         $this->assertEquals(2, $results['total']);
 765
 766         // Now as a normal user.
 767         $user = self::getDataGenerator()->create_user();
 768
 769         // Add a 3rd, hidden, course we shouldn't see, even when enrolled as student.
 770         $coursedata3['fullname'] = 'HIDDEN COURSE';
 771         $coursedata3['visible'] = 0;
 772         $course3  = self::getDataGenerator()->create_course($coursedata3);
 773         $this->getDataGenerator()->enrol_user($user->id, $course3->id, 'student');
 774
 775         $this->getDataGenerator()->enrol_user($user->id, $course2->id, 'student');
 776         $this->setUser($user);
 777
 778         $results = core_course_external::search_courses('search', 'FIRST');
 779         $results = external_api::clean_returnvalue(core_course_external::search_courses_returns(), $results);
 780         $this->assertCount(1, $results['courses']);
 781         $this->assertEquals(1, $results['total']);
 782         $this->assertEquals($coursedata1['fullname'], $results['courses'][0]['fullname']);
 783
 784         // Check that we can see both without the limit to enrolled setting.
 785         $results = core_course_external::search_courses('search', 'COURSE', 0, 0, array(), 0);
 786         $results = external_api::clean_returnvalue(core_course_external::search_courses_returns(), $results);
 787         $this->assertCount(2, $results['courses']);
 788         $this->assertEquals(2, $results['total']);
 789
 790         // Check that we only see our enrolled course when limiting.
 791         $results = core_course_external::search_courses('search', 'COURSE', 0, 0, array(), 1);
 792         $results = external_api::clean_returnvalue(core_course_external::search_courses_returns(), $results);
 793         $this->assertCount(1, $results['courses']);
 794         $this->assertEquals(1, $results['total']);
 795         $this->assertEquals($coursedata2['fullname'], $results['courses'][0]['fullname']);
 796
 797         // Search by block (use news_items default block). Should fail (only admins allowed).
 798         $this->expectException('required_capability_exception');
 799         $results = core_course_external::search_courses('blocklist', $blockid);
 800
 801     }
 802
 803     /**
 804      * Create a course with contents
 805      * @return array A list with the course object and course modules objects
 806      */
 807     private function prepare_get_course_contents_test() {
 808         global $DB;
 809         $course  = self::getDataGenerator()->create_course(['numsections' => 3]);
 810         $forumdescription = 'This is the forum description';
 811         $forum = $this->getDataGenerator()->create_module('forum',
 812             array('course' => $course->id, 'intro' => $forumdescription),
 813             array('showdescription' => true));
 814         $forumcm = get_coursemodule_from_id('forum', $forum->cmid);
 815         $data = $this->getDataGenerator()->create_module('data', array('assessed' => 1, 'scale' => 100, 'course' => $course->id));
 816         $datacm = get_coursemodule_from_instance('page', $data->id);
 817         $page = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
 818         $pagecm = get_coursemodule_from_instance('page', $page->id);
 819         $labeldescription = 'This is a very long label to test if more than 50 characters are returned.
 820                 So bla bla bla bla <b>bold bold bold</b> bla bla bla bla.';
 821         $label = $this->getDataGenerator()->create_module('label', array('course' => $course->id,
 822             'intro' => $labeldescription));
 823         $labelcm = get_coursemodule_from_instance('label', $label->id);
 824         $tomorrow = time() + DAYSECS;
 825         // Module with availability restrictions not met.
 826         $url = $this->getDataGenerator()->create_module('url',
 827             array('course' => $course->id, 'name' => 'URL: % & $ ../', 'section' => 2),
 828             array('availability' => '{"op":"&","c":[{"type":"date","d":">=","t":' . $tomorrow . '}],"showc":[true]}'));
 829         $urlcm = get_coursemodule_from_instance('url', $url->id);
 830         // Module for the last section.
 831         $this->getDataGenerator()->create_module('url',
 832             array('course' => $course->id, 'name' => 'URL for last section', 'section' => 3));
 833         // Module for section 1 with availability restrictions met.
 834         $yesterday = time() - DAYSECS;
 835         $this->getDataGenerator()->create_module('url',
 836             array('course' => $course->id, 'name' => 'URL restrictions met', 'section' => 1),
 837             array('availability' => '{"op":"&","c":[{"type":"date","d":">=","t":'. $yesterday .'}],"showc":[true]}'));
 838
 839         // Set the required capabilities by the external function.
 840         $context = context_course::instance($course->id);
 841         $roleid = $this->assignUserCapability('moodle/course:view', $context->id);
 842         $this->assignUserCapability('moodle/course:update', $context->id, $roleid);
 843         $this->assignUserCapability('mod/data:view', $context->id, $roleid);
 844
 845         $conditions = array('course' => $course->id, 'section' => 2);
 846         $DB->set_field('course_sections', 'summary', 'Text with iframe <iframe src="https://moodle.org"></iframe>', $conditions);
 847
 848         // Add date availability condition not met for last section.
 849         $availability = '{"op":"&","c":[{"type":"date","d":">=","t":' . $tomorrow . '}],"showc":[true]}';
 850         $DB->set_field('course_sections', 'availability', $availability,
 851                 array('course' => $course->id, 'section' => 3));
 852         rebuild_course_cache($course->id, true);
 853
 854         return array($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm);
 855     }
 856
 857     /**
 858      * Test get_course_contents
 859      */
 860     public function test_get_course_contents() {
 861         global $CFG;
 862         $this->resetAfterTest(true);
 863         $CFG->forceclean = 0;
 864
 865         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
 866
 867         $sections = core_course_external::get_course_contents($course->id, array());
 868         // We need to execute the return values cleaning process to simulate the web service server.
 869         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
 870
 871         $modinfo = get_fast_modinfo($course);
 872         $testexecuted = 0;
 873         foreach ($sections[0]['modules'] as $module) {
 874             if ($module['id'] == $forumcm->id and $module['modname'] == 'forum') {
 875                 $cm = $modinfo->cms[$forumcm->id];
 876                 $formattedtext = format_text($cm->content, FORMAT_HTML,
 877                     array('noclean' => true, 'para' => false, 'filter' => false));
 878                 $this->assertEquals($formattedtext, $module['description']);
 879                 $this->assertEquals($forumcm->instance, $module['instance']);
 880                 $testexecuted = $testexecuted + 1;
 881             } else if ($module['id'] == $labelcm->id and $module['modname'] == 'label') {
 882                 $cm = $modinfo->cms[$labelcm->id];
 883                 $formattedtext = format_text($cm->content, FORMAT_HTML,
 884                     array('noclean' => true, 'para' => false, 'filter' => false));
 885                 $this->assertEquals($formattedtext, $module['description']);
 886                 $this->assertEquals($labelcm->instance, $module['instance']);
 887                 $testexecuted = $testexecuted + 1;
 888             }
 889         }
 890         $this->assertEquals(2, $testexecuted);
 891         $this->assertEquals(0, $sections[0]['section']);
 892
 893         // Check that the only return section has the 5 created modules.
 894         $this->assertCount(4, $sections[0]['modules']);
 895         $this->assertCount(1, $sections[1]['modules']);
 896         $this->assertCount(1, $sections[2]['modules']);
 897         $this->assertCount(0, $sections[3]['modules']); // No modules for the section with availability restrictions.
 898         $this->assertNotEmpty($sections[3]['availabilityinfo']);
 899         $this->assertEquals(1, $sections[1]['section']);
 900         $this->assertEquals(2, $sections[2]['section']);
 901         $this->assertEquals(3, $sections[3]['section']);
 902         $this->assertContains('<iframe', $sections[2]['summary']);
 903         $this->assertContains('</iframe>', $sections[2]['summary']);
 904         // The module with the availability restriction met is returning contents.
 905         $this->assertNotEmpty($sections[1]['modules'][0]['contents']);
 906         // The module with the availability restriction not met is not returning contents.
 907         $this->assertArrayNotHasKey('contents', $sections[2]['modules'][0]);
 908         $this->assertNotEmpty($sections[2]['modules'][0]['availabilityinfo']);
 909         try {
 910             $sections = core_course_external::get_course_contents($course->id,
 911                                                                     array(array("name" => "invalid", "value" => 1)));
 912             $this->fail('Exception expected due to invalid option.');
 913         } catch (moodle_exception $e) {
 914             $this->assertEquals('errorinvalidparam', $e->errorcode);
 915         }
 916     }
 917
 918
 919     /**
 920      * Test get_course_contents excluding modules
 921      */
 922     public function test_get_course_contents_excluding_modules() {
 923         $this->resetAfterTest(true);
 924
 925         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
 926
 927         // Test exclude modules.
 928         $sections = core_course_external::get_course_contents($course->id, array(array("name" => "excludemodules", "value" => 1)));
 929
 930         // We need to execute the return values cleaning process to simulate the web service server.
 931         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
 932
 933         $this->assertEmpty($sections[0]['modules']);
 934         $this->assertEmpty($sections[1]['modules']);
 935     }
 936
 937     /**
 938      * Test get_course_contents excluding contents
 939      */
 940     public function test_get_course_contents_excluding_contents() {
 941         $this->resetAfterTest(true);
 942
 943         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
 944
 945         // Test exclude modules.
 946         $sections = core_course_external::get_course_contents($course->id, array(array("name" => "excludecontents", "value" => 1)));
 947
 948         // We need to execute the return values cleaning process to simulate the web service server.
 949         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
 950
 951         foreach ($sections as $section) {
 952             foreach ($section['modules'] as $module) {
 953                 // Only resources return contents.
 954                 if (isset($module['contents'])) {
 955                     $this->assertEmpty($module['contents']);
 956                 }
 957             }
 958         }
 959     }
 960
 961     /**
 962      * Test get_course_contents filtering by section number
 963      */
 964     public function test_get_course_contents_section_number() {
 965         $this->resetAfterTest(true);
 966
 967         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
 968
 969         // Test exclude modules.
 970         $sections = core_course_external::get_course_contents($course->id, array(array("name" => "sectionnumber", "value" => 0)));
 971
 972         // We need to execute the return values cleaning process to simulate the web service server.
 973         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
 974
 975         $this->assertCount(1, $sections);
 976         $this->assertCount(4, $sections[0]['modules']);
 977     }
 978
 979     /**
 980      * Test get_course_contents filtering by cmid
 981      */
 982     public function test_get_course_contents_cmid() {
 983         $this->resetAfterTest(true);
 984
 985         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
 986
 987         // Test exclude modules.
 988         $sections = core_course_external::get_course_contents($course->id, array(array("name" => "cmid", "value" => $forumcm->id)));
 989
 990         // We need to execute the return values cleaning process to simulate the web service server.
 991         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
 992
 993         $this->assertCount(4, $sections);
 994         $this->assertCount(1, $sections[0]['modules']);
 995         $this->assertEquals($forumcm->id, $sections[0]['modules'][0]["id"]);
 996     }
 997
 998
 999     /**
1000      * Test get_course_contents filtering by cmid and section
1001      */
1002     public function test_get_course_contents_section_cmid() {
1003         $this->resetAfterTest(true);
1004
1005         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
1006
1007         // Test exclude modules.
1008         $sections = core_course_external::get_course_contents($course->id, array(
1009                                                                         array("name" => "cmid", "value" => $forumcm->id),
1010                                                                         array("name" => "sectionnumber", "value" => 0)
1011                                                                         ));
1012
1013         // We need to execute the return values cleaning process to simulate the web service server.
1014         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
1015
1016         $this->assertCount(1, $sections);
1017         $this->assertCount(1, $sections[0]['modules']);
1018         $this->assertEquals($forumcm->id, $sections[0]['modules'][0]["id"]);
1019     }
1020
1021     /**
1022      * Test get_course_contents filtering by modname
1023      */
1024     public function test_get_course_contents_modname() {
1025         $this->resetAfterTest(true);
1026
1027         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
1028
1029         // Test exclude modules.
1030         $sections = core_course_external::get_course_contents($course->id, array(array("name" => "modname", "value" => "forum")));
1031
1032         // We need to execute the return values cleaning process to simulate the web service server.
1033         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
1034
1035         $this->assertCount(4, $sections);
1036         $this->assertCount(1, $sections[0]['modules']);
1037         $this->assertEquals($forumcm->id, $sections[0]['modules'][0]["id"]);
1038     }
1039
1040     /**
1041      * Test get_course_contents filtering by modname
1042      */
1043     public function test_get_course_contents_modid() {
1044         $this->resetAfterTest(true);
1045
1046         list($course, $forumcm, $datacm, $pagecm, $labelcm, $urlcm) = $this->prepare_get_course_contents_test();
1047
1048         // Test exclude modules.
1049         $sections = core_course_external::get_course_contents($course->id, array(
1050                                                                             array("name" => "modname", "value" => "page"),
1051                                                                             array("name" => "modid", "value" => $pagecm->instance),
1052                                                                             ));
1053
1054         // We need to execute the return values cleaning process to simulate the web service server.
1055         $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections);
1056
1057         $this->assertCount(4, $sections);
1058         $this->assertCount(1, $sections[0]['modules']);
1059         $this->assertEquals("page", $sections[0]['modules'][0]["modname"]);
1060         $this->assertEquals($pagecm->instance, $sections[0]['modules'][0]["instance"]);
1061     }
1062
1063     /**
1064      * Test duplicate_course
1065      */
1066     public function test_duplicate_course() {
1067         $this->resetAfterTest(true);
1068
1069         // Create one course with three modules.
1070         $course  = self::getDataGenerator()->create_course();
1071         $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id));
1072         $forumcm = get_coursemodule_from_id('forum', $forum->cmid);
1073         $forumcontext = context_module::instance($forum->cmid);
1074         $data = $this->getDataGenerator()->create_module('data', array('assessed'=>1, 'scale'=>100, 'course'=>$course->id));
1075         $datacontext = context_module::instance($data->cmid);
1076         $datacm = get_coursemodule_from_instance('page', $data->id);
1077         $page = $this->getDataGenerator()->create_module('page', array('course'=>$course->id));
1078         $pagecontext = context_module::instance($page->cmid);
1079         $pagecm = get_coursemodule_from_instance('page', $page->id);
1080
1081         // Set the required capabilities by the external function.
1082         $coursecontext = context_course::instance($course->id);
1083         $categorycontext = context_coursecat::instance($course->category);
1084         $roleid = $this->assignUserCapability('moodle/course:create', $categorycontext->id);
1085         $this->assignUserCapability('moodle/course:view', $categorycontext->id, $roleid);
1086         $this->assignUserCapability('moodle/restore:restorecourse', $categorycontext->id, $roleid);
1087         $this->assignUserCapability('moodle/backup:backupcourse', $coursecontext->id, $roleid);
1088         $this->assignUserCapability('moodle/backup:configure', $coursecontext->id, $roleid);
1089         // Optional capabilities to copy user data.
1090         $this->assignUserCapability('moodle/backup:userinfo', $coursecontext->id, $roleid);
1091         $this->assignUserCapability('moodle/restore:userinfo', $categorycontext->id, $roleid);
1092
1093         $newcourse['fullname'] = 'Course duplicate';
1094         $newcourse['shortname'] = 'courseduplicate';
1095         $newcourse['categoryid'] = $course->category;
1096         $newcourse['visible'] = true;
1097         $newcourse['options'][] = array('name' => 'users', 'value' => true);
1098
1099         $duplicate = core_course_external::duplicate_course($course->id, $newcourse['fullname'],
1100                 $newcourse['shortname'], $newcourse['categoryid'], $newcourse['visible'], $newcourse['options']);
1101
1102         // We need to execute the return values cleaning process to simulate the web service server.
1103         $duplicate = external_api::clean_returnvalue(core_course_external::duplicate_course_returns(), $duplicate);
1104
1105         // Check that the course has been duplicated.
1106         $this->assertEquals($newcourse['shortname'], $duplicate['shortname']);
1107     }
1108
1109     /**
1110      * Test update_courses
1111      */
1112     public function test_update_courses() {
1113         global $DB, $CFG, $USER, $COURSE;
1114
1115         // Get current $COURSE to be able to restore it later (defaults to $SITE). We need this
1116         // trick because we are both updating and getting (for testing) course information
1117         // in the same request and core_course_external::update_courses()
1118         // is overwriting $COURSE all over the time with OLD values, so later
1119         // use of get_course() fetches those OLD values instead of the updated ones.
1120         // See MDL-39723 for more info.
1121         $origcourse = clone($COURSE);
1122
1123         $this->resetAfterTest(true);
1124
1125         // Set the required capabilities by the external function.
1126         $contextid = context_system::instance()->id;
1127         $roleid = $this->assignUserCapability('moodle/course:update', $contextid);
1128         $this->assignUserCapability('moodle/course:changecategory', $contextid, $roleid);
1129         $this->assignUserCapability('moodle/course:changefullname', $contextid, $roleid);
1130         $this->assignUserCapability('moodle/course:changeshortname', $contextid, $roleid);
1131         $this->assignUserCapability('moodle/course:changeidnumber', $contextid, $roleid);
1132         $this->assignUserCapability('moodle/course:changesummary', $contextid, $roleid);
1133         $this->assignUserCapability('moodle/course:visibility', $contextid, $roleid);
1134         $this->assignUserCapability('moodle/course:viewhiddencourses', $contextid, $roleid);
1135         $this->assignUserCapability('moodle/course:setforcedlanguage', $contextid, $roleid);
1136
1137         // Create category and course.
1138         $category1  = self::getDataGenerator()->create_category();
1139         $category2  = self::getDataGenerator()->create_category();
1140         $originalcourse1 = self::getDataGenerator()->create_course();
1141         self::getDataGenerator()->enrol_user($USER->id, $originalcourse1->id, $roleid);
1142         $originalcourse2 = self::getDataGenerator()->create_course();
1143         self::getDataGenerator()->enrol_user($USER->id, $originalcourse2->id, $roleid);
1144
1145         // Course values to be updated.
1146         $course1['id'] = $originalcourse1->id;
1147         $course1['fullname'] = 'Updated test course 1';
1148         $course1['shortname'] = 'Udestedtestcourse1';
1149         $course1['categoryid'] = $category1->id;
1150         $course2['id'] = $originalcourse2->id;
1151         $course2['fullname'] = 'Updated test course 2';
1152         $course2['shortname'] = 'Updestedtestcourse2';
1153         $course2['categoryid'] = $category2->id;
1154         $course2['idnumber'] = 'Updatedidnumber2';
1155         $course2['summary'] = 'Updaated description for course 2';
1156         $course2['summaryformat'] = FORMAT_HTML;
1157         $course2['format'] = 'topics';
1158         $course2['showgrades'] = 1;
1159         $course2['newsitems'] = 3;
1160         $course2['startdate'] = 1420092000; // 01/01/2015.
1161         $course2['enddate'] = 1422669600; // 01/31/2015.
1162         $course2['maxbytes'] = 100000;
1163         $course2['showreports'] = 1;
1164         $course2['visible'] = 0;
1165         $course2['hiddensections'] = 0;
1166         $course2['groupmode'] = 0;
1167         $course2['groupmodeforce'] = 0;
1168         $course2['defaultgroupingid'] = 0;
1169         $course2['enablecompletion'] = 1;
1170         $course2['lang'] = 'en';
1171         $course2['forcetheme'] = 'bootstrapbase';
1172         $courses = array($course1, $course2);
1173
1174         $updatedcoursewarnings = core_course_external::update_courses($courses);
1175         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1176                                                                     $updatedcoursewarnings);
1177         $COURSE = $origcourse; // Restore $COURSE. Instead of using the OLD one set by the previous line.
1178
1179         // Check that right number of courses were created.
1180         $this->assertEquals(0, count($updatedcoursewarnings['warnings']));
1181
1182         // Check that the courses were correctly created.
1183         foreach ($courses as $course) {
1184             $courseinfo = course_get_format($course['id'])->get_course();
1185             if ($course['id'] == $course2['id']) {
1186                 $this->assertEquals($course2['fullname'], $courseinfo->fullname);
1187                 $this->assertEquals($course2['shortname'], $courseinfo->shortname);
1188                 $this->assertEquals($course2['categoryid'], $courseinfo->category);
1189                 $this->assertEquals($course2['idnumber'], $courseinfo->idnumber);
1190                 $this->assertEquals($course2['summary'], $courseinfo->summary);
1191                 $this->assertEquals($course2['summaryformat'], $courseinfo->summaryformat);
1192                 $this->assertEquals($course2['format'], $courseinfo->format);
1193                 $this->assertEquals($course2['showgrades'], $courseinfo->showgrades);
1194                 $this->assertEquals($course2['newsitems'], $courseinfo->newsitems);
1195                 $this->assertEquals($course2['startdate'], $courseinfo->startdate);
1196                 $this->assertEquals($course2['enddate'], $courseinfo->enddate);
1197                 $this->assertEquals($course2['maxbytes'], $courseinfo->maxbytes);
1198                 $this->assertEquals($course2['showreports'], $courseinfo->showreports);
1199                 $this->assertEquals($course2['visible'], $courseinfo->visible);
1200                 $this->assertEquals($course2['hiddensections'], $courseinfo->hiddensections);
1201                 $this->assertEquals($course2['groupmode'], $courseinfo->groupmode);
1202                 $this->assertEquals($course2['groupmodeforce'], $courseinfo->groupmodeforce);
1203                 $this->assertEquals($course2['defaultgroupingid'], $courseinfo->defaultgroupingid);
1204                 $this->assertEquals($course2['lang'], $courseinfo->lang);
1205
1206                 if (!empty($CFG->allowcoursethemes)) {
1207                     $this->assertEquals($course2['forcetheme'], $courseinfo->theme);
1208                 }
1209
1210                 $this->assertEquals($course2['enablecompletion'], $courseinfo->enablecompletion);
1211             } else if ($course['id'] == $course1['id']) {
1212                 $this->assertEquals($course1['fullname'], $courseinfo->fullname);
1213                 $this->assertEquals($course1['shortname'], $courseinfo->shortname);
1214                 $this->assertEquals($course1['categoryid'], $courseinfo->category);
1215                 $this->assertEquals(FORMAT_MOODLE, $courseinfo->summaryformat);
1216                 $this->assertEquals('topics', $courseinfo->format);
1217                 $this->assertEquals(5, course_get_format($course['id'])->get_last_section_number());
1218                 $this->assertEquals(0, $courseinfo->newsitems);
1219                 $this->assertEquals(FORMAT_MOODLE, $courseinfo->summaryformat);
1220             } else {
1221                 throw new moodle_exception('Unexpected shortname');
1222             }
1223         }
1224
1225         $courses = array($course1);
1226         // Try update course without update capability.
1227         $user = self::getDataGenerator()->create_user();
1228         $this->setUser($user);
1229         $this->unassignUserCapability('moodle/course:update', $contextid, $roleid);
1230         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1231         $updatedcoursewarnings = core_course_external::update_courses($courses);
1232         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1233                                                                     $updatedcoursewarnings);
1234         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1235
1236         // Try update course category without capability.
1237         $this->assignUserCapability('moodle/course:update', $contextid, $roleid);
1238         $this->unassignUserCapability('moodle/course:changecategory', $contextid, $roleid);
1239         $user = self::getDataGenerator()->create_user();
1240         $this->setUser($user);
1241         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1242         $course1['categoryid'] = $category2->id;
1243         $courses = array($course1);
1244         $updatedcoursewarnings = core_course_external::update_courses($courses);
1245         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1246                                                                     $updatedcoursewarnings);
1247         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1248
1249         // Try update course fullname without capability.
1250         $this->assignUserCapability('moodle/course:changecategory', $contextid, $roleid);
1251         $this->unassignUserCapability('moodle/course:changefullname', $contextid, $roleid);
1252         $user = self::getDataGenerator()->create_user();
1253         $this->setUser($user);
1254         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1255         $updatedcoursewarnings = core_course_external::update_courses($courses);
1256         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1257                                                                     $updatedcoursewarnings);
1258         $this->assertEquals(0, count($updatedcoursewarnings['warnings']));
1259         $course1['fullname'] = 'Testing fullname without permission';
1260         $courses = array($course1);
1261         $updatedcoursewarnings = core_course_external::update_courses($courses);
1262         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1263                                                                     $updatedcoursewarnings);
1264         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1265
1266         // Try update course shortname without capability.
1267         $this->assignUserCapability('moodle/course:changefullname', $contextid, $roleid);
1268         $this->unassignUserCapability('moodle/course:changeshortname', $contextid, $roleid);
1269         $user = self::getDataGenerator()->create_user();
1270         $this->setUser($user);
1271         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1272         $updatedcoursewarnings = core_course_external::update_courses($courses);
1273         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1274                                                                     $updatedcoursewarnings);
1275         $this->assertEquals(0, count($updatedcoursewarnings['warnings']));
1276         $course1['shortname'] = 'Testing shortname without permission';
1277         $courses = array($course1);
1278         $updatedcoursewarnings = core_course_external::update_courses($courses);
1279         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1280                                                                     $updatedcoursewarnings);
1281         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1282
1283         // Try update course idnumber without capability.
1284         $this->assignUserCapability('moodle/course:changeshortname', $contextid, $roleid);
1285         $this->unassignUserCapability('moodle/course:changeidnumber', $contextid, $roleid);
1286         $user = self::getDataGenerator()->create_user();
1287         $this->setUser($user);
1288         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1289         $updatedcoursewarnings = core_course_external::update_courses($courses);
1290         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1291                                                                     $updatedcoursewarnings);
1292         $this->assertEquals(0, count($updatedcoursewarnings['warnings']));
1293         $course1['idnumber'] = 'NEWIDNUMBER';
1294         $courses = array($course1);
1295         $updatedcoursewarnings = core_course_external::update_courses($courses);
1296         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1297                                                                     $updatedcoursewarnings);
1298         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1299
1300         // Try update course summary without capability.
1301         $this->assignUserCapability('moodle/course:changeidnumber', $contextid, $roleid);
1302         $this->unassignUserCapability('moodle/course:changesummary', $contextid, $roleid);
1303         $user = self::getDataGenerator()->create_user();
1304         $this->setUser($user);
1305         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1306         $updatedcoursewarnings = core_course_external::update_courses($courses);
1307         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1308                                                                     $updatedcoursewarnings);
1309         $this->assertEquals(0, count($updatedcoursewarnings['warnings']));
1310         $course1['summary'] = 'New summary';
1311         $courses = array($course1);
1312         $updatedcoursewarnings = core_course_external::update_courses($courses);
1313         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1314                                                                     $updatedcoursewarnings);
1315         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1316
1317         // Try update course with invalid summary format.
1318         $this->assignUserCapability('moodle/course:changesummary', $contextid, $roleid);
1319         $user = self::getDataGenerator()->create_user();
1320         $this->setUser($user);
1321         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1322         $updatedcoursewarnings = core_course_external::update_courses($courses);
1323         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1324                                                                     $updatedcoursewarnings);
1325         $this->assertEquals(0, count($updatedcoursewarnings['warnings']));
1326         $course1['summaryformat'] = 10;
1327         $courses = array($course1);
1328         $updatedcoursewarnings = core_course_external::update_courses($courses);
1329         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1330                                                                     $updatedcoursewarnings);
1331         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1332
1333         // Try update course visibility without capability.
1334         $this->unassignUserCapability('moodle/course:visibility', $contextid, $roleid);
1335         $user = self::getDataGenerator()->create_user();
1336         $this->setUser($user);
1337         self::getDataGenerator()->enrol_user($user->id, $course1['id'], $roleid);
1338         $course1['summaryformat'] = FORMAT_MOODLE;
1339         $courses = array($course1);
1340         $updatedcoursewarnings = core_course_external::update_courses($courses);
1341         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1342                                                                     $updatedcoursewarnings);
1343         $this->assertEquals(0, count($updatedcoursewarnings['warnings']));
1344         $course1['visible'] = 0;
1345         $courses = array($course1);
1346         $updatedcoursewarnings = core_course_external::update_courses($courses);
1347         $updatedcoursewarnings = external_api::clean_returnvalue(core_course_external::update_courses_returns(),
1348                                                                     $updatedcoursewarnings);
1349         $this->assertEquals(1, count($updatedcoursewarnings['warnings']));
1350     }
1351
1352     /**
1353      * Test delete course_module.
1354      */
1355     public function test_delete_modules() {
1356         global $DB;
1357
1358         // Ensure we reset the data after this test.
1359         $this->resetAfterTest(true);
1360
1361         // Create a user.
1362         $user = self::getDataGenerator()->create_user();
1363
1364         // Set the tests to run as the user.
1365         self::setUser($user);
1366
1367         // Create a course to add the modules.
1368         $course = self::getDataGenerator()->create_course();
1369
1370         // Create two test modules.
1371         $record = new stdClass();
1372         $record->course = $course->id;
1373         $module1 = self::getDataGenerator()->create_module('forum', $record);
1374         $module2 = self::getDataGenerator()->create_module('assign', $record);
1375
1376         // Check the forum was correctly created.
1377         $this->assertEquals(1, $DB->count_records('forum', array('id' => $module1->id)));
1378
1379         // Check the assignment was correctly created.
1380         $this->assertEquals(1, $DB->count_records('assign', array('id' => $module2->id)));
1381
1382         // Check data exists in the course modules table.
1383         $this->assertEquals(2, $DB->count_records_select('course_modules', 'id = :module1 OR id = :module2',
1384                 array('module1' => $module1->cmid, 'module2' => $module2->cmid)));
1385
1386         // Enrol the user in the course.
1387         $enrol = enrol_get_plugin('manual');
1388         $enrolinstances = enrol_get_instances($course->id, true);
1389         foreach ($enrolinstances as $courseenrolinstance) {
1390             if ($courseenrolinstance->enrol == "manual") {
1391                 $instance = $courseenrolinstance;
1392                 break;
1393             }
1394         }
1395         $enrol->enrol_user($instance, $user->id);
1396
1397         // Assign capabilities to delete module 1.
1398         $modcontext = context_module::instance($module1->cmid);
1399         $this->assignUserCapability('moodle/course:manageactivities', $modcontext->id);
1400
1401         // Assign capabilities to delete module 2.
1402         $modcontext = context_module::instance($module2->cmid);
1403         $newrole = create_role('Role 2', 'role2', 'Role 2 description');
1404         $this->assignUserCapability('moodle/course:manageactivities', $modcontext->id, $newrole);
1405
1406         // Deleting these module instances.
1407         core_course_external::delete_modules(array($module1->cmid, $module2->cmid));
1408
1409         // Check the forum was deleted.
1410         $this->assertEquals(0, $DB->count_records('forum', array('id' => $module1->id)));
1411
1412         // Check the assignment was deleted.
1413         $this->assertEquals(0, $DB->count_records('assign', array('id' => $module2->id)));
1414
1415         // Check we retrieve no data in the course modules table.
1416         $this->assertEquals(0, $DB->count_records_select('course_modules', 'id = :module1 OR id = :module2',
1417                 array('module1' => $module1->cmid, 'module2' => $module2->cmid)));
1418
1419         // Call with non-existent course module id and ensure exception thrown.
1420         try {
1421             core_course_external::delete_modules(array('1337'));
1422             $this->fail('Exception expected due to missing course module.');
1423         } catch (dml_missing_record_exception $e) {
1424             $this->assertEquals('invalidcoursemodule', $e->errorcode);
1425         }
1426
1427         // Create two modules.
1428         $module1 = self::getDataGenerator()->create_module('forum', $record);
1429         $module2 = self::getDataGenerator()->create_module('assign', $record);
1430
1431         // Since these modules were recreated the user will not have capabilities
1432         // to delete them, ensure exception is thrown if they try.
1433         try {
1434             core_course_external::delete_modules(array($module1->cmid, $module2->cmid));
1435             $this->fail('Exception expected due to missing capability.');
1436         } catch (moodle_exception $e) {
1437             $this->assertEquals('nopermissions', $e->errorcode);
1438         }
1439
1440         // Unenrol user from the course.
1441         $enrol->unenrol_user($instance, $user->id);
1442
1443         // Try and delete modules from the course the user was unenrolled in, make sure exception thrown.
1444         try {
1445             core_course_external::delete_modules(array($module1->cmid, $module2->cmid));
1446             $this->fail('Exception expected due to being unenrolled from the course.');
1447         } catch (moodle_exception $e) {
1448             $this->assertEquals('requireloginerror', $e->errorcode);
1449         }
1450     }
1451
1452     /**
1453      * Test import_course into an empty course
1454      */
1455     public function test_import_course_empty() {
1456         global $USER;
1457
1458         $this->resetAfterTest(true);
1459
1460         $course1  = self::getDataGenerator()->create_course();
1461         $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course1->id, 'name' => 'Forum test'));
1462         $page = $this->getDataGenerator()->create_module('page', array('course' => $course1->id, 'name' => 'Page test'));
1463
1464         $course2  = self::getDataGenerator()->create_course();
1465
1466         $course1cms = get_fast_modinfo($course1->id)->get_cms();
1467         $course2cms = get_fast_modinfo($course2->id)->get_cms();
1468
1469         // Verify the state of the courses before we do the import.
1470         $this->assertCount(2, $course1cms);
1471         $this->assertEmpty($course2cms);
1472
1473         // Setup the user to run the operation (ugly hack because validate_context() will
1474         // fail as the email is not set by $this->setAdminUser()).
1475         $this->setAdminUser();
1476         $USER->email = 'emailtopass@example.com';
1477
1478         // Import from course1 to course2.
1479         core_course_external::import_course($course1->id, $course2->id, 0);
1480
1481         // Verify that now we have two modules in both courses.
1482         $course1cms = get_fast_modinfo($course1->id)->get_cms();
1483         $course2cms = get_fast_modinfo($course2->id)->get_cms();
1484         $this->assertCount(2, $course1cms);
1485         $this->assertCount(2, $course2cms);
1486
1487         // Verify that the names transfered across correctly.
1488         foreach ($course2cms as $cm) {
1489             if ($cm->modname === 'page') {
1490                 $this->assertEquals($cm->name, $page->name);
1491             } else if ($cm->modname === 'forum') {
1492                 $this->assertEquals($cm->name, $forum->name);
1493             } else {
1494                 $this->fail('Unknown CM found.');
1495             }
1496         }
1497     }
1498
1499     /**
1500      * Test import_course into an filled course
1501      */
1502     public function test_import_course_filled() {
1503         global $USER;
1504
1505         $this->resetAfterTest(true);
1506
1507         // Add forum and page to course1.
1508         $course1  = self::getDataGenerator()->create_course();
1509         $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course1->id, 'name' => 'Forum test'));
1510         $page = $this->getDataGenerator()->create_module('page', array('course'=>$course1->id, 'name' => 'Page test'));
1511
1512         // Add quiz to course 2.
1513         $course2  = self::getDataGenerator()->create_course();
1514         $quiz = $this->getDataGenerator()->create_module('quiz', array('course'=>$course2->id, 'name' => 'Page test'));
1515
1516         $course1cms = get_fast_modinfo($course1->id)->get_cms();
1517         $course2cms = get_fast_modinfo($course2->id)->get_cms();
1518
1519         // Verify the state of the courses before we do the import.
1520         $this->assertCount(2, $course1cms);
1521         $this->assertCount(1, $course2cms);
1522
1523         // Setup the user to run the operation (ugly hack because validate_context() will
1524         // fail as the email is not set by $this->setAdminUser()).
1525         $this->setAdminUser();
1526         $USER->email = 'emailtopass@example.com';
1527
1528         // Import from course1 to course2 without deleting content.
1529         core_course_external::import_course($course1->id, $course2->id, 0);
1530
1531         $course2cms = get_fast_modinfo($course2->id)->get_cms();
1532
1533         // Verify that now we have three modules in course2.
1534         $this->assertCount(3, $course2cms);
1535
1536         // Verify that the names transfered across correctly.
1537         foreach ($course2cms as $cm) {
1538             if ($cm->modname === 'page') {
1539                 $this->assertEquals($cm->name, $page->name);
1540             } else if ($cm->modname === 'forum') {
1541                 $this->assertEquals($cm->name, $forum->name);
1542             } else if ($cm->modname === 'quiz') {
1543                 $this->assertEquals($cm->name, $quiz->name);
1544             } else {
1545                 $this->fail('Unknown CM found.');
1546             }
1547         }
1548     }
1549
1550     /**
1551      * Test import_course with only blocks set to backup
1552      */
1553     public function test_import_course_blocksonly() {
1554         global $USER, $DB;
1555
1556         $this->resetAfterTest(true);
1557
1558         // Add forum and page to course1.
1559         $course1  = self::getDataGenerator()->create_course();
1560         $course1ctx = context_course::instance($course1->id);
1561         $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course1->id, 'name' => 'Forum test'));
1562         $block = $this->getDataGenerator()->create_block('online_users', array('parentcontextid' => $course1ctx->id));
1563
1564         $course2  = self::getDataGenerator()->create_course();
1565         $course2ctx = context_course::instance($course2->id);
1566         $initialblockcount = $DB->count_records('block_instances', array('parentcontextid' => $course2ctx->id));
1567         $initialcmcount = count(get_fast_modinfo($course2->id)->get_cms());
1568
1569         // Setup the user to run the operation (ugly hack because validate_context() will
1570         // fail as the email is not set by $this->setAdminUser()).
1571         $this->setAdminUser();
1572         $USER->email = 'emailtopass@example.com';
1573
1574         // Import from course1 to course2 without deleting content, but excluding
1575         // activities.
1576         $options = array(
1577             array('name' => 'activities', 'value' => 0),
1578             array('name' => 'blocks', 'value' => 1),
1579             array('name' => 'filters', 'value' => 0),
1580         );
1581
1582         core_course_external::import_course($course1->id, $course2->id, 0, $options);
1583
1584         $newcmcount = count(get_fast_modinfo($course2->id)->get_cms());
1585         $newblockcount = $DB->count_records('block_instances', array('parentcontextid' => $course2ctx->id));
1586         // Check that course modules haven't changed, but that blocks have.
1587         $this->assertEquals($initialcmcount, $newcmcount);
1588         $this->assertEquals(($initialblockcount + 1), $newblockcount);
1589     }
1590
1591     /**
1592      * Test import_course into an filled course, deleting content.
1593      */
1594     public function test_import_course_deletecontent() {
1595         global $USER;
1596         $this->resetAfterTest(true);
1597
1598         // Add forum and page to course1.
1599         $course1  = self::getDataGenerator()->create_course();
1600         $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course1->id, 'name' => 'Forum test'));
1601         $page = $this->getDataGenerator()->create_module('page', array('course'=>$course1->id, 'name' => 'Page test'));
1602
1603         // Add quiz to course 2.
1604         $course2  = self::getDataGenerator()->create_course();
1605         $quiz = $this->getDataGenerator()->create_module('quiz', array('course'=>$course2->id, 'name' => 'Page test'));
1606
1607         $course1cms = get_fast_modinfo($course1->id)->get_cms();
1608         $course2cms = get_fast_modinfo($course2->id)->get_cms();
1609
1610         // Verify the state of the courses before we do the import.
1611         $this->assertCount(2, $course1cms);
1612         $this->assertCount(1, $course2cms);
1613
1614         // Setup the user to run the operation (ugly hack because validate_context() will
1615         // fail as the email is not set by $this->setAdminUser()).
1616         $this->setAdminUser();
1617         $USER->email = 'emailtopass@example.com';
1618
1619         // Import from course1 to course2,  deleting content.
1620         core_course_external::import_course($course1->id, $course2->id, 1);
1621
1622         $course2cms = get_fast_modinfo($course2->id)->get_cms();
1623
1624         // Verify that now we have two modules in course2.
1625         $this->assertCount(2, $course2cms);
1626
1627         // Verify that the course only contains the imported modules.
1628         foreach ($course2cms as $cm) {
1629             if ($cm->modname === 'page') {
1630                 $this->assertEquals($cm->name, $page->name);
1631             } else if ($cm->modname === 'forum') {
1632                 $this->assertEquals($cm->name, $forum->name);
1633             } else {
1634                 $this->fail('Unknown CM found: '.$cm->name);
1635             }
1636         }
1637     }
1638
1639     /**
1640      * Ensure import_course handles incorrect deletecontent option correctly.
1641      */
1642     public function test_import_course_invalid_deletecontent_option() {
1643         $this->resetAfterTest(true);
1644
1645         $course1  = self::getDataGenerator()->create_course();
1646         $course2  = self::getDataGenerator()->create_course();
1647
1648         $this->expectException('moodle_exception');
1649         $this->expectExceptionMessage(get_string('invalidextparam', 'webservice', -1));
1650         // Import from course1 to course2, with invalid option
1651         core_course_external::import_course($course1->id, $course2->id, -1);;
1652     }
1653
1654     /**
1655      * Test view_course function
1656      */
1657     public function test_view_course() {
1658
1659         $this->resetAfterTest();
1660
1661         // Course without sections.
1662         $course = $this->getDataGenerator()->create_course(array('numsections' => 5), array('createsections' => true));
1663         $this->setAdminUser();
1664
1665         // Redirect events to the sink, so we can recover them later.
1666         $sink = $this->redirectEvents();
1667
1668         $result = core_course_external::view_course($course->id, 1);
1669         $result = external_api::clean_returnvalue(core_course_external::view_course_returns(), $result);
1670         $events = $sink->get_events();
1671         $event = reset($events);
1672
1673         // Check the event details are correct.
1674         $this->assertInstanceOf('\core\event\course_viewed', $event);
1675         $this->assertEquals(context_course::instance($course->id), $event->get_context());
1676         $this->assertEquals(1, $event->other['coursesectionnumber']);
1677
1678         $result = core_course_external::view_course($course->id);
1679         $result = external_api::clean_returnvalue(core_course_external::view_course_returns(), $result);
1680         $events = $sink->get_events();
1681         $event = array_pop($events);
1682         $sink->close();
1683
1684         // Check the event details are correct.
1685         $this->assertInstanceOf('\core\event\course_viewed', $event);
1686         $this->assertEquals(context_course::instance($course->id), $event->get_context());
1687         $this->assertEmpty($event->other);
1688
1689     }
1690
1691     /**
1692      * Test get_course_module
1693      */
1694     public function test_get_course_module() {
1695         global $DB;
1696
1697         $this->resetAfterTest(true);
1698
1699         $this->setAdminUser();
1700         $course = self::getDataGenerator()->create_course();
1701         $record = array(
1702             'course' => $course->id,
1703             'name' => 'First Assignment'
1704         );
1705         $options = array(
1706             'idnumber' => 'ABC',
1707             'visible' => 0
1708         );
1709         // Hidden activity.
1710         $assign = self::getDataGenerator()->create_module('assign', $record, $options);
1711
1712         $outcomescale = 'Distinction, Very Good, Good, Pass, Fail';
1713
1714         // Insert a custom grade scale to be used by an outcome.
1715         $gradescale = new grade_scale();
1716         $gradescale->name        = 'gettcoursemodulescale';
1717         $gradescale->courseid    = $course->id;
1718         $gradescale->userid      = 0;
1719         $gradescale->scale       = $outcomescale;
1720         $gradescale->description = 'This scale is used to mark standard assignments.';
1721         $gradescale->insert();
1722
1723         // Insert an outcome.
1724         $data = new stdClass();
1725         $data->courseid = $course->id;
1726         $data->fullname = 'Team work';
1727         $data->shortname = 'Team work';
1728         $data->scaleid = $gradescale->id;
1729         $outcome = new grade_outcome($data, false);
1730         $outcome->insert();
1731
1732         $outcomegradeitem = new grade_item();
1733         $outcomegradeitem->itemname = $outcome->shortname;
1734         $outcomegradeitem->itemtype = 'mod';
1735         $outcomegradeitem->itemmodule = 'assign';
1736         $outcomegradeitem->iteminstance = $assign->id;
1737         $outcomegradeitem->outcomeid = $outcome->id;
1738         $outcomegradeitem->cmid = 0;
1739         $outcomegradeitem->courseid = $course->id;
1740         $outcomegradeitem->aggregationcoef = 0;
1741         $outcomegradeitem->itemnumber = 1; // The activity's original grade item will be 0.
1742         $outcomegradeitem->gradetype = GRADE_TYPE_SCALE;
1743         $outcomegradeitem->scaleid = $outcome->scaleid;
1744         $outcomegradeitem->insert();
1745
1746         $assignmentgradeitem = grade_item::fetch(
1747             array(
1748                 'itemtype' => 'mod',
1749                 'itemmodule' => 'assign',
1750                 'iteminstance' => $assign->id,
1751                 'itemnumber' => 0,
1752                 'courseid' => $course->id
1753             )
1754         );
1755         $outcomegradeitem->set_parent($assignmentgradeitem->categoryid);
1756         $outcomegradeitem->move_after_sortorder($assignmentgradeitem->sortorder);
1757
1758         // Test admin user can see the complete hidden activity.
1759         $result = core_course_external::get_course_module($assign->cmid);
1760         $result = external_api::clean_returnvalue(core_course_external::get_course_module_returns(), $result);
1761
1762         $this->assertCount(0, $result['warnings']);
1763         // Test we retrieve all the fields.
1764         $this->assertCount(28, $result['cm']);
1765         $this->assertEquals($record['name'], $result['cm']['name']);
1766         $this->assertEquals($options['idnumber'], $result['cm']['idnumber']);
1767         $this->assertEquals(100, $result['cm']['grade']);
1768         $this->assertEquals(0.0, $result['cm']['gradepass']);
1769         $this->assertEquals('submissions', $result['cm']['advancedgrading'][0]['area']);
1770         $this->assertEmpty($result['cm']['advancedgrading'][0]['method']);
1771         $this->assertEquals($outcomescale, $result['cm']['outcomes'][0]['scale']);
1772
1773         $student = $this->getDataGenerator()->create_user();
1774         $studentrole = $DB->get_record('role', array('shortname' => 'student'));
1775
1776         self::getDataGenerator()->enrol_user($student->id,  $course->id, $studentrole->id);
1777         $this->setUser($student);
1778
1779         // The user shouldn't be able to see the activity.
1780         try {
1781             core_course_external::get_course_module($assign->cmid);
1782             $this->fail('Exception expected due to invalid permissions.');
1783         } catch (moodle_exception $e) {
1784             $this->assertEquals('requireloginerror', $e->errorcode);
1785         }
1786
1787         // Make module visible.
1788         set_coursemodule_visible($assign->cmid, 1);
1789
1790         // Test student user.
1791         $result = core_course_external::get_course_module($assign->cmid);
1792         $result = external_api::clean_returnvalue(core_course_external::get_course_module_returns(), $result);
1793
1794         $this->assertCount(0, $result['warnings']);
1795         // Test we retrieve only the few files we can see.
1796         $this->assertCount(11, $result['cm']);
1797         $this->assertEquals($assign->cmid, $result['cm']['id']);
1798         $this->assertEquals($course->id, $result['cm']['course']);
1799         $this->assertEquals('assign', $result['cm']['modname']);
1800         $this->assertEquals($assign->id, $result['cm']['instance']);
1801
1802     }
1803
1804     /**
1805      * Test get_course_module_by_instance
1806      */
1807     public function test_get_course_module_by_instance() {
1808         global $DB;
1809
1810         $this->resetAfterTest(true);
1811
1812         $this->setAdminUser();
1813         $course = self::getDataGenerator()->create_course();
1814         $record = array(
1815             'course' => $course->id,
1816             'name' => 'First quiz',
1817             'grade' => 90.00
1818         );
1819         $options = array(
1820             'idnumber' => 'ABC',
1821             'visible' => 0
1822         );
1823         // Hidden activity.
1824         $quiz = self::getDataGenerator()->create_module('quiz', $record, $options);
1825
1826         // Test admin user can see the complete hidden activity.
1827         $result = core_course_external::get_course_module_by_instance('quiz', $quiz->id);
1828         $result = external_api::clean_returnvalue(core_course_external::get_course_module_by_instance_returns(), $result);
1829
1830         $this->assertCount(0, $result['warnings']);
1831         // Test we retrieve all the fields.
1832         $this->assertCount(26, $result['cm']);
1833         $this->assertEquals($record['name'], $result['cm']['name']);
1834         $this->assertEquals($record['grade'], $result['cm']['grade']);
1835         $this->assertEquals($options['idnumber'], $result['cm']['idnumber']);
1836
1837         $student = $this->getDataGenerator()->create_user();
1838         $studentrole = $DB->get_record('role', array('shortname' => 'student'));
1839
1840         self::getDataGenerator()->enrol_user($student->id,  $course->id, $studentrole->id);
1841         $this->setUser($student);
1842
1843         // The user shouldn't be able to see the activity.
1844         try {
1845             core_course_external::get_course_module_by_instance('quiz', $quiz->id);
1846             $this->fail('Exception expected due to invalid permissions.');
1847         } catch (moodle_exception $e) {
1848             $this->assertEquals('requireloginerror', $e->errorcode);
1849         }
1850
1851         // Make module visible.
1852         set_coursemodule_visible($quiz->cmid, 1);
1853
1854         // Test student user.
1855         $result = core_course_external::get_course_module_by_instance('quiz', $quiz->id);
1856         $result = external_api::clean_returnvalue(core_course_external::get_course_module_by_instance_returns(), $result);
1857
1858         $this->assertCount(0, $result['warnings']);
1859         // Test we retrieve only the few files we can see.
1860         $this->assertCount(11, $result['cm']);
1861         $this->assertEquals($quiz->cmid, $result['cm']['id']);
1862         $this->assertEquals($course->id, $result['cm']['course']);
1863         $this->assertEquals('quiz', $result['cm']['modname']);
1864         $this->assertEquals($quiz->id, $result['cm']['instance']);
1865
1866         // Try with an invalid module name.
1867         try {
1868             core_course_external::get_course_module_by_instance('abc', $quiz->id);
1869             $this->fail('Exception expected due to invalid module name.');
1870         } catch (dml_read_exception $e) {
1871             $this->assertEquals('dmlreadexception', $e->errorcode);
1872         }
1873
1874     }
1875
1876     /**
1877      * Test get_activities_overview
1878      */
1879     public function test_get_activities_overview() {
1880         global $USER;
1881
1882         $this->resetAfterTest();
1883         $course1 = self::getDataGenerator()->create_course();
1884         $course2 = self::getDataGenerator()->create_course();
1885
1886         // Create a viewer user.
1887         $viewer = self::getDataGenerator()->create_user((object) array('trackforums' => 1));
1888         $this->getDataGenerator()->enrol_user($viewer->id, $course1->id);
1889         $this->getDataGenerator()->enrol_user($viewer->id, $course2->id);
1890
1891         // Create two forums - one in each course.
1892         $record = new stdClass();
1893         $record->course = $course1->id;
1894         $forum1 = self::getDataGenerator()->create_module('forum', (object) array('course' => $course1->id));
1895         $forum2 = self::getDataGenerator()->create_module('forum', (object) array('course' => $course2->id));
1896
1897         $this->setAdminUser();
1898         // A standard post in the forum.
1899         $record = new stdClass();
1900         $record->course = $course1->id;
1901         $record->userid = $USER->id;
1902         $record->forum = $forum1->id;
1903         $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
1904
1905         $this->setUser($viewer->id);
1906         $courses = array($course1->id , $course2->id);
1907
1908         $result = core_course_external::get_activities_overview($courses);
1909         $this->assertDebuggingCalledCount(8);
1910         $result = external_api::clean_returnvalue(core_course_external::get_activities_overview_returns(), $result);
1911
1912         // There should be one entry for course1, and no others.
1913         $this->assertCount(1, $result['courses']);
1914         $this->assertEquals($course1->id, $result['courses'][0]['id']);
1915         // Check expected overview data for the module.
1916         $this->assertEquals('forum', $result['courses'][0]['overviews'][0]['module']);
1917         $this->assertContains('1 total unread', $result['courses'][0]['overviews'][0]['overviewtext']);
1918     }
1919
1920     /**
1921      * Test get_user_navigation_options
1922      */
1923     public function test_get_user_navigation_options() {
1924         global $USER;
1925
1926         $this->resetAfterTest();
1927         $course1 = self::getDataGenerator()->create_course();
1928         $course2 = self::getDataGenerator()->create_course();
1929
1930         // Create a viewer user.
1931         $viewer = self::getDataGenerator()->create_user();
1932         $this->getDataGenerator()->enrol_user($viewer->id, $course1->id);
1933         $this->getDataGenerator()->enrol_user($viewer->id, $course2->id);
1934
1935         $this->setUser($viewer->id);
1936         $courses = array($course1->id , $course2->id, SITEID);
1937
1938         $result = core_course_external::get_user_navigation_options($courses);
1939         $result = external_api::clean_returnvalue(core_course_external::get_user_navigation_options_returns(), $result);
1940
1941         $this->assertCount(0, $result['warnings']);
1942         $this->assertCount(3, $result['courses']);
1943
1944         foreach ($result['courses'] as $course) {
1945             $navoptions = new stdClass;
1946             foreach ($course['options'] as $option) {
1947                 $navoptions->{$option['name']} = $option['available'];
1948             }
1949             $this->assertCount(9, $course['options']);
1950             if ($course['id'] == SITEID) {
1951                 $this->assertTrue($navoptions->blogs);
1952                 $this->assertFalse($navoptions->notes);
1953                 $this->assertFalse($navoptions->participants);
1954                 $this->assertTrue($navoptions->badges);
1955                 $this->assertTrue($navoptions->tags);
1956                 $this->assertFalse($navoptions->grades);
1957                 $this->assertFalse($navoptions->search);
1958                 $this->assertTrue($navoptions->calendar);
1959                 $this->assertTrue($navoptions->competencies);
1960             } else {
1961                 $this->assertTrue($navoptions->blogs);
1962                 $this->assertFalse($navoptions->notes);
1963                 $this->assertTrue($navoptions->participants);
1964                 $this->assertTrue($navoptions->badges);
1965                 $this->assertFalse($navoptions->tags);
1966                 $this->assertTrue($navoptions->grades);
1967                 $this->assertFalse($navoptions->search);
1968                 $this->assertFalse($navoptions->calendar);
1969                 $this->assertTrue($navoptions->competencies);
1970             }
1971         }
1972     }
1973
1974     /**
1975      * Test get_user_administration_options
1976      */
1977     public function test_get_user_administration_options() {
1978         global $USER;
1979
1980         $this->resetAfterTest();
1981         $course1 = self::getDataGenerator()->create_course();
1982         $course2 = self::getDataGenerator()->create_course();
1983
1984         // Create a viewer user.
1985         $viewer = self::getDataGenerator()->create_user();
1986         $this->getDataGenerator()->enrol_user($viewer->id, $course1->id);
1987         $this->getDataGenerator()->enrol_user($viewer->id, $course2->id);
1988
1989         $this->setUser($viewer->id);
1990         $courses = array($course1->id , $course2->id, SITEID);
1991
1992         $result = core_course_external::get_user_administration_options($courses);
1993         $result = external_api::clean_returnvalue(core_course_external::get_user_administration_options_returns(), $result);
1994
1995         $this->assertCount(0, $result['warnings']);
1996         $this->assertCount(3, $result['courses']);
1997
1998         foreach ($result['courses'] as $course) {
1999             $adminoptions = new stdClass;
2000             foreach ($course['options'] as $option) {
2001                 $adminoptions->{$option['name']} = $option['available'];
2002             }
2003             if ($course['id'] == SITEID) {
2004                 $this->assertCount(16, $course['options']);
2005                 $this->assertFalse($adminoptions->update);
2006                 $this->assertFalse($adminoptions->filters);
2007                 $this->assertFalse($adminoptions->reports);
2008                 $this->assertFalse($adminoptions->backup);
2009                 $this->assertFalse($adminoptions->restore);
2010                 $this->assertFalse($adminoptions->files);
2011                 $this->assertFalse(!isset($adminoptions->tags));
2012                 $this->assertFalse($adminoptions->gradebook);
2013                 $this->assertFalse($adminoptions->outcomes);
2014                 $this->assertFalse($adminoptions->badges);
2015                 $this->assertFalse($adminoptions->import);
2016                 $this->assertFalse($adminoptions->publish);
2017                 $this->assertFalse($adminoptions->reset);
2018                 $this->assertFalse($adminoptions->roles);
2019                 $this->assertFalse($adminoptions->editcompletion);
2020             } else {
2021                 $this->assertCount(15, $course['options']);
2022                 $this->assertFalse($adminoptions->update);
2023                 $this->assertFalse($adminoptions->filters);
2024                 $this->assertFalse($adminoptions->reports);
2025                 $this->assertFalse($adminoptions->backup);
2026                 $this->assertFalse($adminoptions->restore);
2027                 $this->assertFalse($adminoptions->files);
2028                 $this->assertFalse($adminoptions->tags);
2029                 $this->assertFalse($adminoptions->gradebook);
2030                 $this->assertFalse($adminoptions->outcomes);
2031                 $this->assertTrue($adminoptions->badges);
2032                 $this->assertFalse($adminoptions->import);
2033                 $this->assertFalse($adminoptions->publish);
2034                 $this->assertFalse($adminoptions->reset);
2035                 $this->assertFalse($adminoptions->roles);
2036                 $this->assertFalse($adminoptions->editcompletion);
2037             }
2038         }
2039     }
2040
2041     /**
2042      * Test get_courses_by_fields
2043      */
2044     public function test_get_courses_by_field() {
2045         global $DB;
2046         $this->resetAfterTest(true);
2047
2048         $category1 = self::getDataGenerator()->create_category(array('name' => 'Cat 1'));
2049         $category2 = self::getDataGenerator()->create_category(array('parent' => $category1->id));
2050         $course1 = self::getDataGenerator()->create_course(
2051             array('category' => $category1->id, 'shortname' => 'c1', 'format' => 'topics'));
2052         $course2 = self::getDataGenerator()->create_course(array('visible' => 0, 'category' => $category2->id, 'idnumber' => 'i2'));
2053
2054         $student1 = self::getDataGenerator()->create_user();
2055         $user1 = self::getDataGenerator()->create_user();
2056         $studentrole = $DB->get_record('role', array('shortname' => 'student'));
2057         self::getDataGenerator()->enrol_user($student1->id, $course1->id, $studentrole->id);
2058         self::getDataGenerator()->enrol_user($student1->id, $course2->id, $studentrole->id);
2059
2060         self::setAdminUser();
2061         // As admins, we should be able to retrieve everything.
2062         $result = core_course_external::get_courses_by_field();
2063         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2064         $this->assertCount(3, $result['courses']);
2065         // Expect to receive all the fields.
2066         $this->assertCount(37, $result['courses'][0]);
2067         $this->assertCount(38, $result['courses'][1]);  // One more field because is not the site course.
2068         $this->assertCount(38, $result['courses'][2]);  // One more field because is not the site course.
2069
2070         $result = core_course_external::get_courses_by_field('id', $course1->id);
2071         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2072         $this->assertCount(1, $result['courses']);
2073         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2074         // Expect to receive all the fields.
2075         $this->assertCount(38, $result['courses'][0]);
2076         // Check default values for course format topics.
2077         $this->assertCount(2, $result['courses'][0]['courseformatoptions']);
2078         foreach ($result['courses'][0]['courseformatoptions'] as $option) {
2079             if ($option['name'] == 'hiddensections') {
2080                 $this->assertEquals(0, $option['value']);
2081             } else {
2082                 $this->assertEquals('coursedisplay', $option['name']);
2083                 $this->assertEquals(0, $option['value']);
2084             }
2085         }
2086
2087         $result = core_course_external::get_courses_by_field('id', $course2->id);
2088         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2089         $this->assertCount(1, $result['courses']);
2090         $this->assertEquals($course2->id, $result['courses'][0]['id']);
2091
2092         $result = core_course_external::get_courses_by_field('ids', "$course1->id,$course2->id");
2093         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2094         $this->assertCount(2, $result['courses']);
2095
2096         // Check default filters.
2097         $this->assertCount(3, $result['courses'][0]['filters']);
2098         $this->assertCount(3, $result['courses'][1]['filters']);
2099
2100         $result = core_course_external::get_courses_by_field('category', $category1->id);
2101         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2102         $this->assertCount(1, $result['courses']);
2103         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2104         $this->assertEquals('Cat 1', $result['courses'][0]['categoryname']);
2105
2106         $result = core_course_external::get_courses_by_field('shortname', 'c1');
2107         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2108         $this->assertCount(1, $result['courses']);
2109         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2110
2111         $result = core_course_external::get_courses_by_field('idnumber', 'i2');
2112         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2113         $this->assertCount(1, $result['courses']);
2114         $this->assertEquals($course2->id, $result['courses'][0]['id']);
2115
2116         $result = core_course_external::get_courses_by_field('idnumber', 'x');
2117         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2118         $this->assertCount(0, $result['courses']);
2119
2120         // Change filter value.
2121         filter_set_local_state('mediaplugin', context_course::instance($course1->id)->id, TEXTFILTER_OFF);
2122
2123         self::setUser($student1);
2124         // All visible courses  (including front page) for normal student.
2125         $result = core_course_external::get_courses_by_field();
2126         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2127         $this->assertCount(2, $result['courses']);
2128         $this->assertCount(30, $result['courses'][0]);
2129         $this->assertCount(31, $result['courses'][1]);  // One field more (course format options), not present in site course.
2130
2131         $result = core_course_external::get_courses_by_field('id', $course1->id);
2132         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2133         $this->assertCount(1, $result['courses']);
2134         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2135         // Expect to receive all the files that a student can see.
2136         $this->assertCount(31, $result['courses'][0]);
2137
2138         // Check default filters.
2139         $filters = $result['courses'][0]['filters'];
2140         $this->assertCount(3, $filters);
2141         $found = false;
2142         foreach ($filters as $filter) {
2143             if ($filter['filter'] == 'mediaplugin' and $filter['localstate'] == TEXTFILTER_OFF) {
2144                 $found = true;
2145             }
2146         }
2147         $this->assertTrue($found);
2148
2149         // Course 2 is not visible.
2150         $result = core_course_external::get_courses_by_field('id', $course2->id);
2151         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2152         $this->assertCount(0, $result['courses']);
2153
2154         $result = core_course_external::get_courses_by_field('ids', "$course1->id,$course2->id");
2155         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2156         $this->assertCount(1, $result['courses']);
2157
2158         $result = core_course_external::get_courses_by_field('category', $category1->id);
2159         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2160         $this->assertCount(1, $result['courses']);
2161         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2162
2163         $result = core_course_external::get_courses_by_field('shortname', 'c1');
2164         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2165         $this->assertCount(1, $result['courses']);
2166         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2167
2168         $result = core_course_external::get_courses_by_field('idnumber', 'i2');
2169         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2170         $this->assertCount(0, $result['courses']);
2171
2172         $result = core_course_external::get_courses_by_field('idnumber', 'x');
2173         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2174         $this->assertCount(0, $result['courses']);
2175
2176         self::setUser($user1);
2177         // All visible courses (including front page) for authenticated user.
2178         $result = core_course_external::get_courses_by_field();
2179         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2180         $this->assertCount(2, $result['courses']);
2181         $this->assertCount(30, $result['courses'][0]);  // Site course.
2182         $this->assertCount(13, $result['courses'][1]);  // Only public information, not enrolled.
2183
2184         $result = core_course_external::get_courses_by_field('id', $course1->id);
2185         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2186         $this->assertCount(1, $result['courses']);
2187         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2188         // Expect to receive all the files that a authenticated can see.
2189         $this->assertCount(13, $result['courses'][0]);
2190
2191         // Course 2 is not visible.
2192         $result = core_course_external::get_courses_by_field('id', $course2->id);
2193         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2194         $this->assertCount(0, $result['courses']);
2195
2196         $result = core_course_external::get_courses_by_field('ids', "$course1->id,$course2->id");
2197         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2198         $this->assertCount(1, $result['courses']);
2199
2200         $result = core_course_external::get_courses_by_field('category', $category1->id);
2201         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2202         $this->assertCount(1, $result['courses']);
2203         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2204
2205         $result = core_course_external::get_courses_by_field('shortname', 'c1');
2206         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2207         $this->assertCount(1, $result['courses']);
2208         $this->assertEquals($course1->id, $result['courses'][0]['id']);
2209
2210         $result = core_course_external::get_courses_by_field('idnumber', 'i2');
2211         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2212         $this->assertCount(0, $result['courses']);
2213
2214         $result = core_course_external::get_courses_by_field('idnumber', 'x');
2215         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2216         $this->assertCount(0, $result['courses']);
2217     }
2218
2219     public function test_get_courses_by_field_invalid_field() {
2220         $this->expectException('invalid_parameter_exception');
2221         $result = core_course_external::get_courses_by_field('zyx', 'x');
2222     }
2223
2224     public function test_get_courses_by_field_invalid_courses() {
2225         $result = core_course_external::get_courses_by_field('id', '-1');
2226         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2227         $this->assertCount(0, $result['courses']);
2228     }
2229
2230     /**
2231      * Test get_courses_by_field_invalid_theme_and_lang
2232      */
2233     public function test_get_courses_by_field_invalid_theme_and_lang() {
2234         $this->resetAfterTest(true);
2235         $this->setAdminUser();
2236
2237         $course = self::getDataGenerator()->create_course(array('theme' => 'kkt', 'lang' => 'kkl'));
2238         $result = core_course_external::get_courses_by_field('id', $course->id);
2239         $result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
2240         $this->assertEmpty($result['courses']['0']['theme']);
2241         $this->assertEmpty($result['courses']['0']['lang']);
2242     }
2243
2244
2245     public function test_check_updates() {
2246         global $DB;
2247         $this->resetAfterTest(true);
2248         $this->setAdminUser();
2249
2250         // Create different types of activities.
2251         $course  = self::getDataGenerator()->create_course();
2252         $tocreate = array('assign', 'book', 'choice', 'folder', 'forum', 'glossary', 'imscp', 'label', 'lti', 'page', 'quiz',
2253                             'resource', 'scorm', 'survey', 'url', 'wiki');
2254
2255         $modules = array();
2256         foreach ($tocreate as $modname) {
2257             $modules[$modname]['instance'] = $this->getDataGenerator()->create_module($modname, array('course' => $course->id));
2258             $modules[$modname]['cm'] = get_coursemodule_from_id(false, $modules[$modname]['instance']->cmid);
2259             $modules[$modname]['context'] = context_module::instance($modules[$modname]['instance']->cmid);
2260         }
2261
2262         $student = self::getDataGenerator()->create_user();
2263         $studentrole = $DB->get_record('role', array('shortname' => 'student'));
2264         self::getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id);
2265         $this->setUser($student);
2266
2267         $since = time();
2268         $this->waitForSecond();
2269         $params = array();
2270         foreach ($modules as $modname => $data) {
2271             $params[$data['cm']->id] = array(
2272                 'contextlevel' => 'module',
2273                 'id' => $data['cm']->id,
2274                 'since' => $since
2275             );
2276         }
2277
2278         // Check there is nothing updated because modules are fresh new.
2279         $result = core_course_external::check_updates($course->id, $params);
2280         $result = external_api::clean_returnvalue(core_course_external::check_updates_returns(), $result);
2281         $this->assertCount(0, $result['instances']);
2282         $this->assertCount(0, $result['warnings']);
2283
2284         // Test with get_updates_since the same data.
2285         $result = core_course_external::get_updates_since($course->id, $since);
2286         $result = external_api::clean_returnvalue(core_course_external::get_updates_since_returns(), $result);
2287         $this->assertCount(0, $result['instances']);
2288         $this->assertCount(0, $result['warnings']);
2289
2290         // Update a module after a second.
2291         $this->waitForSecond();
2292         set_coursemodule_name($modules['forum']['cm']->id, 'New forum name');
2293
2294         $found = false;
2295         $result = core_course_external::check_updates($course->id, $params);
2296         $result = external_api::clean_returnvalue(core_course_external::check_updates_returns(), $result);
2297         $this->assertCount(1, $result['instances']);
2298         $this->assertCount(0, $result['warnings']);
2299         foreach ($result['instances'] as $module) {
2300             foreach ($module['updates'] as $update) {
2301                 if ($module['id'] == $modules['forum']['cm']->id and $update['name'] == 'configuration') {
2302                     $found = true;
2303                 }
2304             }
2305         }
2306         $this->assertTrue($found);
2307
2308         // Test with get_updates_since the same data.
2309         $result = core_course_external::get_updates_since($course->id, $since);
2310         $result = external_api::clean_returnvalue(core_course_external::get_updates_since_returns(), $result);
2311         $this->assertCount(1, $result['instances']);
2312         $this->assertCount(0, $result['warnings']);
2313         $found = false;
2314         $this->assertCount(1, $result['instances']);
2315         $this->assertCount(0, $result['warnings']);
2316         foreach ($result['instances'] as $module) {
2317             foreach ($module['updates'] as $update) {
2318                 if ($module['id'] == $modules['forum']['cm']->id and $update['name'] == 'configuration') {
2319                     $found = true;
2320                 }
2321             }
2322         }
2323         $this->assertTrue($found);
2324
2325         // Do not retrieve the configuration field.
2326         $filter = array('files');
2327         $found = false;
2328         $result = core_course_external::check_updates($course->id, $params, $filter);
2329         $result = external_api::clean_returnvalue(core_course_external::check_updates_returns(), $result);
2330         $this->assertCount(0, $result['instances']);
2331         $this->assertCount(0, $result['warnings']);
2332         $this->assertFalse($found);
2333
2334         // Add invalid cmid.
2335         $params[] = array(
2336             'contextlevel' => 'module',
2337             'id' => -2,
2338             'since' => $since
2339         );
2340         $result = core_course_external::check_updates($course->id, $params);
2341         $result = external_api::clean_returnvalue(core_course_external::check_updates_returns(), $result);
2342         $this->assertCount(1, $result['warnings']);
2343         $this->assertEquals(-2, $result['warnings'][0]['itemid']);
2344     }
2345 }