ee6b073ddae92ddf6f4c3bcfa9da31eea9e5888f
[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     /**
261      * Indexing database entries contents.
262      *
263      * @return void
264      */
265     public function test_data_entries_indexing() {
266         global $DB;
268         // Returns the instance as long as the area is supported.
269         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
270         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
272         $user1 = self::getDataGenerator()->create_user();
274         $course1 = self::getDataGenerator()->create_course();
276         $this->getDataGenerator()->enrol_user($user1->id, $course1->id, 'student');
278         $record = new stdClass();
279         $record->course = $course1->id;
281         $this->setUser($user1);
283         // Available for both student and teacher.
284         $data1 = $this->getDataGenerator()->create_module('data', $record);
286         // Excluding LatLong and Picture as we aren't indexing LatLong and Picture fields any way
287         // ...and they're complex and not of any use to consider for this test.
288         // Excluding File as we are indexing files seperately and its complex to implement.
289         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
291         $this->create_default_data_fields($fieldtypes, $data1);
293         $data1record1id = $this->create_default_data_record($data1);
294         // All records.
295         $recordset = $searcharea->get_recordset_by_timestamp(0);
297         $this->assertTrue($recordset->valid());
299         $nrecords = 0;
300         foreach ($recordset as $record) {
301             $this->assertInstanceOf('stdClass', $record);
302             $doc = $searcharea->get_document($record);
303             $this->assertInstanceOf('\core_search\document', $doc);
304             $nrecords++;
305         }
307         // If there would be an error/failure in the foreach above the recordset would be closed on shutdown.
308         $recordset->close();
309         $this->assertEquals(1, $nrecords);
311         // The +2 is to prevent race conditions.
312         $recordset = $searcharea->get_recordset_by_timestamp(time() + 2);
314         // No new records.
315         $this->assertFalse($recordset->valid());
316         $recordset->close();
317     }
319     /**
320      * Document contents.
321      *
322      * @return void
323      */
324     public function test_data_entries_document() {
325         global $DB;
327         // Returns the instance as long as the area is supported.
328         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
329         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
331         $user1 = self::getDataGenerator()->create_user();
333         $course = self::getDataGenerator()->create_course();
335         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
337         $record = new stdClass();
338         $record->course = $course->id;
340         $this->setAdminUser();
342         // First Case.
343         $data1 = $this->getDataGenerator()->create_module('data', $record);
345         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
347         $this->create_default_data_fields($fieldtypes, $data1);
349         $data1record1id = $this->create_default_data_record($data1);
351         $data1entry1 = $this->get_entry_for_id($data1record1id);
353         $data1doc = $searcharea->get_document($data1entry1);
355         $this->assertEquals($data1doc->get('courseid'), $course->id);
356         $this->assertEquals($data1doc->get('title'), 'text for testing');
357         $this->assertEquals($data1doc->get('content'), 'menu1');
358         $this->assertEquals($data1doc->get('description1'), 'opt1');
359         $this->assertEquals($data1doc->get('description2'), 'opt1 opt2 opt3 opt4');
361         // Second Case.
362         $data2 = $this->getDataGenerator()->create_module('data', $record);
364         $fieldtypes = array(
365                 array('checkbox', 1),
366                 array('textarea', 0),
367                 array('menu', 0),
368                 array('number', 1),
369                 array('url', 0),
370                 array('text', 0)
371         );
373         $this->create_default_data_fields($fieldtypes, $data2);
375         $data2record1id = $this->create_default_data_record($data2);
377         $data2entry1 = $this->get_entry_for_id($data2record1id);
379         $data2doc = $searcharea->get_document($data2entry1);
381         $this->assertEquals($data2doc->get('courseid'), $course->id);
382         $this->assertEquals($data2doc->get('title'), 'opt1 opt2 opt3 opt4');
383         $this->assertEquals($data2doc->get('content'), 'text for testing');
384         $this->assertEquals($data2doc->get('description1'), 'menu1');
385         $this->assertEquals($data2doc->get('description2'), 'text area testing');
387         // Third Case.
388         $data3 = $this->getDataGenerator()->create_module('data', $record);
390         $fieldtypes = array( 'url' );
392         $this->create_default_data_fields($fieldtypes, $data3);
394         $data3record1id = $this->create_default_data_record($data3);
396         $data3entry1 = $this->get_entry_for_id($data3record1id);
398         $this->assertFalse($searcharea->get_document($data3entry1));
400         // Fourth Case.
401         $data4 = $this->getDataGenerator()->create_module('data', $record);
403         $fieldtypes = array( array('date', 1), array('text', 1));
405         $this->create_default_data_fields($fieldtypes, $data4);
407         $data4record1id = $this->create_default_data_record($data4);
409         $data4entry1 = $this->get_entry_for_id($data4record1id);
411         $this->assertFalse($searcharea->get_document($data4entry1));
413         // Fifth Case.
414         $data5 = $this->getDataGenerator()->create_module('data', $record);
416         $fieldtypes = array(
417                 array('checkbox', 0),
418                 array('number', 1),
419                 array('text', 0),
420                 array('date', 1),
421                 array('textarea', 0),
422                 array('url', 1));
424         $this->create_default_data_fields($fieldtypes, $data5);
426         $data5record1id = $this->create_default_data_record($data5);
428         $data5entry1 = $this->get_entry_for_id($data5record1id);
430         $data5doc = $searcharea->get_document($data5entry1);
432         $this->assertEquals($data5doc->get('courseid'), $course->id);
433         $this->assertEquals($data5doc->get('title'), 'http://example.url');
434         $this->assertEquals($data5doc->get('content'), 'text for testing');
435         $this->assertEquals($data5doc->get('description1'), 'opt1 opt2 opt3 opt4');
436         $this->assertEquals($data5doc->get('description2'), 'text area testing');
438         // Sixth Case.
439         $data6 = $this->getDataGenerator()->create_module('data', $record);
441         $fieldtypes = array( array('date', 1), array('number', 1));
443         $this->create_default_data_fields($fieldtypes, $data6);
445         $data6record1id = $this->create_default_data_record($data6);
447         $data6entry1 = $this->get_entry_for_id($data6record1id);
449         $data6doc = $searcharea->get_document($data6entry1);
451         $this->assertFalse($data6doc);
453         // Seventh Case.
454         $data7 = $this->getDataGenerator()->create_module('data', $record);
456         $fieldtypes = array( array('date', 1), array('number', 1),
457                 array('text', 0), array('textarea', 0));
459         $this->create_default_data_fields($fieldtypes, $data7);
461         $data7record1id = $this->create_default_data_record($data7);
463         $data7entry1 = $this->get_entry_for_id($data7record1id);
465         $data7doc = $searcharea->get_document($data7entry1);
467         $this->assertEquals($data7doc->get('courseid'), $course->id);
468         $this->assertEquals($data7doc->get('title'), 'text for testing');
469         $this->assertEquals($data7doc->get('content'), 'text area testing');
471         // Eight Case.
472         $data8 = $this->getDataGenerator()->create_module('data', $record);
474         $fieldtypes = array('url', 'url', 'url', 'text');
476         $this->create_default_data_fields($fieldtypes, $data8);
478         $data8record1id = $this->create_default_data_record($data8);
480         $data8entry1 = $this->get_entry_for_id($data8record1id);
482         $data8doc = $searcharea->get_document($data8entry1);
484         $this->assertEquals($data8doc->get('courseid'), $course->id);
485         $this->assertEquals($data8doc->get('title'), 'text for testing');
486         $this->assertEquals($data8doc->get('content'), 'http://example.url');
487         $this->assertEquals($data8doc->get('description1'), 'http://example.url');
488         $this->assertEquals($data8doc->get('description2'), 'http://example.url');
490         // Ninth Case.
491         $data9 = $this->getDataGenerator()->create_module('data', $record);
493         $fieldtypes = array('radiobutton', 'menu', 'multimenu');
495         $this->create_default_data_fields($fieldtypes, $data9);
497         $data9record1id = $this->create_default_data_record($data9);
499         $data9entry1 = $this->get_entry_for_id($data9record1id);
501         $data9doc = $searcharea->get_document($data9entry1);
503         $this->assertEquals($data9doc->get('courseid'), $course->id);
504         $this->assertEquals($data9doc->get('title'), 'opt1');
505         $this->assertEquals($data9doc->get('content'), 'menu1');
506         $this->assertEquals($data9doc->get('description1'), 'menu1 menu2 menu3 menu4');
508         // Tenth Case.
509         $data10 = $this->getDataGenerator()->create_module('data', $record);
511         $fieldtypes = array('checkbox', 'textarea', 'multimenu');
513         $this->create_default_data_fields($fieldtypes, $data10);
515         $data10record1id = $this->create_default_data_record($data10);
517         $data10entry1 = $this->get_entry_for_id($data10record1id);
519         $data10doc = $searcharea->get_document($data10entry1);
521         $this->assertEquals($data10doc->get('courseid'), $course->id);
522         $this->assertEquals($data10doc->get('title'), 'opt1 opt2 opt3 opt4');
523         $this->assertEquals($data10doc->get('content'), 'text area testing');
524         $this->assertEquals($data10doc->get('description1'), 'menu1 menu2 menu3 menu4');
526     }
528     /**
529      * Document accesses.
530      *
531      * @return void
532      */
533     public function test_data_entries_access() {
534         global $DB;
536         // Returns the instance as long as the area is supported.
537         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
538         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
540         $user1 = self::getDataGenerator()->create_user();
541         $user2 = self::getDataGenerator()->create_user();
542         $user3 = self::getDataGenerator()->create_user();
543         $userteacher1 = self::getDataGenerator()->create_user();
545         $course1 = self::getDataGenerator()->create_course();
546         $course2 = self::getDataGenerator()->create_course();
548         $this->getDataGenerator()->enrol_user($user1->id, $course1->id, 'student');
549         $this->getDataGenerator()->enrol_user($user2->id, $course1->id, 'student');
550         $this->getDataGenerator()->enrol_user($userteacher1->id, $course1->id, 'teacher');
552         $this->getDataGenerator()->enrol_user($user3->id, $course2->id, 'student');
554         $record = new stdClass();
555         $record->course = $course1->id;
557         $this->setUser($userteacher1);
559         $data1 = $this->getDataGenerator()->create_module('data', $record);
561         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
563         $this->create_default_data_fields($fieldtypes, $data1);
565         $this->setUser($user1);
566         $data1record1id = $this->create_default_data_record($data1);
568         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
569         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
571         $this->setUser($user2);
572         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
574         $this->setUser($user3);
575         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data1record1id));
577         $this->setUser($userteacher1);
578         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
580         $this->setAdminUser();
581         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data1record1id));
583         $this->setGuestUser();
584         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data1record1id));
586         // Case with groups.
587         $user1 = self::getDataGenerator()->create_user();
588         $user2 = self::getDataGenerator()->create_user();
589         $user3 = self::getDataGenerator()->create_user();
590         $userteacher1 = self::getDataGenerator()->create_user();
592         $course = self::getDataGenerator()->create_course(array('groupmode' => 1, 'groupmodeforce' => 1));
594         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
595         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student');
596         $this->getDataGenerator()->enrol_user($userteacher1->id, $course->id, 'teacher');
597         $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'student');
599         $groupa = $this->getDataGenerator()->create_group(array('courseid' => $course->id, 'name' => 'groupA'));
600         $groupb = $this->getDataGenerator()->create_group(array('courseid' => $course->id, 'name' => 'groupB'));
602         $this->getDataGenerator()->create_group_member(array('userid' => $user1->id, 'groupid' => $groupa->id));
603         $this->getDataGenerator()->create_group_member(array('userid' => $user2->id, 'groupid' => $groupa->id));
604         $this->getDataGenerator()->create_group_member(array('userid' => $userteacher1->id, 'groupid' => $groupa->id));
606         $this->getDataGenerator()->create_group_member(array('userid' => $user3->id, 'groupid' => $groupb->id));
608         $record = new stdClass();
609         $record->course = $course->id;
611         $this->setUser($userteacher1);
613         $data2 = $this->getDataGenerator()->create_module('data', $record);
615         $cm = get_coursemodule_from_instance('data', $data2->id, $course->id);
616         $cm->groupmode = '1';
617         $cm->effectivegroupmode = '1';
619         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
621         $this->create_default_data_fields($fieldtypes, $data2);
623         $this->setUser($user1);
625         $data2record1id = $this->create_default_data_record($data2, $groupa->id);
627         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
628         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
630         $this->setUser($user2);
631         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
633         $this->setUser($user3);
634         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data2record1id));
636         $this->setUser($userteacher1);
637         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
639         $this->setAdminUser();
640         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data2record1id));
642         $this->setGuestUser();
643         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data2record1id));
645         // Case with approval.
646         $user1 = self::getDataGenerator()->create_user();
647         $user2 = self::getDataGenerator()->create_user();
648         $userteacher1 = self::getDataGenerator()->create_user();
650         $course = self::getDataGenerator()->create_course();
652         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
653         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student');
654         $this->getDataGenerator()->enrol_user($userteacher1->id, $course->id, 'teacher');
656         $record = new stdClass();
657         $record->course = $course->id;
659         $this->setUser($userteacher1);
661         $data3 = $this->getDataGenerator()->create_module('data', $record);
663         $DB->update_record('data', array('id' => $data3->id, 'approval' => 1));
665         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
667         $this->create_default_data_fields($fieldtypes, $data3);
669         $this->setUser($user1);
671         $data3record1id = $this->create_default_data_record($data3);
673         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
674         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
676         $this->setUser($user2);
677         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data3record1id));
679         $this->setUser($userteacher1);
680         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
682         $this->setAdminUser();
683         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
685         $this->setGuestUser();
686         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data3record1id));
688         $DB->update_record('data_records', array('id' => $data3record1id, 'approved' => 1));
690         $this->setUser($user1);
691         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
692         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-1));
694         $this->setUser($user2);
695         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
697         $this->setUser($userteacher1);
698         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
700         $this->setAdminUser();
701         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data3record1id));
703         $this->setGuestUser();
704         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data3record1id));
706         // Case with requiredentriestoview.
707         $this->setAdminUser();
709         $record->requiredentriestoview = 2;
711         $data4 = $this->getDataGenerator()->create_module('data', $record);
712         $fieldtypes = array( 'checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url' );
714         $this->create_default_data_fields($fieldtypes, $data4);
716         $data4record1id = $this->create_default_data_record($data4);
718         $this->setUser($user1);
719         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($data4record1id));
721         $data4record2id = $this->create_default_data_record($data4);
722         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data4record1id));
723         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($data4record2id));
724     }
726     /**
727      * Test for file contents.
728      *
729      * @return void
730      */
731     public function test_attach_files() {
732         global $DB, $USER;
734         $fs = get_file_storage();
736         // Returns the instance as long as the area is supported.
737         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
738         $this->assertInstanceOf('\mod_data\search\entry', $searcharea);
740         $user1 = self::getDataGenerator()->create_user();
742         $course = self::getDataGenerator()->create_course();
744         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
746         $record = new stdClass();
747         $record->course = $course->id;
749         $this->setAdminUser();
751         // Creating database activity instance.
752         $data1 = $this->getDataGenerator()->create_module('data', $record);
754         // Creating file field.
755         $record = new stdClass;
756         $record->type = 'file';
757         $record->dataid = $data1->id;
758         $record->required = 0;
759         $record->name = 'FileFld';
760         $record->description = 'Just another file field';
761         $record->param3 = 0;
762         $record->param1 = '';
763         $record->param2 = '';
765         $data1filefieldid = $DB->insert_record('data_fields', $record);
767         // Creating text field.
768         $record = new stdClass;
769         $record->type = 'text';
770         $record->dataid = $data1->id;
771         $record->required = 0;
772         $record->name = 'TextFld';
773         $record->description = 'Just another text field';
774         $record->param3 = 0;
775         $record->param1 = '';
776         $record->param2 = '';
778         $data1textfieldid = $DB->insert_record('data_fields', $record);
780         // Creating textarea field.
781         $record = new stdClass;
782         $record->type = 'textarea';
783         $record->dataid = $data1->id;
784         $record->required = 0;
785         $record->name = 'TextAreaFld';
786         $record->description = 'Just another textarea field';
787         $record->param1 = '';
788         $record->param2 = 60;
789         $record->param3 = 35;
790         $record->param3 = 1;
791         $record->param3 = 0;
793         $data1textareafieldid = $DB->insert_record('data_fields', $record);
795         // Creating 1st entry.
796         $record = new stdClass;
797         $record->userid = $USER->id;
798         $record->dataid = $data1->id;
799         $record->groupid = 0;
801         $data1record1id = $DB->insert_record('data_records', $record);
803         $filerecord = array(
804                 'contextid' => context_module::instance($data1->cmid)->id,
805                 'component' => 'mod_data',
806                 'filearea'  => 'content',
807                 'itemid'    => $data1record1id,
808                 'filepath'  => '/',
809                 'filename'  => 'myfile1.txt'
810         );
812         $data1record1file = $fs->create_file_from_string($filerecord, 'Some contents 1');
814         $record = new stdClass;
815         $record->fieldid = $data1filefieldid;
816         $record->recordid = $data1record1id;
817         $record->content = 'myfile1.txt';
818         $DB->insert_record('data_content', $record);
820         $record = new stdClass;
821         $record->fieldid = $data1textfieldid;
822         $record->recordid = $data1record1id;
823         $record->content = 'sample text';
824         $DB->insert_record('data_content', $record);
826         $record = new stdClass;
827         $record->fieldid = $data1textareafieldid;
828         $record->recordid = $data1record1id;
829         $record->content = '<br>sample text<p /><br/>';
830         $record->content1 = 1;
831         $DB->insert_record('data_content', $record);
833         // Creating 2nd entry.
834         $record = new stdClass;
835         $record->userid = $USER->id;
836         $record->dataid = $data1->id;
837         $record->groupid = 0;
838         $data1record2id = $DB->insert_record('data_records', $record);
840         $filerecord['itemid'] = $data1record2id;
841         $filerecord['filename'] = 'myfile2.txt';
842         $data1record2file = $fs->create_file_from_string($filerecord, 'Some contents 2');
844         $record = new stdClass;
845         $record->fieldid = $data1filefieldid;
846         $record->recordid = $data1record2id;
847         $record->content = 'myfile2.txt';
848         $DB->insert_record('data_content', $record);
850         $record = new stdClass;
851         $record->fieldid = $data1textfieldid;
852         $record->recordid = $data1record2id;
853         $record->content = 'sample text';
854         $DB->insert_record('data_content', $record);
856         $record = new stdClass;
857         $record->fieldid = $data1textareafieldid;
858         $record->recordid = $data1record2id;
859         $record->content = '<br>sample text<p /><br/>';
860         $record->content1 = 1;
861         $DB->insert_record('data_content', $record);
863         // Now get all the posts and see if they have the right files attached.
864         $searcharea = \core_search\manager::get_search_area($this->databaseentryareaid);
865         $recordset = $searcharea->get_recordset_by_timestamp(0);
866         $nrecords = 0;
867         foreach ($recordset as $record) {
868             $doc = $searcharea->get_document($record);
869             $searcharea->attach_files($doc);
870             $files = $doc->get_files();
871             // Now check that each doc has the right files on it.
872             switch ($doc->get('itemid')) {
873                 case ($data1record1id):
874                     $this->assertCount(1, $files);
875                     $this->assertEquals($data1record1file->get_id(), $files[$data1record1file->get_id()]->get_id());
876                     break;
877                 case ($data1record2id):
878                     $this->assertCount(1, $files);
879                     $this->assertEquals($data1record2file->get_id(), $files[$data1record2file->get_id()]->get_id());
880                     break;
881                 default:
882                     $this->fail('Unexpected entry returned');
883                     break;
884             }
885             $nrecords++;
886         }
887         $recordset->close();
888         $this->assertEquals(2, $nrecords);
889     }
891     /**
892      * Creates default fields for a database instance
893      *
894      * @param array $fieldtypes
895      * @param mod_data $data
896      * @return void
897      */
898     protected function create_default_data_fields($fieldtypes = array(), $data) {
899         $count = 1;
901         // Creating test Fields with default parameter values.
902         foreach ($fieldtypes as $fieldtype) {
904             // Creating variables dynamically.
905             $fieldname = 'field-'.$count;
906             $record = new stdClass();
907             $record->name = $fieldname;
909             if (is_array($fieldtype)) {
910                 $record->type = $fieldtype[0];
911                 $record->required = $fieldtype[1];
912             } else {
913                 $record->type = $fieldtype;
914                 $record->required = 0;
915             }
917             ${$fieldname} = $this->getDataGenerator()->get_plugin_generator('mod_data')->create_field($record, $data);
918             $count++;
919         }
920     }
922     /**
923      * Creates default database entry content values for default field param values
924      *
925      * @param mod_data $data
926      * @param int $groupid
927      * @return int
928      */
929     protected function create_default_data_record($data, $groupid = 0) {
930         global $DB;
932         $fields = $DB->get_records('data_fields', array('dataid' => $data->id));
934         $fieldcontents = array();
935         foreach ($fields as $fieldrecord) {
936             switch ($fieldrecord->type) {
937                 case 'checkbox':
938                     $fieldcontents[$fieldrecord->id] = array('opt1', 'opt2', 'opt3', 'opt4');
939                     break;
941                 case 'multimenu':
942                     $fieldcontents[$fieldrecord->id] = array('menu1', 'menu2', 'menu3', 'menu4');
943                     break;
945                 case 'date':
946                     $fieldcontents[$fieldrecord->id] = '27-07-2016';
947                     break;
949                 case 'menu':
950                     $fieldcontents[$fieldrecord->id] = 'menu1';
951                     break;
953                 case 'radiobutton':
954                     $fieldcontents[$fieldrecord->id] = 'opt1';
955                     break;
957                 case 'number':
958                     $fieldcontents[$fieldrecord->id] = '12345';
959                     break;
961                 case 'text':
962                     $fieldcontents[$fieldrecord->id] = 'text for testing';
963                     break;
965                 case 'textarea':
966                     $fieldcontents[$fieldrecord->id] = '<p>text area testing<br /></p>';
967                     break;
969                 case 'url':
970                     $fieldcontents[$fieldrecord->id] = array('example.url', 'sampleurl');
971                     break;
973                 default:
974                     $this->fail('Unexpected field type');
975                     break;
976             }
978         }
980         return $this->getDataGenerator()->get_plugin_generator('mod_data')->create_entry($data, $fieldcontents, $groupid);
981     }
983     /**
984      * Creates default database entry content values for default field param values
985      *
986      * @param int $recordid
987      * @return stdClass
988      */
989     protected function get_entry_for_id($recordid ) {
990         global $DB;
992         $sql = "SELECT dr.*, d.course
993                   FROM {data_records} dr
994                   JOIN {data} d ON d.id = dr.dataid
995                  WHERE dr.id = :drid";
996         return $DB->get_record_sql($sql, array('drid' => $recordid));
997     }