MDL-69549 core: Add context export API
[moodle.git] / lib / classes / content.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  * Content API File Area definition.
19  *
20  * @package     core_files
21  * @copyright   2020 Andrew Nicols <andrew@nicols.co.uk>
22  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace core;
26 use coding_exception;
27 use context;
28 use core\content\export\exporters\course_exporter;
29 use core\content\export\exporters\component_exporter;
30 use core\content\export\exporters\abstract_mod_exporter;
31 use core\content\export\zipwriter;
32 use core_component;
33 use moodle_url;
34 use stdClass;
35 use stored_file;
37 /**
38  * The Content API allows all parts of Moodle to determine details about content within a component, or plugintype.
39  *
40  * This includes the description of files.
41  *
42  * @copyright   2020 Andrew Nicols <andrew@nicols.co.uk>
43  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
45 class content {
47     /**
48      * Check whether the specified user can export content for the specified context.
49      *
50      * @param   context $currentcontext
51      * @param   stdClass $user
52      * @return  bool
53      */
54     public static function can_export_context(context $currentcontext, stdClass $user): bool {
55         return true;
56     }
58     /**
59      * Export content for the specified context.
60      *
61      * @param   context $requestedcontext The context to be exported
62      * @param   stdClass $user The user being exported
63      * @param   zipwriter $archive The Zip Archive to export to
64      */
65     public static function export_context(context $requestedcontext, stdClass $user, zipwriter $archive): void {
66         global $USER;
68         if ($requestedcontext->contextlevel != CONTEXT_COURSE) {
69             throw new coding_exception('The Content Export API currently only supports the export of courses');
70         }
72         if ($USER->id != $user->id) {
73             throw new coding_exception('The Content Export API currently only supports export of the current user');
74         }
76         // Ensure that the zipwriter is aware of the requested context.
77         $archive->set_root_context($requestedcontext);
79         // Fetch all child contexts, indexed by path.
80         $contextlist = [
81             $requestedcontext->path => $requestedcontext,
82         ];
83         foreach ($requestedcontext->get_child_contexts() as $context) {
84             $contextlist[$context->path] = $context;
85         }
87         // Reverse the order by key - this ensures that child contexts are processed before their parent.
88         krsort($contextlist);
90         // Get the course modinfo.
91         $modinfo = get_fast_modinfo($requestedcontext->instanceid);
93         // Filter out any context which cannot be exported.
94         $contextlist = array_filter($contextlist, function($context) use ($user, $modinfo): bool {
95             if ($context->contextlevel == CONTEXT_COURSE) {
96                 return self::can_export_context($context, $user);
97             }
99             if ($context->contextlevel == CONTEXT_MODULE) {
100                 if (empty($modinfo->cms[$context->instanceid])) {
101                     // Unknown coursemodule in the course.
102                     return false;
103                 }
105                 $cm = $modinfo->cms[$context->instanceid];
107                 if (!$cm->uservisible) {
108                     // This user cannot view the activity.
109                     return false;
110                 }
112                 // Defer to setting checks.
113                 return self::can_export_context($context, $user);
114             }
116             // Only course and activities are supported at this time.
117             return false;
118         });
120         // Export each context.
121         $exportedcontexts = [];
122         $coursecontroller = new course_exporter($requestedcontext->get_course_context(), $user, $archive);
123         foreach ($contextlist as $context) {
124             if ($context->contextlevel === CONTEXT_MODULE) {
125                 $cm = $modinfo->cms[$context->instanceid];
126                 $component = "mod_{$cm->modname}";
128                 // Check for a specific implementation for this module.
129                 // This will export any content specific to this activity.
130                 // For example, in mod_folder it will export the list of folders.
131                 $classname = component_exporter::get_classname_for_component($component);
132                 $exportables = [];
133                 if (class_exists($classname) && is_a($classname, abstract_mod_exporter::class, true)) {
134                     $controller = new $classname($context, $component, $user, $archive);
135                     $exportables = $controller->get_exportables();
136                 }
138                 // Pass the exportable content to the  course controller for export.
139                 $coursecontroller->export_mod_content($context, $exportables);
141                 $exportedcontexts[$context->id] = $context;
142             } else if ($context->contextlevel === CONTEXT_COURSE) {
143                 // Export the course content.
144                 $coursecontroller->export_course($exportedcontexts);
145             }
146         }
148         $archive->finish();
149     }