20209ae2d92188750dd4bca70cac885a0733cc5e
[moodle.git] / course / classes / local / service / content_item_service.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  * Contains the content_item_service class.
19  *
20  * @package    core
21  * @subpackage course
22  * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 namespace core_course\local\service;
27 defined('MOODLE_INTERNAL') || die();
29 use core_course\local\exporters\course_content_items_exporter;
30 use core_course\local\repository\content_item_readonly_repository_interface;
32 /**
33  * The content_item_service class, providing the api for interacting with content items.
34  *
35  * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class content_item_service {
40     /** @var content_item_readonly_repository_interface $repository a repository for content items. */
41     private $repository;
43     /** string the component for this favourite. */
44     public const COMPONENT = 'core_course';
45     /** string the favourite prefix itemtype in the favourites table. */
46     public const FAVOURITE_PREFIX = 'contentitem_';
47     /** string the recommendation prefix itemtype in the favourites table. */
48     public const RECOMMENDATION_PREFIX = 'recommend_';
49     /** string the cache name for recommendations. */
50     public const RECOMMENDATION_CACHE = 'recommendation_favourite_course_content_items';
52     /**
53      * The content_item_service constructor.
54      *
55      * @param content_item_readonly_repository_interface $repository a content item repository.
56      */
57     public function __construct(content_item_readonly_repository_interface $repository) {
58         $this->repository = $repository;
59     }
61     /**
62      * Returns an array of objects representing favourited content items.
63      *
64      * Each object contains the following properties:
65      * itemtype: a string containing the 'itemtype' key used by the favourites subsystem.
66      * ids[]: an array of ids, representing the content items within a component.
67      *
68      * Since two components can return (via their hook implementation) the same id, the itemtype is used for uniqueness.
69      *
70      * @param \stdClass $user
71      * @return array
72      */
73     private function get_favourite_content_items_for_user(\stdClass $user): array {
74         $favcache = \cache::make('core', 'user_favourite_course_content_items');
75         $key = $user->id;
76         $favmods = $favcache->get($key);
77         if ($favmods !== false) {
78             return $favmods;
79         }
81         $favourites = $this->get_content_favourites(self::FAVOURITE_PREFIX, \context_user::instance($user->id));
83         $favcache->set($key, $favourites);
84         return $favourites;
85     }
87     /**
88      * Returns an array of objects representing recommended content items.
89      *
90      * Each object contains the following properties:
91      * itemtype: a string containing the 'itemtype' key used by the favourites subsystem.
92      * ids[]: an array of ids, representing the content items within a component.
93      *
94      * Since two components can return (via their hook implementation) the same id, the itemtype is used for uniqueness.
95      *
96      * @return array
97      */
98     private function get_recommendations(): array {
99         global $CFG;
101         $recommendationcache = \cache::make('core', self::RECOMMENDATION_CACHE);
102         $key = $CFG->siteguest;
103         $favmods = $recommendationcache->get($key);
104         if ($favmods !== false) {
105             return $favmods;
106         }
108         // Make sure the guest user exists in the database.
109         if (!\core_user::get_user($CFG->siteguest)) {
110             throw new \coding_exception('The guest user does not exist in the database.');
111         }
113         $favourites = $this->get_content_favourites(self::RECOMMENDATION_PREFIX, \context_user::instance($CFG->siteguest));
115         $recommendationcache->set($CFG->siteguest, $favourites);
116         return $favourites;
117     }
119     /**
120      * Gets content favourites from the favourites system depending on the area.
121      *
122      * @param  string        $prefix      Prefix for the item type.
123      * @param  \context_user $usercontext User context for the favourite
124      * @return array An array of favourite objects.
125      */
126     private function get_content_favourites(string $prefix, \context_user $usercontext): array {
127         // Get all modules and any submodules which implement get_course_content_items() hook.
128         // This gives us the set of all itemtypes which we'll use to register favourite content items.
129         // The ids that each plugin returns will be used together with the itemtype to uniquely identify
130         // each content item for favouriting.
131         $pluginmanager = \core_plugin_manager::instance();
132         $plugins = $pluginmanager->get_plugins_of_type('mod');
133         $itemtypes = [];
134         foreach ($plugins as $plugin) {
135             // Add the mod itself.
136             $itemtypes[] = $prefix . 'mod_' . $plugin->name;
138             // Add any subplugins to the list of item types.
139             $subplugins = $pluginmanager->get_subplugins_of_plugin('mod_' . $plugin->name);
140             foreach ($subplugins as $subpluginname => $subplugininfo) {
141                 if (component_callback_exists($subpluginname, 'get_course_content_items')) {
142                     $itemtypes[] = $prefix . $subpluginname;
143                 }
144             }
145         }
147         $ufservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
148         $favourites = [];
149         $favs = $ufservice->find_all_favourites(self::COMPONENT, $itemtypes);
150         $favsreduced = array_reduce($favs, function($carry, $item) {
151             $carry[$item->itemtype][$item->itemid] = 0;
152             return $carry;
153         }, []);
155         foreach ($itemtypes as $type) {
156             $favourites[] = (object) [
157                 'itemtype' => $type,
158                 'ids' => isset($favsreduced[$type]) ? array_keys($favsreduced[$type]) : []
159             ];
160         }
161         return $favourites;
162     }
164     /**
165      * Get all content items which may be added to courses, irrespective of course caps, for site admin views, etc.
166      *
167      * @param \stdClass $user the user object.
168      * @return array the array of exported content items.
169      */
170     public function get_all_content_items(\stdClass $user): array {
171         $allcontentitems = $this->repository->find_all();
173         return $this->export_content_items($user, $allcontentitems);
174     }
176     /**
177      * Get content items which name matches a certain pattern and may be added to courses,
178      * irrespective of course caps, for site admin views, etc.
179      *
180      * @param \stdClass $user The user object.
181      * @param string $pattern The search pattern.
182      * @return array The array of exported content items.
183      */
184     public function get_content_items_by_name_pattern(\stdClass $user, string $pattern): array {
185         $allcontentitems = $this->repository->find_all();
187         $filteredcontentitems = array_filter($allcontentitems, function($contentitem) use ($pattern) {
188             return preg_match("/$pattern/i", $contentitem->get_title()->get_value());
189         });
191         return $this->export_content_items($user, $filteredcontentitems);
192     }
194     /**
195      * Export content items.
196      *
197      * @param \stdClass $user The user object.
198      * @param array $contentitems The content items array.
199      * @return array The array of exported content items.
200      */
201     private function export_content_items(\stdClass $user, $contentitems) {
202         global $PAGE;
204         // Export the objects to get the formatted objects for transfer/display.
205         $favourites = $this->get_favourite_content_items_for_user($user);
206         $recommendations = $this->get_recommendations();
207         $ciexporter = new course_content_items_exporter(
208             $contentitems,
209             [
210                 'context' => \context_system::instance(),
211                 'favouriteitems' => $favourites,
212                 'recommended' => $recommendations
213             ]
214         );
215         $exported = $ciexporter->export($PAGE->get_renderer('core'));
217         // Sort by title for return.
218         usort($exported->content_items, function($a, $b) {
219             return $a->title > $b->title;
220         });
222         return $exported->content_items;
223     }
225     /**
226      * Return a representation of the available content items, for a user in a course.
227      *
228      * @param \stdClass $user the user to check access for.
229      * @param \stdClass $course the course to scope the content items to.
230      * @param array $linkparams the desired section to return to.
231      * @return \stdClass[] the content items, scoped to a course.
232      */
233     public function get_content_items_for_user_in_course(\stdClass $user, \stdClass $course, array $linkparams = []): array {
234         global $PAGE;
236         if (!has_capability('moodle/course:manageactivities', \context_course::instance($course->id), $user)) {
237             return [];
238         }
240         // Get all the visible content items.
241         $allcontentitems = $this->repository->find_all_for_course($course, $user);
243         // Content items can only originate from modules or submodules.
244         $pluginmanager = \core_plugin_manager::instance();
245         $components = \core_component::get_component_list();
246         $parents = [];
247         foreach ($allcontentitems as $contentitem) {
248             if (!in_array($contentitem->get_component_name(), array_keys($components['mod']))) {
249                 // It could be a subplugin.
250                 $info = $pluginmanager->get_plugin_info($contentitem->get_component_name());
251                 if (!is_null($info)) {
252                     $parent = $info->get_parent_plugin();
253                     if ($parent != false) {
254                         if (in_array($parent, array_keys($components['mod']))) {
255                             $parents[$contentitem->get_component_name()] = $parent;
256                             continue;
257                         }
258                     }
259                 }
260                 throw new \moodle_exception('Only modules and submodules can generate content items. \''
261                     . $contentitem->get_component_name() . '\' is neither.');
262             }
263             $parents[$contentitem->get_component_name()] = $contentitem->get_component_name();
264         }
266         // Now, check access to these items for the user.
267         $availablecontentitems = array_filter($allcontentitems, function($contentitem) use ($course, $user, $parents) {
268             // Check the parent module access for the user.
269             return course_allowed_module($course, explode('_', $parents[$contentitem->get_component_name()])[1], $user);
270         });
272         // Add the link params to the link, if any have been provided.
273         if (!empty($linkparams)) {
274             $availablecontentitems = array_map(function ($item) use ($linkparams) {
275                 $item->get_link()->params($linkparams);
276                 return $item;
277             }, $availablecontentitems);
278         }
280         // Export the objects to get the formatted objects for transfer/display.
281         $favourites = $this->get_favourite_content_items_for_user($user);
282         $recommended = $this->get_recommendations();
283         $ciexporter = new course_content_items_exporter(
284             $availablecontentitems,
285             [
286                 'context' => \context_course::instance($course->id),
287                 'favouriteitems' => $favourites,
288                 'recommended' => $recommended
289             ]
290         );
291         $exported = $ciexporter->export($PAGE->get_renderer('course'));
293         // Sort by title for return.
294         usort($exported->content_items, function($a, $b) {
295             return $a->title > $b->title;
296         });
298         return $exported->content_items;
299     }
301     /**
302      * Add a content item to a user's favourites.
303      *
304      * @param \stdClass $user the user whose favourite this is.
305      * @param string $componentname the name of the component from which the content item originates.
306      * @param int $contentitemid the id of the content item.
307      * @return \stdClass the exported content item.
308      */
309     public function add_to_user_favourites(\stdClass $user, string $componentname, int $contentitemid): \stdClass {
310         $usercontext = \context_user::instance($user->id);
311         $ufservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
313         // Because each plugin decides its own ids for content items, a combination of
314         // itemtype and id is used to guarantee uniqueness across all content items.
315         $itemtype = self::FAVOURITE_PREFIX . $componentname;
317         $ufservice->create_favourite(self::COMPONENT, $itemtype, $contentitemid, $usercontext);
319         $favcache = \cache::make('core', 'user_favourite_course_content_items');
320         $favcache->delete($user->id);
322         $items = $this->get_all_content_items($user);
323         return $items[array_search($contentitemid, array_column($items, 'id'))];
324     }
326     /**
327      * Remove the content item from a user's favourites.
328      *
329      * @param \stdClass $user the user whose favourite this is.
330      * @param string $componentname the name of the component from which the content item originates.
331      * @param int $contentitemid the id of the content item.
332      * @return \stdClass the exported content item.
333      */
334     public function remove_from_user_favourites(\stdClass $user, string $componentname, int $contentitemid): \stdClass {
335         $usercontext = \context_user::instance($user->id);
336         $ufservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
338         // Because each plugin decides its own ids for content items, a combination of
339         // itemtype and id is used to guarantee uniqueness across all content items.
340         $itemtype = self::FAVOURITE_PREFIX . $componentname;
342         $ufservice->delete_favourite(self::COMPONENT, $itemtype, $contentitemid, $usercontext);
344         $favcache = \cache::make('core', 'user_favourite_course_content_items');
345         $favcache->delete($user->id);
347         $items = $this->get_all_content_items($user);
348         return $items[array_search($contentitemid, array_column($items, 'id'))];
349     }
351     /**
352      * Toggle an activity to being recommended or not.
353      *
354      * @param  string $itemtype The component such as mod_assign, or assignsubmission_file
355      * @param  int    $itemid   The id related to this component item.
356      * @return bool True on creating a favourite, false on deleting it.
357      */
358     public function toggle_recommendation(string $itemtype, int $itemid): bool {
359         global $CFG;
361         $context = \context_system::instance();
363         $itemtype = self::RECOMMENDATION_PREFIX . $itemtype;
365         // Favourites are created using a user context. We'll use the site guest user ID as that should not change and there
366         // can be only one.
367         $usercontext = \context_user::instance($CFG->siteguest);
369         $recommendationcache = \cache::make('core', self::RECOMMENDATION_CACHE);
371         $favouritefactory = \core_favourites\service_factory::get_service_for_user_context($usercontext);
372         if ($favouritefactory->favourite_exists(self::COMPONENT, $itemtype, $itemid, $context)) {
373             $favouritefactory->delete_favourite(self::COMPONENT, $itemtype, $itemid, $context);
374             $result = $recommendationcache->delete($CFG->siteguest);
375             return false;
376         } else {
377             $favouritefactory->create_favourite(self::COMPONENT, $itemtype, $itemid, $context);
378             $result = $recommendationcache->delete($CFG->siteguest);
379             return true;
380         }
381     }