9228233ca980de63f96ed05fba40dbb81ff76440
[moodle.git] / mod / data / tests / search_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/>.
17 /**
18  * Unit tests for data_get_all_recordsids(), data_get_advance_search_ids(), data_get_record_ids(),
19  * and data_get_advanced_search_sql()
20  *
21  * @package    mod_data
22  * @category   phpunit
23  * @copyright  2012 Adrian Greeve
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 global $CFG;
30 require_once($CFG->dirroot . '/mod/data/lib.php');
31 require_once($CFG->dirroot . '/lib/datalib.php');
32 require_once($CFG->dirroot . '/lib/csvlib.class.php');
33 require_once($CFG->dirroot . '/search/tests/fixtures/testable_core_search.php');
34 require_once($CFG->dirroot . '/mod/data/tests/generator/lib.php');
36 /**
37  * Unit tests for {@see data_get_all_recordids()}.
38  *                {@see data_get_advanced_search_ids()}
39  *                {@see data_get_record_ids()}
40  *                {@see data_get_advanced_search_sql()}
41  *
42  * @package    mod_data
43  * @copyright  2012 Adrian Greeve
44  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45  */
46 class mod_data_search_test extends advanced_testcase {
47     /**
48      * @var stdObject $recorddata An object that holds information from the table data.
49      */
50     public $recorddata = null;
51     /**
52      * @var int $recordcontentid The content ID.
53      */
54     public $recordcontentid = null;
55     /**
56      * @var int $recordrecordid The record ID.
57      */
58     public $recordrecordid = null;
59     /**
60      * @var int $recordfieldid The field ID.
61      */
62     public $recordfieldid = null;
63     /**
64      * @var array $recordsearcharray An array of stdClass which contains search criteria.
65      */
66     public $recordsearcharray = null;
68     // CONSTANTS
70     /**
71      * @var int $datarecordcount   The number of records in the database.
72      */
73     public $datarecordcount = 100;
75     /**
76      * @var int $groupdatarecordcount  The number of records in the database in groups 0 and 1.
77      */
78     public $groupdatarecordcount = 75;
80     /**
81      * @var array $datarecordset   Expected record IDs.
82      */
83     public $datarecordset = array('0' => '6');
85     /**
86      * @var array $finalrecord   Final record for comparison with test four.
87      */
88     public $finalrecord = array();
90     /**
91      * @var int $approvedatarecordcount  The number of approved records in the database.
92      */
93     public $approvedatarecordcount = 89;
95     /**
96      * @var string Area id
97      */
98     protected $databaseentryareaid = null;
100     /**
101      * Set up function. In this instance we are setting up database
102      * records to be used in the unit tests.
103      */
104     protected function setUp() {
105         global $DB, $CFG;
106         parent::setUp();
108         $this->resetAfterTest(true);
110         set_config('enableglobalsearch', true);
112         $this->databaseentryareaid = \core_search\manager::generate_areaid('mod_data', 'entry');
114         // Set \core_search::instance to the mock_search_engine as we don't require the search engine to be working to test this.
115         $search = testable_core_search::instance();
117     }
119     /**
120      * Test 1: The function data_get_all_recordids.
121      *
122      * Test 2: This tests the data_get_advance_search_ids() function. The function takes a set
123      * of all the record IDs in the database and then with the search details ($this->recordsearcharray)
124      * returns a comma seperated string of record IDs that match the search criteria.
125      *
126      * Test 3: This function tests data_get_recordids(). This is the function that is nested in the last
127      * function (see data_get_advance_search_ids). This function takes a couple of
128      * extra parameters. $alias is the field alias used in the sql query and $commaid
129      * is a comma seperated string of record IDs.
130      *
131      * Test 3.1: This tests that if no recordids are provided (In a situation where a search is done on an empty database)
132      * That an empty array is returned.
133      *
134      * Test 4: data_get_advanced_search_sql provides an array which contains an sql string to be used for displaying records
135      * to the user when they use the advanced search criteria and the parameters that go with the sql statement. This test
136      * takes that information and does a search on the database, returning a record.
137      *
138      * Test 5: Returning to data_get_all_recordids(). Here we are ensuring that the total amount of record ids is reduced to
139      * match the group conditions that are provided. There are 25 entries which relate to group 2. They are removed
140      * from the total so we should only have 75 records total.
141      *
142      * Test 6: data_get_all_recordids() again. This time we are testing approved database records. We only want to
143      * display the records that have been approved. In this record set we have 89 approved records.
144      */
145     public function test_advanced_search_sql_section() {
146         global $DB;
148         // we already have 2 users, we need 98 more - let's ignore the fact that guest can not post anywhere
149         // We reset the user sequence here to ensure we get the expected numbers.
150         // TODO: Invent a better way for managing data file input against database sequence id's.
151         $DB->get_manager()->reset_sequence('user');
152         for($i=3;$i<=100;$i++) {
153             $this->getDataGenerator()->create_user();
154         }
156         // create database module - there should be more of these I guess
157         $course = $this->getDataGenerator()->create_course();
158         $data = $this->getDataGenerator()->create_module('data', array('course'=>$course->id));
159         $this->recorddata = $data;
161         // Set up data for the test database.
162         $files = array(
163                 'data_fields'  => __DIR__.'/fixtures/test_data_fields.csv',
164                 'data_records' => __DIR__.'/fixtures/test_data_records.csv',
165                 'data_content' => __DIR__.'/fixtures/test_data_content.csv',
166         );
167         $this->loadDataSet($this->createCsvDataSet($files));
168         // Set dataid to the correct value now the data has been inserted by csv file.
169         $DB->execute('UPDATE {data_fields} SET dataid = ?', array($data->id));
170         $DB->execute('UPDATE {data_records} SET dataid = ?', array($data->id));
172         // Create the search array which contains our advanced search criteria.
173         $fieldinfo = array('0' => new stdClass(),
174                 '1' => new stdClass(),
175                 '2' => new stdClass(),
176                 '3' => new stdClass(),
177                 '4' => new stdClass());
178         $fieldinfo['0']->id = 1;
179         $fieldinfo['0']->data = '3.721,46.6126';
180         $fieldinfo['1']->id = 2;
181         $fieldinfo['1']->data = 'Hahn Premium';
182         $fieldinfo['2']->id = 5;
183         $fieldinfo['2']->data = 'Female';
184         $fieldinfo['3']->id = 7;
185         $fieldinfo['3']->data = 'kel';
186         $fieldinfo['4']->id = 9;
187         $fieldinfo['4']->data = 'VIC';
189         foreach($fieldinfo as $field) {
190             $searchfield = data_get_field_from_id($field->id, $data);
191             if ($field->id == 2) {
192                 $searchfield->field->param1 = 'Hahn Premium';
193                 $val = array();
194                 $val['selected'] = array('0' => 'Hahn Premium');
195                 $val['allrequired'] = 0;
196             } else {
197                 $val = $field->data;
198             }
199             $search_array[$field->id] = new stdClass();
200             list($search_array[$field->id]->sql, $search_array[$field->id]->params) = $searchfield->generate_sql('c' . $field->id, $val);
201         }
203         $this->recordsearcharray = $search_array;
205         // Setting up the comparison stdClass for the last test.
206         $user = $DB->get_record('user', array('id'=>6));
207         $this->finalrecord[6] = new stdClass();
208         $this->finalrecord[6]->id = 6;
209         $this->finalrecord[6]->approved = 1;
210         $this->finalrecord[6]->timecreated = 1234567891;
211         $this->finalrecord[6]->timemodified = 1234567892;
212         $this->finalrecord[6]->userid = 6;
213         $this->finalrecord[6]->firstname = $user->firstname;
214         $this->finalrecord[6]->lastname = $user->lastname;
215         $this->finalrecord[6]->firstnamephonetic = $user->firstnamephonetic;
216         $this->finalrecord[6]->lastnamephonetic = $user->lastnamephonetic;
217         $this->finalrecord[6]->middlename = $user->middlename;
218         $this->finalrecord[6]->alternatename = $user->alternatename;
219         $this->finalrecord[6]->picture = $user->picture;
220         $this->finalrecord[6]->imagealt = $user->imagealt;
221         $this->finalrecord[6]->email = $user->email;
223         // Test 1
224         $recordids = data_get_all_recordids($this->recorddata->id);
225         $this->assertEquals(count($recordids), $this->datarecordcount);
227         // Test 2
228         $key = array_keys($this->recordsearcharray);
229         $alias = $key[0];
230         $newrecordids = data_get_recordids($alias, $this->recordsearcharray, $this->recorddata->id, $recordids);
231         $this->assertEquals($this->datarecordset, $newrecordids);
233         // Test 3
234         $newrecordids = data_get_advance_search_ids($recordids, $this->recordsearcharray, $this->recorddata->id);
235         $this->assertEquals($this->datarecordset, $newrecordids);
237         // Test 3.1
238         $resultrecordids = data_get_advance_search_ids(array(), $this->recordsearcharray, $this->recorddata->id);
239         $this->assertEmpty($resultrecordids);
241         // Test 4
242         $sortorder = 'ORDER BY r.timecreated ASC , r.id ASC';
243         $html = data_get_advanced_search_sql('0', $this->recorddata, $newrecordids, '', $sortorder);
244         $allparams = array_merge($html['params'], array('dataid' => $this->recorddata->id));
245         $records = $DB->get_records_sql($html['sql'], $allparams);
246         $this->assertEquals($records, $this->finalrecord);
248         // Test 5
249         $groupsql = " AND (r.groupid = :currentgroup OR r.groupid = 0)";
250         $params = array('currentgroup' => 1);
251         $recordids = data_get_all_recordids($this->recorddata->id, $groupsql, $params);
252         $this->assertEquals($this->groupdatarecordcount, count($recordids));
254         // Test 6
255         $approvesql = ' AND r.approved=1 ';
256         $recordids = data_get_all_recordids($this->recorddata->id, $approvesql, $params);
257         $this->assertEquals($this->approvedatarecordcount, count($recordids));
258     }
260     public function test_advanced_search_tags() {
261         $this->resetAfterTest();
262         $this->setAdminUser();
264         // Setup test data.
265         $datagenerator = $this->getDataGenerator()->get_plugin_generator('mod_data');
266         $course1 = $this->getDataGenerator()->create_course();
268         $fieldrecord = new StdClass();
269         $fieldrecord->name = 'field-1';
270         $fieldrecord->type = 'text';
271         $fieldrecord->titlefield = true;
273         $data1 = $this->getDataGenerator()->create_module('data', array('course' => $course1->id, 'approval' => true));
274         $field1 = $datagenerator->create_field($fieldrecord, $data1);
276         $record11 = $datagenerator->create_entry($data1, [$field1->field->id => 'value11'], 0, ['Cats', 'Dogs']);
277         $record12 = $datagenerator->create_entry($data1, [$field1->field->id => 'value12'], 0, ['Cats', 'mice']);
278         $record13 = $datagenerator->create_entry($data1, [$field1->field->id => 'value13'], 0, ['Bats']);
280         $searcharray = [];
281         $searcharray[DATA_TAGS] = new stdClass();
282         $searcharray[DATA_TAGS]->params = [];
283         $searcharray[DATA_TAGS]->rawtagnames = ['Cats'];
284         $searcharray[DATA_TAGS]->sql = '';
286         $recordids = data_get_all_recordids($data1->id);
287         $newrecordids = data_get_advance_search_ids($recordids, $searcharray, $data1->id);
289         $this->assertContains($record11, $newrecordids);
290         $this->assertContains($record12, $newrecordids);
291         $this->assertNotContains($record13, $newrecordids);
292     }
294     /**
295      * Indexing database entries contents.
296      *
297      * @return void
298      */
299     public function test_data_entries_indexing() {
300         global $DB;
302         // Returns the instance as long as the area is supported.
303         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
304         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
306         $user1 = self::getDataGenerator()->create_user();
308         $course1 = self::getDataGenerator()->create_course();
310         $this->getDataGenerator()->enrol_user($user1->id, $course1->id, 'student');
312         $record = new stdClass();
313         $record->course = $course1->id;
315         $this->setUser($user1);
317         // Available for both student and teacher.
318         $data1 = $this->getDataGenerator()->create_module('data', $record);
320         // Excluding LatLong and Picture as we aren't indexing LatLong and Picture fields any way
321         // ...and they're complex and not of any use to consider for this test.
322         // Excluding File as we are indexing files seperately and its complex to implement.
323         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
325         $this->create_default_data_fields($fieldtypes, $data1);
327         $data1record1id = $this->create_default_data_record($data1);
328         // All records.
329         $recordset = $searcharea->get_recordset_by_timestamp(0);
331         $this->assertTrue($recordset->valid());
333         $nrecords = 0;
334         foreach ($recordset as $record) {
335             $this->assertInstanceOf('stdClass', $record);
336             $doc = $searcharea->get_document($record);
337             $this->assertInstanceOf('\core_search\document', $doc);
338             $nrecords++;
339         }
341         // If there would be an error/failure in the foreach above the recordset would be closed on shutdown.
342         $recordset->close();
343         $this->assertEquals(1, $nrecords);
345         // The +2 is to prevent race conditions.
346         $recordset = $searcharea->get_recordset_by_timestamp(time() + 2);
348         // No new records.
349         $this->assertFalse($recordset->valid());
350         $recordset->close();
351     }
353     /**
354      * Document contents.
355      *
356      * @return void
357      */
358     public function test_data_entries_document() {
359         global $DB;
361         // Returns the instance as long as the area is supported.
362         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
363         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
365         $user1 = self::getDataGenerator()->create_user();
367         $course = self::getDataGenerator()->create_course();
369         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
371         $record = new stdClass();
372         $record->course = $course->id;
374         $this->setAdminUser();
376         // First Case.
377         $data1 = $this->getDataGenerator()->create_module('data', $record);
379         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
381         $this->create_default_data_fields($fieldtypes, $data1);
383         $data1record1id = $this->create_default_data_record($data1);
385         $data1entry1 = $this->get_entry_for_id($data1record1id);
387         $data1doc = $searcharea->get_document($data1entry1);
389         $this->assertEquals($data1doc->get('courseid'), $course->id);
390         $this->assertEquals($data1doc->get('title'), 'text for testing');
391         $this->assertEquals($data1doc->get('content'), 'menu1');
392         $this->assertEquals($data1doc->get('description1'), 'radioopt1');
393         $this->assertEquals($data1doc->get('description2'), 'opt1 opt2 opt3 opt4 multimenu1 multimenu2 multimenu3 multimenu4 text area testing http://example.url');
395         // Second Case.
396         $data2 = $this->getDataGenerator()->create_module('data', $record);
398         $fieldtypes = array(
399                 array('checkbox', 1),
400                 array('textarea', 0),
401                 array('menu', 0),
402                 array('number', 1),
403                 array('url', 0),
404                 array('text', 0)
405         );
407         $this->create_default_data_fields($fieldtypes, $data2);
409         $data2record1id = $this->create_default_data_record($data2);
411         $data2entry1 = $this->get_entry_for_id($data2record1id);
413         $data2doc = $searcharea->get_document($data2entry1);
415         $this->assertEquals($data2doc->get('courseid'), $course->id);
416         $this->assertEquals($data2doc->get('title'), 'opt1 opt2 opt3 opt4');
417         $this->assertEquals($data2doc->get('content'), 'text for testing');
418         $this->assertEquals($data2doc->get('description1'), 'menu1');
419         $this->assertEquals($data2doc->get('description2'), 'text area testing http://example.url');
421         // Third Case.
422         $data3 = $this->getDataGenerator()->create_module('data', $record);
424         $fieldtypes = array( 'url' );
426         $this->create_default_data_fields($fieldtypes, $data3);
428         $data3record1id = $this->create_default_data_record($data3);
430         $data3entry1 = $this->get_entry_for_id($data3record1id);
432         $this->assertFalse($searcharea->get_document($data3entry1));
434         // Fourth Case.
435         $data4 = $this->getDataGenerator()->create_module('data', $record);
437         $fieldtypes = array( array('date', 1), array('text', 1));
439         $this->create_default_data_fields($fieldtypes, $data4);
441         $data4record1id = $this->create_default_data_record($data4);
443         $data4entry1 = $this->get_entry_for_id($data4record1id);
445         $this->assertFalse($searcharea->get_document($data4entry1));
447         // Fifth Case.
448         $data5 = $this->getDataGenerator()->create_module('data', $record);
450         $fieldtypes = array(
451                 array('checkbox', 0),
452                 array('number', 1),
453                 array('text', 0),
454                 array('date', 1),
455                 array('textarea', 0),
456                 array('url', 1));
458         $this->create_default_data_fields($fieldtypes, $data5);
460         $data5record1id = $this->create_default_data_record($data5);
462         $data5entry1 = $this->get_entry_for_id($data5record1id);
464         $data5doc = $searcharea->get_document($data5entry1);
466         $this->assertEquals($data5doc->get('courseid'), $course->id);
467         $this->assertEquals($data5doc->get('title'), 'http://example.url');
468         $this->assertEquals($data5doc->get('content'), 'text for testing');
469         $this->assertEquals($data5doc->get('description1'), 'opt1 opt2 opt3 opt4');
470         $this->assertEquals($data5doc->get('description2'), 'text area testing');
472         // Sixth Case.
473         $data6 = $this->getDataGenerator()->create_module('data', $record);
475         $fieldtypes = array( array('date', 1), array('number', 1));
477         $this->create_default_data_fields($fieldtypes, $data6);
479         $data6record1id = $this->create_default_data_record($data6);
481         $data6entry1 = $this->get_entry_for_id($data6record1id);
483         $data6doc = $searcharea->get_document($data6entry1);
485         $this->assertFalse($data6doc);
487         // Seventh Case.
488         $data7 = $this->getDataGenerator()->create_module('data', $record);
490         $fieldtypes = array( array('date', 1), array('number', 1),
491                 array('text', 0), array('textarea', 0));
493         $this->create_default_data_fields($fieldtypes, $data7);
495         $data7record1id = $this->create_default_data_record($data7);
497         $data7entry1 = $this->get_entry_for_id($data7record1id);
499         $data7doc = $searcharea->get_document($data7entry1);
501         $this->assertEquals($data7doc->get('courseid'), $course->id);
502         $this->assertEquals($data7doc->get('title'), 'text for testing');
503         $this->assertEquals($data7doc->get('content'), 'text area testing');
505         // Eight Case.
506         $data8 = $this->getDataGenerator()->create_module('data', $record);
508         $fieldtypes = array('url', 'url', 'url', 'text');
510         $this->create_default_data_fields($fieldtypes, $data8);
512         $data8record1id = $this->create_default_data_record($data8);
514         $data8entry1 = $this->get_entry_for_id($data8record1id);
516         $data8doc = $searcharea->get_document($data8entry1);
518         $this->assertEquals($data8doc->get('courseid'), $course->id);
519         $this->assertEquals($data8doc->get('title'), 'text for testing');
520         $this->assertEquals($data8doc->get('content'), 'http://example.url');
521         $this->assertEquals($data8doc->get('description1'), 'http://example.url');
522         $this->assertEquals($data8doc->get('description2'), 'http://example.url');
524         // Ninth Case.
525         $data9 = $this->getDataGenerator()->create_module('data', $record);
527         $fieldtypes = array('radiobutton', 'menu', 'multimenu');
529         $this->create_default_data_fields($fieldtypes, $data9);
531         $data9record1id = $this->create_default_data_record($data9);
533         $data9entry1 = $this->get_entry_for_id($data9record1id);
535         $data9doc = $searcharea->get_document($data9entry1);
537         $this->assertEquals($data9doc->get('courseid'), $course->id);
538         $this->assertEquals($data9doc->get('title'), 'radioopt1');
539         $this->assertEquals($data9doc->get('content'), 'menu1');
540         $this->assertEquals($data9doc->get('description1'), 'multimenu1 multimenu2 multimenu3 multimenu4');
542         // Tenth Case.
543         $data10 = $this->getDataGenerator()->create_module('data', $record);
545         $fieldtypes = array('checkbox', 'textarea', 'multimenu');
547         $this->create_default_data_fields($fieldtypes, $data10);
549         $data10record1id = $this->create_default_data_record($data10);
551         $data10entry1 = $this->get_entry_for_id($data10record1id);
553         $data10doc = $searcharea->get_document($data10entry1);
555         $this->assertEquals($data10doc->get('courseid'), $course->id);
556         $this->assertEquals($data10doc->get('title'), 'opt1 opt2 opt3 opt4');
557         $this->assertEquals($data10doc->get('content'), 'text area testing');
558         $this->assertEquals($data10doc->get('description1'), 'multimenu1 multimenu2 multimenu3 multimenu4');
560     }
562     /**
563      * Document accesses.
564      *
565      * @return void
566      */
567     public function test_data_entries_access() {
568         global $DB;
570         // Returns the instance as long as the area is supported.
571         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
572         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
574         $user1 = self::getDataGenerator()->create_user();
575         $user2 = self::getDataGenerator()->create_user();
576         $user3 = self::getDataGenerator()->create_user();
577         $userteacher1 = self::getDataGenerator()->create_user();
579         $course1 = self::getDataGenerator()->create_course();
580         $course2 = self::getDataGenerator()->create_course();
582         $this->getDataGenerator()->enrol_user($user1->id, $course1->id, 'student');
583         $this->getDataGenerator()->enrol_user($user2->id, $course1->id, 'student');
584         $this->getDataGenerator()->enrol_user($userteacher1->id, $course1->id, 'teacher');
586         $this->getDataGenerator()->enrol_user($user3->id, $course2->id, 'student');
588         $record = new stdClass();
589         $record->course = $course1->id;
591         $this->setUser($userteacher1);
593         $data1 = $this->getDataGenerator()->create_module('data', $record);
595         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
597         $this->create_default_data_fields($fieldtypes, $data1);
599         $this->setUser($user1);
600         $data1record1id = $this->create_default_data_record($data1);
602         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
603         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
605         $this->setUser($user2);
606         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
608         $this->setUser($user3);
609         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data1record1id));
611         $this->setUser($userteacher1);
612         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
614         $this->setAdminUser();
615         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
617         $this->setGuestUser();
618         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data1record1id));
620         // Case with groups.
621         $user1 = self::getDataGenerator()->create_user();
622         $user2 = self::getDataGenerator()->create_user();
623         $user3 = self::getDataGenerator()->create_user();
624         $userteacher1 = self::getDataGenerator()->create_user();
626         $course = self::getDataGenerator()->create_course(array('groupmode' => 1, 'groupmodeforce' => 1));
628         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
629         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student');
630         $this->getDataGenerator()->enrol_user($userteacher1->id, $course->id, 'teacher');
631         $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'student');
633         $groupa = $this->getDataGenerator()->create_group(array('courseid' => $course->id, 'name' => 'groupA'));
634         $groupb = $this->getDataGenerator()->create_group(array('courseid' => $course->id, 'name' => 'groupB'));
636         $this->getDataGenerator()->create_group_member(array('userid' => $user1->id, 'groupid' => $groupa->id));
637         $this->getDataGenerator()->create_group_member(array('userid' => $user2->id, 'groupid' => $groupa->id));
638         $this->getDataGenerator()->create_group_member(array('userid' => $userteacher1->id, 'groupid' => $groupa->id));
640         $this->getDataGenerator()->create_group_member(array('userid' => $user3->id, 'groupid' => $groupb->id));
642         $record = new stdClass();
643         $record->course = $course->id;
645         $this->setUser($userteacher1);
647         $data2 = $this->getDataGenerator()->create_module('data', $record);
649         $cm = get_coursemodule_from_instance('data', $data2->id, $course->id);
650         $cm->groupmode = '1';
651         $cm->effectivegroupmode = '1';
653         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
655         $this->create_default_data_fields($fieldtypes, $data2);
657         $this->setUser($user1);
659         $data2record1id = $this->create_default_data_record($data2, $groupa->id);
661         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
662         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
664         $this->setUser($user2);
665         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
667         $this->setUser($user3);
668         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data2record1id));
670         $this->setUser($userteacher1);
671         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
673         $this->setAdminUser();
674         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
676         $this->setGuestUser();
677         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data2record1id));
679         // Case with approval.
680         $user1 = self::getDataGenerator()->create_user();
681         $user2 = self::getDataGenerator()->create_user();
682         $userteacher1 = self::getDataGenerator()->create_user();
684         $course = self::getDataGenerator()->create_course();
686         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
687         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student');
688         $this->getDataGenerator()->enrol_user($userteacher1->id, $course->id, 'teacher');
690         $record = new stdClass();
691         $record->course = $course->id;
693         $this->setUser($userteacher1);
695         $data3 = $this->getDataGenerator()->create_module('data', $record);
697         $DB->update_record('data', array('id' => $data3->id, 'approval' => 1));
699         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
701         $this->create_default_data_fields($fieldtypes, $data3);
703         $this->setUser($user1);
705         $data3record1id = $this->create_default_data_record($data3);
707         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
708         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
710         $this->setUser($user2);
711         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data3record1id));
713         $this->setUser($userteacher1);
714         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
716         $this->setAdminUser();
717         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
719         $this->setGuestUser();
720         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data3record1id));
722         $DB->update_record('data_records', array('id' => $data3record1id, 'approved' => 1));
724         $this->setUser($user1);
725         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
726         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
728         $this->setUser($user2);
729         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
731         $this->setUser($userteacher1);
732         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
734         $this->setAdminUser();
735         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
737         $this->setGuestUser();
738         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data3record1id));
740         // Case with requiredentriestoview.
741         $this->setAdminUser();
743         $record->requiredentriestoview = 2;
745         $data4 = $this->getDataGenerator()->create_module('data', $record);
746         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
748         $this->create_default_data_fields($fieldtypes, $data4);
750         $data4record1id = $this->create_default_data_record($data4);
752         $this->setUser($user1);
753         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data4record1id));
755         $data4record2id = $this->create_default_data_record($data4);
756         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data4record1id));
757         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data4record2id));
758     }
760     /**
761      * Test for file contents.
762      *
763      * @return void
764      */
765     public function test_attach_files() {
766         global $DB, $USER;
768         $fs = get_file_storage();
770         // Returns the instance as long as the area is supported.
771         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
772         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
774         $user1 = self::getDataGenerator()->create_user();
776         $course = self::getDataGenerator()->create_course();
778         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
780         $record = new stdClass();
781         $record->course = $course->id;
783         $this->setAdminUser();
785         // Creating database activity instance.
786         $data1 = $this->getDataGenerator()->create_module('data', $record);
788         // Creating file field.
789         $record = new stdClass;
790         $record->type = 'file';
791         $record->dataid = $data1->id;
792         $record->required = 0;
793         $record->name = 'FileFld';
794         $record->description = 'Just another file field';
795         $record->param3 = 0;
796         $record->param1 = '';
797         $record->param2 = '';
799         $data1filefieldid = $DB->insert_record('data_fields', $record);
801         // Creating text field.
802         $record = new stdClass;
803         $record->type = 'text';
804         $record->dataid = $data1->id;
805         $record->required = 0;
806         $record->name = 'TextFld';
807         $record->description = 'Just another text field';
808         $record->param3 = 0;
809         $record->param1 = '';
810         $record->param2 = '';
812         $data1textfieldid = $DB->insert_record('data_fields', $record);
814         // Creating textarea field.
815         $record = new stdClass;
816         $record->type = 'textarea';
817         $record->dataid = $data1->id;
818         $record->required = 0;
819         $record->name = 'TextAreaFld';
820         $record->description = 'Just another textarea field';
821         $record->param1 = '';
822         $record->param2 = 60;
823         $record->param3 = 35;
824         $record->param3 = 1;
825         $record->param3 = 0;
827         $data1textareafieldid = $DB->insert_record('data_fields', $record);
829         // Creating 1st entry.
830         $record = new stdClass;
831         $record->userid = $USER->id;
832         $record->dataid = $data1->id;
833         $record->groupid = 0;
835         $data1record1id = $DB->insert_record('data_records', $record);
837         $filerecord = array(
838                 'contextid' => context_module::instance($data1->cmid)->id,
839                 'component' => 'mod_data',
840                 'filearea'  => 'content',
841                 'itemid'    => $data1record1id,
842                 'filepath'  => '/',
843                 'filename'  => 'myfile1.txt'
844         );
846         $data1record1file = $fs->create_file_from_string($filerecord, 'Some contents 1');
848         $record = new stdClass;
849         $record->fieldid = $data1filefieldid;
850         $record->recordid = $data1record1id;
851         $record->content = 'myfile1.txt';
852         $DB->insert_record('data_content', $record);
854         $record = new stdClass;
855         $record->fieldid = $data1textfieldid;
856         $record->recordid = $data1record1id;
857         $record->content = 'sample text';
858         $DB->insert_record('data_content', $record);
860         $record = new stdClass;
861         $record->fieldid = $data1textareafieldid;
862         $record->recordid = $data1record1id;
863         $record->content = '<br>sample text<p /><br/>';
864         $record->content1 = 1;
865         $DB->insert_record('data_content', $record);
867         // Creating 2nd entry.
868         $record = new stdClass;
869         $record->userid = $USER->id;
870         $record->dataid = $data1->id;
871         $record->groupid = 0;
872         $data1record2id = $DB->insert_record('data_records', $record);
874         $filerecord['itemid'] = $data1record2id;
875         $filerecord['filename'] = 'myfile2.txt';
876         $data1record2file = $fs->create_file_from_string($filerecord, 'Some contents 2');
878         $record = new stdClass;
879         $record->fieldid = $data1filefieldid;
880         $record->recordid = $data1record2id;
881         $record->content = 'myfile2.txt';
882         $DB->insert_record('data_content', $record);
884         $record = new stdClass;
885         $record->fieldid = $data1textfieldid;
886         $record->recordid = $data1record2id;
887         $record->content = 'sample text';
888         $DB->insert_record('data_content', $record);
890         $record = new stdClass;
891         $record->fieldid = $data1textareafieldid;
892         $record->recordid = $data1record2id;
893         $record->content = '<br>sample text<p /><br/>';
894         $record->content1 = 1;
895         $DB->insert_record('data_content', $record);
897         // Now get all the posts and see if they have the right files attached.
898         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
899         $recordset = $searcharea->get_recordset_by_timestamp(0);
900         $nrecords = 0;
901         foreach ($recordset as $record) {
902             $doc = $searcharea->get_document($record);
903             $searcharea->attach_files($doc);
904             $files = $doc->get_files();
905             // Now check that each doc has the right files on it.
906             switch ($doc->get('itemid')) {
907                 case ($data1record1id):
908                     $this->assertCount(1, $files);
909                     $this->assertEquals($data1record1file->get_id(), $files[$data1record1file->get_id()]->get_id());
910                     break;
911                 case ($data1record2id):
912                     $this->assertCount(1, $files);
913                     $this->assertEquals($data1record2file->get_id(), $files[$data1record2file->get_id()]->get_id());
914                     break;
915                 default:
916                     $this->fail('Unexpected entry returned');
917                     break;
918             }
919             $nrecords++;
920         }
921         $recordset->close();
922         $this->assertEquals(2, $nrecords);
923     }
925     /**
926      * Creates default fields for a database instance
927      *
928      * @param array $fieldtypes
929      * @param mod_data $data
930      * @return void
931      */
932     protected function create_default_data_fields($fieldtypes = array(), $data) {
933         $count = 1;
935         // Creating test Fields with default parameter values.
936         foreach ($fieldtypes as $fieldtype) {
938             // Creating variables dynamically.
939             $fieldname = 'field-'.$count;
940             $record = new stdClass();
941             $record->name = $fieldname;
943             if (is_array($fieldtype)) {
944                 $record->type = $fieldtype[0];
945                 $record->required = $fieldtype[1];
946             } else {
947                 $record->type = $fieldtype;
948                 $record->required = 0;
949             }
951             ${$fieldname} = $this->getDataGenerator()->get_plugin_generator('mod_data')->create_field($record, $data);
952             $count++;
953         }
954     }
956     /**
957      * Creates default database entry content values for default field param values
958      *
959      * @param mod_data $data
960      * @param int $groupid
961      * @return int
962      */
963     protected function create_default_data_record($data, $groupid = 0) {
964         global $DB;
966         $fields = $DB->get_records('data_fields', array('dataid' => $data->id));
968         $fieldcontents = array();
969         foreach ($fields as $fieldrecord) {
970             switch ($fieldrecord->type) {
971                 case 'checkbox':
972                     $fieldcontents[$fieldrecord->id] = array('opt1', 'opt2', 'opt3', 'opt4');
973                     break;
975                 case 'multimenu':
976                     $fieldcontents[$fieldrecord->id] = array('multimenu1', 'multimenu2', 'multimenu3', 'multimenu4');
977                     break;
979                 case 'date':
980                     $fieldcontents[$fieldrecord->id] = '27-07-2016';
981                     break;
983                 case 'menu':
984                     $fieldcontents[$fieldrecord->id] = 'menu1';
985                     break;
987                 case 'radiobutton':
988                     $fieldcontents[$fieldrecord->id] = 'radioopt1';
989                     break;
991                 case 'number':
992                     $fieldcontents[$fieldrecord->id] = '12345';
993                     break;
995                 case 'text':
996                     $fieldcontents[$fieldrecord->id] = 'text for testing';
997                     break;
999                 case 'textarea':
1000                     $fieldcontents[$fieldrecord->id] = '<p>text area testing<br /></p>';
1001                     break;
1003                 case 'url':
1004                     $fieldcontents[$fieldrecord->id] = array('example.url', 'sampleurl');
1005                     break;
1007                 default:
1008                     $this->fail('Unexpected field type');
1009                     break;
1010             }
1012         }
1014         return $this->getDataGenerator()->get_plugin_generator('mod_data')->create_entry($data, $fieldcontents, $groupid);
1015     }
1017     /**
1018      * Creates default database entry content values for default field param values
1019      *
1020      * @param int $recordid
1021      * @return stdClass
1022      */
1023     protected function get_entry_for_id($recordid ) {
1024         global $DB;
1026         $sql = "SELECT dr.*, d.course
1027                   FROM {data_records} dr
1028                   JOIN {data} d ON d.id = dr.dataid
1029                  WHERE dr.id = :drid";
1030         return $DB->get_record_sql($sql, array('drid' => $recordid));
1031     }