MDL-55127 mod_data: Search entries fixes
[moodle.git] / mod / data / classes / search / entry.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  * Search area for mod_data activity entries.
19  *
20  * @package    mod_data
21  * @copyright  2016 Devang Gaur
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace mod_data\search;
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/mod/data/lib.php');
30 require_once($CFG->dirroot . '/lib/grouplib.php');
32 /**
33  * Search area for mod_data activity entries.
34  *
35  * @package    mod_data
36  * @copyright  2016 Devang Gaur
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class entry extends \core_search\base_mod {
41     /**
42      * @var array Internal quick static cache.
43      */
44     protected $entriesdata = array();
46     /**
47      * Returns recordset containing required data for indexing database entries.
48      *
49      * @param int $modifiedfrom timestamp
50      * @return moodle_recordset
51      */
52     public function get_recordset_by_timestamp($modifiedfrom = 0) {
53         global $DB;
55         $sql = "SELECT dr.*, d.course
56                   FROM {data_records} dr
57                   JOIN {data} d ON d.id = dr.dataid
58                  WHERE dr.timemodified >= :timemodified";
59         return $DB->get_recordset_sql($sql, array('timemodified' => $modifiedfrom));
60     }
62     /**
63      * Returns the documents associated with this glossary entry id.
64      *
65      * @param stdClass $entry glossary entry.
66      * @param array    $options
67      * @return \core_search\document
68      */
69     public function get_document($entry, $options = array()) {
70         global $DB;
72         try {
73             $cm = $this->get_cm('data', $entry->dataid, $entry->course);
74             $context = \context_module::instance($cm->id);
75         } catch (\dml_missing_record_exception $ex) {
76             // Notify it as we run here as admin, we should see everything.
77             debugging('Error retrieving mod_data ' . $entry->id . ' document, not all required data is available: ' .
78                 $ex->getMessage(), DEBUG_DEVELOPER);
79             return false;
80         } catch (\dml_exception $ex) {
81             // Notify it as we run here as admin, we should see everything.
82             debugging('Error retrieving mod_data' . $entry->id . ' document: ' . $ex->getMessage(), DEBUG_DEVELOPER);
83             return false;
84         }
86         // Prepare associative array with data from DB.
87         $doc = \core_search\document_factory::instance($entry->id, $this->componentname, $this->areaname);
88         $doc->set('contextid', $context->id);
89         $doc->set('courseid', $entry->course);
90         $doc->set('userid', $entry->userid);
91         $doc->set('owneruserid', \core_search\manager::NO_OWNER_ID);
92         $doc->set('modified', $entry->timemodified);
94         $indexfields = $this->get_fields_for_entries($entry);
96         if (count($indexfields) < 2) {
97             return false;
98         }
100         // All fields should be already returned as plain text by data_field_base::get_content_value.
101         $doc->set('title', $indexfields[0]);
102         $doc->set('content', $indexfields[1]);
104         if (isset($indexfields[2])) {
105             $doc->set('description1', $indexfields[2]);
106         }
108         if (isset($indexfields[3])) {
109             $doc->set('description2', $indexfields[3]);
110         }
112         return $doc;
113     }
115     /**
116      * Whether the user can access the document or not.
117      *
118      * @throws \dml_missing_record_exception
119      * @throws \dml_exception
120      * @param int $id Glossary entry id
121      * @return bool
122      */
123     public function check_access($id) {
124         global $DB, $USER;
126         if (isguestuser()) {
127             return \core_search\manager::ACCESS_DENIED;
128         }
130         $now = time();
132         $sql = "SELECT dr.*, d.*
133                   FROM {data_records} dr
134                   JOIN {data} d ON d.id = dr.dataid
135                  WHERE dr.id = ?";
137         $entry = $DB->get_record_sql($sql, array( $id ), IGNORE_MISSING);
139         if (!$entry) {
140             return \core_search\manager::ACCESS_DELETED;
141         }
143         if (($entry->timeviewfrom && $now < $entry->timeviewfrom) || ($entry->timeviewto && $now > $entry->timeviewto)) {
144             return \core_search\manager::ACCESS_DENIED;
145         }
147         $cm = $this->get_cm('data', $entry->dataid, $entry->course);
148         $context = \context_module::instance($cm->id);
150         $canmanageentries = has_capability('mod/data:manageentries', $context);
152         if (!has_capability('mod/data:viewentry', $context)) {
153             return \core_search\manager::ACCESS_DENIED;
154         }
156         $numberofentriesindb = $DB->count_records('data_records', array('dataid' => $entry->dataid));
157         $requiredentriestoview = $entry->requiredentriestoview;
159         if ($requiredentriestoview && ($requiredentriestoview > $numberofentriesindb) &&
160                 ($USER->id != $entry->userid) && !$canmanageentries) {
161             return \core_search\manager::ACCESS_DENIED;
162         }
164         if ($entry->approval && !$entry->approved && ($entry->userid != $USER->id) && !$canmanageentries) {
165             return \core_search\manager::ACCESS_DENIED;
166         }
168         $currentgroup = groups_get_activity_group($cm, true);
169         $groupmode = groups_get_activity_groupmode($cm);
171         if (($groupmode == 1) && ($entry->groupid != $currentgroup) && !$canmanageentries) {
172             return \core_search\manager::ACCESS_DENIED;
173         }
175         return \core_search\manager::ACCESS_GRANTED;
176     }
178     /**
179      * Link to database entry.
180      *
181      * @param \core_search\document $doc
182      * @return \moodle_url
183      */
184     public function get_doc_url(\core_search\document $doc) {
185         $entry = $this->get_entry($doc->get('itemid'));
186         return new \moodle_url('/mod/data/view.php', array( 'd' => $entry->dataid, 'rid' => $entry->id ));
187     }
189     /**
190      * Link to the database activity.
191      *
192      * @param \core_search\document $doc
193      * @return \moodle_url
194      */
195     public function get_context_url(\core_search\document $doc) {
196         $entry = $this->get_entry($doc->get('itemid'));
197         return new \moodle_url('/mod/data/view.php', array('d' => $entry->dataid));
198     }
200     /**
201      * Returns true if this area uses file indexing.
202      *
203      * @return bool
204      */
205     public function uses_file_indexing() {
206         return true;
207     }
209     /**
210      * Add the database entries attachments.
211      *
212      * @param \core_search\document $doc
213      * @return void
214      */
215     public function attach_files($doc) {
216         global $DB;
218         $entryid = $doc->get('itemid');
220         try {
221             $entry = $this->get_entry($entryid);
222         } catch (\dml_missing_record_exception $e) {
223             debugging('Could not get record to attach files to '.$doc->get('id'), DEBUG_DEVELOPER);
224             return;
225         }
227         $cm = $this->get_cm('data', $entry->dataid, $doc->get('courseid'));
228         $context = \context_module::instance($cm->id);
230         // Get the files and attach them.
231         $fs = get_file_storage();
232         $files = $fs->get_area_files($context->id, 'mod_data', 'content', $entryid, 'filename', false);
233         foreach ($files as $file) {
234             $doc->add_stored_file($file);
235         }
236     }
238     /**
239      * Get database entry data
240      *
241      * @throws \dml_exception
242      * @param int $entryid
243      * @return stdClass
244      */
245     protected function get_entry($entryid) {
246         global $DB;
248         if (empty($this->entriesdata[$entryid])) {
249             $this->entriesdata[$entryid] = $DB->get_record('data_records', array( 'id' => $entryid ), '*', MUST_EXIST);
250         }
252         return $this->entriesdata[$entryid];
253     }
255     /**
256      * get_fields_for_entries
257      *
258      * @param StdClass $entry
259      * @return array
260      */
261     protected function get_fields_for_entries($entry) {
262         global $DB;
264         $indexfields = array();
265         $validfieldtypes = array('text', 'textarea', 'menu', 'radiobutton', 'checkbox', 'multimenu', 'url');
267         $sql = "SELECT dc.*, df.name AS fldname,
268                        df.type AS fieldtype, df.required
269                   FROM {data_content} dc, {data_fields} df
270                  WHERE dc.fieldid = df.id
271                        AND dc.recordid = :recordid";
273         $contents = $DB->get_records_sql($sql, array('recordid' => $entry->id));
274         $filteredcontents = array();
276         $template = $DB->get_record_sql('SELECT addtemplate FROM {data} WHERE id = ?', array($entry->dataid));
277         $template = $template->addtemplate;
279         // Filtering out the data_content records having invalid fieldtypes.
280         foreach ($contents as $content) {
281             if (in_array($content->fieldtype, $validfieldtypes)) {
282                 $filteredcontents[] = $content;
283             }
284         }
286         foreach ($filteredcontents as $content) {
287             $classname = $this->get_field_class_name($content->fieldtype);
288             $content->priority = $classname::get_priority();
289             $content->addtemplateposition = strpos($template, '[['.$content->fldname.']]');
290         }
292         $orderqueue = new \SPLPriorityQueue();
294         // Filtering out contents which belong to fields that aren't present in the addtemplate of the database activity instance.
295         foreach ($filteredcontents as $content) {
297             if ($content->addtemplateposition >= 0) {
298                 $orderqueue->insert($content, $content->addtemplateposition);
299             }
300         }
302         $filteredcontents = array();
304         while ($orderqueue->valid()) {
305             $filteredcontents[] = $orderqueue->extract();
306         }
308         // SPLPriorityQueue sorts according to descending order of the priority (here, addtemplateposition).
309         $filteredcontents = array_reverse($filteredcontents);
311         // Using a CUSTOM SPLPriorityQueure instance to sort out the filtered contents according to these rules :
312         // 1. Priorities in $fieldtypepriorities
313         // 2. Compulsory fieldtypes are to be given the top priority.
314         $contentqueue = new sortedcontentqueue($filteredcontents);
316         foreach ($filteredcontents as $key => $content) {
317             $contentqueue->insert($content, $key);
318         }
320         while ($contentqueue->valid()) {
322             $content = $contentqueue->extract();
323             $classname = $this->get_field_class_name($content->fieldtype);
324             $indexfields[] = $classname::get_content_value($content);
325         }
327         // Limited to 4 fields as a document only has 4 content fields.
328         if (count($indexfields) > 4) {
329             $indexfields[3] = implode(' ', array_slice($indexfields, 3));
330         }
331         return $indexfields;
332     }
334     /**
335      * Returns the class name for that field type and includes it.
336      *
337      * @param string $fieldtype
338      * @return string
339      */
340     protected function get_field_class_name($fieldtype) {
341         global $CFG;
343         $fieldtype = trim($fieldtype);
344         require_once($CFG->dirroot . '/mod/data/field/' . $fieldtype . '/field.class.php');
345         return 'data_field_' . $fieldtype;
346     }