5cf5b988898cb8498e326281a66f09e65c7b7435
[moodle.git] / search / classes / base_block.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 base class for blocks.
19  *
20  * Note: Only blocks within courses are supported.
21  *
22  * @package core_search
23  * @copyright 2017 The Open University
24  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 namespace core_search;
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Search area base class for blocks.
33  *
34  * Note: Only blocks within courses are supported.
35  *
36  * @package core_search
37  * @copyright 2017 The Open University
38  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 abstract class base_block extends base {
41     /** @var string Cache name used for block instances */
42     const CACHE_INSTANCES = 'base_block_instances';
44     /**
45      * The context levels the search area is working on.
46      *
47      * This can be overwriten by the search area if it works at multiple
48      * levels.
49      *
50      * @var array
51      */
52     protected static $levels = [CONTEXT_BLOCK];
54     /**
55      * Gets the block name only.
56      *
57      * @return string Block name e.g. 'html'
58      */
59     public function get_block_name() {
60         // Remove 'block_' text.
61         return substr($this->get_component_name(), 6);
62     }
64     /**
65      * Returns restrictions on which block_instances rows to return. By default, excludes rows
66      * that have empty configdata.
67      *
68      * @return string SQL restriction (or multiple restrictions joined by AND), empty if none
69      */
70     protected function get_indexing_restrictions() {
71         return "bi.configdata != ''";
72     }
74     /**
75      * Gets recordset of all records modified since given time.
76      *
77      * See base class for detailed requirements. This implementation includes the key fields
78      * from block_instances.
79      *
80      * This can be overridden to do something totally different if the block's data is stored in
81      * other tables.
82      *
83      * If there are certain instances of the block which should not be included in the search index
84      * then you can override get_indexing_restrictions; by default this excludes rows with empty
85      * configdata.
86      *
87      * @param int $modifiedfrom Modified from time (>= this)
88      */
89     public function get_recordset_by_timestamp($modifiedfrom = 0) {
90         global $DB;
91         $restrictions = $this->get_indexing_restrictions();
92         if ($restrictions) {
93             $restrictions = 'AND ' . $restrictions;
94         }
95         // Query for all entries in block_instances for this type of block, which were modified
96         // since the given date. Also find the course or module where the block is located.
97         // (Although this query supports both module and course context, currently only two page
98         // types are supported, which will both be at course context. The module support is present
99         // in case of extension to other page types later.)
100         return $DB->get_recordset_sql("
101                 SELECT bi.id, bi.timemodified, bi.timecreated, bi.configdata,
102                        c.id AS courseid, x.id AS contextid
103                   FROM {block_instances} bi
104                   JOIN {context} x ON x.instanceid = bi.id AND x.contextlevel = ?
105                   JOIN {context} parent ON parent.id = bi.parentcontextid
106              LEFT JOIN {course_modules} cm ON cm.id = parent.instanceid AND parent.contextlevel = ?
107                   JOIN {course} c ON c.id = cm.course
108                        OR (c.id = parent.instanceid AND parent.contextlevel = ?)
109                  WHERE bi.timemodified >= ?
110                        AND bi.blockname = ?
111                        AND (parent.contextlevel = ? AND (bi.pagetypepattern LIKE 'course-view-%'
112                            OR bi.pagetypepattern IN ('site-index', 'course-*', '*')))
113                        $restrictions
114               ORDER BY bi.timemodified ASC",
115                 [CONTEXT_BLOCK, CONTEXT_MODULE, CONTEXT_COURSE, $modifiedfrom,
116                 $this->get_block_name(), CONTEXT_COURSE]);
117     }
119     public function get_doc_url(\core_search\document $doc) {
120         // Load block instance and find cmid if there is one.
121         $blockinstanceid = preg_replace('~^.*-~', '', $doc->get('id'));
122         $instance = $this->get_block_instance($blockinstanceid);
123         $courseid = $doc->get('courseid');
124         $anchor = 'inst' . $blockinstanceid;
126         // Check if the block is at course or module level.
127         if ($instance->cmid) {
128             // No module-level page types are supported at present so the search system won't return
129             // them. But let's put some example code here to indicate how it could work.
130             debugging('Unexpected module-level page type for block ' . $blockinstanceid . ': ' .
131                     $instance->pagetypepattern, DEBUG_DEVELOPER);
132             $modinfo = get_fast_modinfo($courseid);
133             $cm = $modinfo->get_cm($instance->cmid);
134             return new \moodle_url($cm->url, null, $anchor);
135         } else {
136             // The block is at course level. Let's check the page type, although in practice we
137             // currently only support the course main page.
138             if ($instance->pagetypepattern === '*' || $instance->pagetypepattern === 'course-*' ||
139                     preg_match('~^course-view-(.*)$~', $instance->pagetypepattern)) {
140                 return new \moodle_url('/course/view.php', ['id' => $courseid], $anchor);
141             } else if ($instance->pagetypepattern === 'site-index') {
142                 return new \moodle_url('/', ['redirect' => 0], $anchor);
143             } else {
144                 debugging('Unexpected page type for block ' . $blockinstanceid . ': ' .
145                         $instance->pagetypepattern, DEBUG_DEVELOPER);
146                 return new \moodle_url('/course/view.php', ['id' => $courseid], $anchor);
147             }
148         }
149     }
151     public function get_context_url(\core_search\document $doc) {
152         return $this->get_doc_url($doc);
153     }
155     /**
156      * Checks access for a document in this search area.
157      *
158      * If you override this function for a block, you should call this base class version first
159      * as it will check that the block is still visible to users in a supported location.
160      *
161      * @param int $id Document id
162      * @return int manager:ACCESS_xx constant
163      */
164     public function check_access($id) {
165         $instance = $this->get_block_instance($id, IGNORE_MISSING);
166         if (!$instance) {
167             // This generally won't happen because if the block has been deleted then we won't have
168             // included its context in the search area list, but just in case.
169             return manager::ACCESS_DELETED;
170         }
172         // Check block has not been moved to an unsupported area since it was indexed. (At the
173         // moment, only blocks within site and course context are supported, also only certain
174         // page types.)
175         if (!$instance->courseid ||
176                 !self::is_supported_page_type_at_course_context($instance->pagetypepattern)) {
177             return manager::ACCESS_DELETED;
178         }
180         // Note we do not need to check if the block was hidden or if the user has access to the
181         // context, because those checks are included in the list of search contexts user can access
182         // that is calculated in manager.php every time they do a query.
183         return manager::ACCESS_GRANTED;
184     }
186     /**
187      * Checks if a page type is supported for blocks when at course (or also site) context. This
188      * function should be consistent with the SQL in get_recordset_by_timestamp.
189      *
190      * @param string $pagetype Page type
191      * @return bool True if supported
192      */
193     protected static function is_supported_page_type_at_course_context($pagetype) {
194         if (in_array($pagetype, ['site-index', 'course-*', '*'])) {
195             return true;
196         }
197         if (preg_match('~^course-view-~', $pagetype)) {
198             return true;
199         }
200         return false;
201     }
203     /**
204      * Gets a block instance with given id.
205      *
206      * Returns the fields id, pagetypepattern, subpagepattern from block_instances and also the
207      * cmid (if parent context is an activity module).
208      *
209      * @param int $id ID of block instance
210      * @param int $strictness MUST_EXIST or IGNORE_MISSING
211      * @return false|mixed Block instance data (may be false if strictness is IGNORE_MISSING)
212      */
213     protected function get_block_instance($id, $strictness = MUST_EXIST) {
214         global $DB;
216         $cache = \cache::make_from_params(\cache_store::MODE_REQUEST, 'core_search',
217                 self::CACHE_INSTANCES, [], ['simplekeys' => true]);
218         $id = (int)$id;
219         $instance = $cache->get($id);
220         if (!$instance) {
221             $instance = $DB->get_record_sql("
222                     SELECT bi.id, bi.pagetypepattern, bi.subpagepattern,
223                            c.id AS courseid, cm.id AS cmid
224                       FROM {block_instances} bi
225                       JOIN {context} parent ON parent.id = bi.parentcontextid
226                  LEFT JOIN {course} c ON c.id = parent.instanceid AND parent.contextlevel = ?
227                  LEFT JOIN {course_modules} cm ON cm.id = parent.instanceid AND parent.contextlevel = ?
228                      WHERE bi.id = ?",
229                     [CONTEXT_COURSE, CONTEXT_MODULE, $id], $strictness);
230             $cache->set($id, $instance);
231         }
232         return $instance;
233     }
235     /**
236      * Clears static cache. This function can be removed (with calls to it in the test script
237      * replaced with cache_helper::purge_all) if MDL-59427 is fixed.
238      */
239     public static function clear_static() {
240         \cache::make_from_params(\cache_store::MODE_REQUEST, 'core_search',
241                 self::CACHE_INSTANCES, [], ['simplekeys' => true])->purge();
242     }