MDL-67262 core_course: Added the ability to recommend activities.
[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         $favourites = $this->get_content_favourites(self::RECOMMENDATION_PREFIX, \context_user::instance($CFG->siteguest));
110         $recommendationcache->set($CFG->siteguest, $favourites);
111         return $favourites;
112     }
114     /**
115      * Gets content favourites from the favourites system depending on the area.
116      *
117      * @param  string        $prefix      Prefix for the item type.
118      * @param  \context_user $usercontext User context for the favourite
119      * @return array An array of favourite objects.
120      */
121     private function get_content_favourites(string $prefix, \context_user $usercontext): array {
122         // Get all modules and any submodules which implement get_course_content_items() hook.
123         // This gives us the set of all itemtypes which we'll use to register favourite content items.
124         // The ids that each plugin returns will be used together with the itemtype to uniquely identify
125         // each content item for favouriting.
126         $pluginmanager = \core_plugin_manager::instance();
127         $plugins = $pluginmanager->get_plugins_of_type('mod');
128         $itemtypes = [];
129         foreach ($plugins as $plugin) {
130             // Add the mod itself.
131             $itemtypes[] = $prefix . 'mod_' . $plugin->name;
133             // Add any subplugins to the list of item types.
134             $subplugins = $pluginmanager->get_subplugins_of_plugin('mod_' . $plugin->name);
135             foreach ($subplugins as $subpluginname => $subplugininfo) {
136                 if (component_callback_exists($subpluginname, 'get_course_content_items')) {
137                     $itemtypes[] = $prefix . $subpluginname;
138                 }
139             }
140         }
142         $ufservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
143         $favourites = [];
144         foreach ($itemtypes as $itemtype) {
145             $favs = $ufservice->find_favourites_by_type(self::COMPONENT, $itemtype);
146             $favobj = (object) ['itemtype' => $itemtype, 'ids' => array_column($favs, 'itemid')];
147             $favourites[] = $favobj;
148         }
149         return $favourites;
150     }
152     /**
153      * Get all content items which may be added to courses, irrespective of course caps, for site admin views, etc.
154      *
155      * @param \stdClass $user the user object.
156      * @return array the array of exported content items.
157      */
158     public function get_all_content_items(\stdClass $user): array {
159         global $PAGE;
160         $allcontentitems = $this->repository->find_all();
162         // Export the objects to get the formatted objects for transfer/display.
163         $favourites = $this->get_favourite_content_items_for_user($user);
164         $recommendations = $this->get_recommendations();
165         $ciexporter = new course_content_items_exporter(
166             $allcontentitems,
167             [
168                 'context' => \context_system::instance(),
169                 'favouriteitems' => $favourites,
170                 'recommended' => $recommendations
171             ]
172         );
173         $exported = $ciexporter->export($PAGE->get_renderer('core'));
175         // Sort by title for return.
176         usort($exported->content_items, function($a, $b) {
177             return $a->title > $b->title;
178         });
180         return $exported->content_items;
181     }
183     /**
184      * Return a representation of the available content items, for a user in a course.
185      *
186      * @param \stdClass $user the user to check access for.
187      * @param \stdClass $course the course to scope the content items to.
188      * @param array $linkparams the desired section to return to.
189      * @return \stdClass[] the content items, scoped to a course.
190      */
191     public function get_content_items_for_user_in_course(\stdClass $user, \stdClass $course, array $linkparams = []): array {
192         global $PAGE;
194         if (!has_capability('moodle/course:manageactivities', \context_course::instance($course->id), $user)) {
195             return [];
196         }
198         // Get all the visible content items.
199         $allcontentitems = $this->repository->find_all_for_course($course, $user);
201         // Content items can only originate from modules or submodules.
202         $pluginmanager = \core_plugin_manager::instance();
203         $components = \core_component::get_component_list();
204         $parents = [];
205         foreach ($allcontentitems as $contentitem) {
206             if (!in_array($contentitem->get_component_name(), array_keys($components['mod']))) {
207                 // It could be a subplugin.
208                 $info = $pluginmanager->get_plugin_info($contentitem->get_component_name());
209                 if (!is_null($info)) {
210                     $parent = $info->get_parent_plugin();
211                     if ($parent != false) {
212                         if (in_array($parent, array_keys($components['mod']))) {
213                             $parents[$contentitem->get_component_name()] = $parent;
214                             continue;
215                         }
216                     }
217                 }
218                 throw new \moodle_exception('Only modules and submodules can generate content items. \''
219                     . $contentitem->get_component_name() . '\' is neither.');
220             }
221             $parents[$contentitem->get_component_name()] = $contentitem->get_component_name();
222         }
224         // Now, check access to these items for the user.
225         $availablecontentitems = array_filter($allcontentitems, function($contentitem) use ($course, $user, $parents) {
226             // Check the parent module access for the user.
227             return course_allowed_module($course, explode('_', $parents[$contentitem->get_component_name()])[1], $user);
228         });
230         // Add the link params to the link, if any have been provided.
231         if (!empty($linkparams)) {
232             $availablecontentitems = array_map(function ($item) use ($linkparams) {
233                 $item->get_link()->params($linkparams);
234                 return $item;
235             }, $availablecontentitems);
236         }
238         // Export the objects to get the formatted objects for transfer/display.
239         $favourites = $this->get_favourite_content_items_for_user($user);
240         $recommended = $this->get_recommendations();
241         $ciexporter = new course_content_items_exporter(
242             $availablecontentitems,
243             [
244                 'context' => \context_course::instance($course->id),
245                 'favouriteitems' => $favourites,
246                 'recommended' => $recommended
247             ]
248         );
249         $exported = $ciexporter->export($PAGE->get_renderer('course'));
251         // Sort by title for return.
252         usort($exported->content_items, function($a, $b) {
253             return $a->title > $b->title;
254         });
256         return $exported->content_items;
257     }
259     /**
260      * Add a content item to a user's favourites.
261      *
262      * @param \stdClass $user the user whose favourite this is.
263      * @param string $componentname the name of the component from which the content item originates.
264      * @param int $contentitemid the id of the content item.
265      * @return \stdClass the exported content item.
266      */
267     public function add_to_user_favourites(\stdClass $user, string $componentname, int $contentitemid): \stdClass {
268         $usercontext = \context_user::instance($user->id);
269         $ufservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
271         // Because each plugin decides its own ids for content items, a combination of
272         // itemtype and id is used to guarantee uniqueness across all content items.
273         $itemtype = self::FAVOURITE_PREFIX . $componentname;
275         $ufservice->create_favourite(self::COMPONENT, $itemtype, $contentitemid, $usercontext);
277         $favcache = \cache::make('core', 'user_favourite_course_content_items');
278         $favcache->delete($user->id);
280         $items = $this->get_all_content_items($user);
281         return $items[array_search($contentitemid, array_column($items, 'id'))];
282     }
284     /**
285      * Remove the content item from a user's favourites.
286      *
287      * @param \stdClass $user the user whose favourite this is.
288      * @param string $componentname the name of the component from which the content item originates.
289      * @param int $contentitemid the id of the content item.
290      * @return \stdClass the exported content item.
291      */
292     public function remove_from_user_favourites(\stdClass $user, string $componentname, int $contentitemid): \stdClass {
293         $usercontext = \context_user::instance($user->id);
294         $ufservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
296         // Because each plugin decides its own ids for content items, a combination of
297         // itemtype and id is used to guarantee uniqueness across all content items.
298         $itemtype = self::FAVOURITE_PREFIX . $componentname;
300         $ufservice->delete_favourite(self::COMPONENT, $itemtype, $contentitemid, $usercontext);
302         $favcache = \cache::make('core', 'user_favourite_course_content_items');
303         $favcache->delete($user->id);
305         $items = $this->get_all_content_items($user);
306         return $items[array_search($contentitemid, array_column($items, 'id'))];
307     }
309     /**
310      * Toggle an activity to being recommended or not.
311      *
312      * @param  string $itemtype The component such as mod_assign, or assignsubmission_file
313      * @param  int    $itemid   The id related to this component item.
314      * @return bool True on creating a favourite, false on deleting it.
315      */
316     public function toggle_recommendation(string $itemtype, int $itemid): bool {
317         global $CFG;
319         $context = \context_system::instance();
321         $itemtype = self::RECOMMENDATION_PREFIX . $itemtype;
323         // Favourites are created using a user context. We'll use the site guest user ID as that should not change and there
324         // can be only one.
325         $usercontext = \context_user::instance($CFG->siteguest);
327         $recommendationcache = \cache::make('core', self::RECOMMENDATION_CACHE);
329         $favouritefactory = \core_favourites\service_factory::get_service_for_user_context($usercontext);
330         if ($favouritefactory->favourite_exists(self::COMPONENT, $itemtype, $itemid, $context)) {
331             $favouritefactory->delete_favourite(self::COMPONENT, $itemtype, $itemid, $context);
332             $result = $recommendationcache->delete($CFG->siteguest);
333             return false;
334         } else {
335             $favouritefactory->create_favourite(self::COMPONENT, $itemtype, $itemid, $context);
336             $result = $recommendationcache->delete($CFG->siteguest);
337             return true;
338         }
339     }