MDL-53226 search_simpledb: Adding clumsy search
[moodle.git] / search / engine / simpledb / classes / engine.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  * Simple moodle database engine.
19  *
20  * @package    search_simpledb
21  * @copyright  2016 David Monllao {@link http://www.davidmonllao.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace search_simpledb;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Simple moodle database engine.
31  *
32  * @package    search_simpledb
33  * @copyright  2016 David Monllao {@link http://www.davidmonllao.com}
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class engine extends \core_search\engine {
38     /**
39      * Prepares a Solr query, applies filters and executes it returning its results.
40      *
41      * @throws \core_search\engine_exception
42      * @param  stdClass     $filters Containing query and filters.
43      * @param  array        $usercontexts Contexts where the user has access. True if the user can access all contexts.
44      * @return \core_search\document[] Results or false if no results
45      */
46     public function execute_query($filters, $usercontexts) {
47         global $DB, $USER;
49         // Let's keep these changes internal.
50         $data = clone $filters;
52         $serverstatus = $this->is_server_ready();
53         if ($serverstatus !== true) {
54             throw new \core_search\engine_exception('engineserverstatus', 'search');
55         }
57         $sql = 'SELECT * FROM {search_simpledb_index} WHERE ';
58         $params = array();
60         // To store all conditions we will add to where.
61         $ands = array();
63         // Get results only available for the current user.
64         $ands[] = '(owneruserid = ? OR owneruserid = ?)';
65         $params = array_merge($params, array(\core_search\manager::NO_OWNER_ID, $USER->id));
67         // Restrict it to the context where the user can access, we want this one cached.
68         // If the user can access all contexts $usercontexts value is just true, we don't need to filter
69         // in that case.
70         if ($usercontexts && is_array($usercontexts)) {
71             // Join all area contexts into a single array and implode.
72             $allcontexts = array();
73             foreach ($usercontexts as $areaid => $areacontexts) {
74                 if (!empty($data->areaid) && ($areaid !== $data->areaid)) {
75                     // Skip unused areas.
76                     continue;
77                 }
78                 foreach ($areacontexts as $contextid) {
79                     // Ensure they are unique.
80                     $allcontexts[$contextid] = $contextid;
81                 }
82             }
83             if (empty($allcontexts)) {
84                 // This means there are no valid contexts for them, so they get no results.
85                 return array();
86             }
88             list($contextsql, $contextparams) = $DB->get_in_or_equal($allcontexts);
89             $ands[] = 'contextid ' . $contextsql;
90             $params = array_merge($params, $contextparams);
91         }
93         // Course id filter.
94         if (!empty($data->courseids)) {
95             list($conditionsql, $conditionparams) = $DB->get_in_or_equal($data->courseids);
96             $ands[] = 'courseid ' . $conditionsql;
97             $params = array_merge($params, $conditionparams);
98         }
100         // Area id filter.
101         if (!empty($data->areaid)) {
102             list($conditionsql, $conditionparams) = $DB->get_in_or_equal($data->areaid);
103             $ands[] = 'areaid ' . $conditionsql;
104             $params = array_merge($params, $conditionparams);
105         }
107         if (!empty($data->title)) {
108             list($conditionsql, $conditionparams) = $DB->get_in_or_equal($data->title);
109             $ands[] = 'title ' . $conditionsql;
110             $params = array_merge($params, $conditionparams);
111         }
113         if (!empty($data->timestart)) {
114             $ands[] = 'modified >= ?';
115             $params[] = $data->timestart;
116         }
117         if (!empty($data->timeend)) {
118             $ands[] = 'modified <= ?';
119             $params[] = $data->timeend;
120         }
122         // And finally the main query after applying all AND filters.
123         $ands[] = '(' .
124             $DB->sql_like('title', '?', false, false) . ' OR ' .
125             $DB->sql_like('content', '?', false, false) . ' OR ' .
126             $DB->sql_like('description1', '?', false, false) . ' OR ' .
127             $DB->sql_like('description2', '?', false, false) .
128             ')';
129         $params[] = '%' . $data->q . '%';
130         $params[] = '%' . $data->q . '%';
131         $params[] = '%' . $data->q . '%';
132         $params[] = '%' . $data->q . '%';
134         $recordset = $DB->get_recordset_sql($sql . implode(' AND ', $ands), $params, 0, \core_search\manager::MAX_RESULTS);
136         $numgranted = 0;
138         if (!$recordset->valid()) {
139             return array();
140         }
142         // Iterate through the results checking its availability and whether they are available for the user or not.
143         $docs = array();
144         foreach ($recordset as $docdata) {
145             if (!$searcharea = $this->get_search_area($docdata->areaid)) {
146                 continue;
147             }
149             // Switch id back to the document id.
150             $docdata->id = $docdata->docid;
151             unset($docdata->docid);
153             $access = $searcharea->check_access($docdata->itemid);
154             switch ($access) {
155                 case \core_search\manager::ACCESS_DELETED:
156                     $this->delete_by_id($docdata->id);
157                     break;
158                 case \core_search\manager::ACCESS_DENIED:
159                     break;
160                 case \core_search\manager::ACCESS_GRANTED:
161                     $numgranted++;
162                     $docs[] = $this->to_document($searcharea, (array)$docdata);
163                     break;
164             }
166             // This should never happen.
167             if ($numgranted >= \core_search\manager::MAX_RESULTS) {
168                 $docs = array_slice($docs, 0, \core_search\manager::MAX_RESULTS, true);
169                 break;
170             }
171         }
172         $recordset->close();
174         return $docs;
175     }
177     /**
178      * Adds a document to the search engine.
179      *
180      * This does not commit to the search engine.
181      *
182      * @param \core_search\document $document
183      * @param bool $fileindexing True if file indexing is to be used
184      * @return bool False if the file was skipped or failed, true on success
185      */
186     public function add_document($document, $fileindexing = false) {
187         global $DB;
189         $doc = (object)$document->export_for_engine();
191         // Moodle's ids using DML are always autoincremented.
192         $doc->docid = $doc->id;
193         unset($doc->id);
195         $id = $DB->get_field('search_simpledb_index', 'id', array('docid' => $doc->docid));
196         try {
197             if ($id) {
198                 $doc->id = $id;
199                 $DB->update_record('search_simpledb_index', $doc);
200             } else {
201                 $DB->insert_record('search_simpledb_index', $doc);
202             }
204         } catch (dml_exception $ex) {
205             debugging('dml error while trying to insert document with id ' . $doc->docid . ': ' . $e->getMessage(),
206                 DEBUG_DEVELOPER);
207         }
209         return true;
210     }
212     /**
213      * Deletes the specified document.
214      *
215      * @param string $id The document id to delete
216      * @return void
217      */
218     public function delete_by_id($id) {
219         global $DB;
220         $DB->delete_records('search_simpledb_index', array('docid' => $id));
221     }
223     /**
224      * Delete all area's documents.
225      *
226      * @param string $areaid
227      * @return void
228      */
229     public function delete($areaid = null) {
230         global $DB;
231         if ($areaid) {
232             $DB->delete_records('search_simpledb_index', array('areaid' => $areaid));
233         } else {
234             $DB->delete_records('search_simpledb_index');
235         }
236     }
238     /**
239      * Checks that the required table was installed.
240      *
241      * @return true|string Returns true if all good or an error string.
242      */
243     public function is_server_ready() {
244         global $DB;
245         if (!$DB->get_manager()->table_exists('search_simpledb_index')) {
246             return 'search_simpledb_index table does not exist';
247         }
249         return true;
250     }
252     /**
253      * It is always installed.
254      *
255      * @return true
256      */
257     public function is_installed() {
258         return true;
259     }