fd0340d2b2a163a7d5bd70358575ab16c9a02231
[moodle.git] / privacy / classes / local / request / moodle_content_writer.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  * This file contains the moodle format implementation of the content writer.
19  *
20  * @package core_privacy
21  * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace core_privacy\local\request;
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * The moodle_content_writer is the default Moodle implementation of a content writer.
30  *
31  * It exports data to a rich tree structure using Moodle's context system,
32  * and produces a single zip file with all content.
33  *
34  * Objects of data are stored as JSON.
35  *
36  * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
37  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class moodle_content_writer implements content_writer {
40     /**
41      * Maximum context name char size.
42      */
43     const MAX_CONTEXT_NAME_LENGTH = 32;
45     /**
46      * @var string The base path on disk for this instance.
47      */
48     protected $path = null;
50     /**
51      * @var \context The current context of the writer.
52      */
53     protected $context = null;
55     /**
56      * @var \stored_file[] The list of files to be exported.
57      */
58     protected $files = [];
60     /**
61      * @var array The list of plugins that have been checked to see if they are installed.
62      */
63     protected $checkedplugins = [];
65     /**
66      * Constructor for the content writer.
67      *
68      * Note: The writer factory must be passed.
69      *
70      * @param   writer          $writer     The factory.
71      */
72     public function __construct(writer $writer) {
73         $this->path = make_request_directory();
74     }
76     /**
77      * Set the context for the current item being processed.
78      *
79      * @param   \context        $context    The context to use
80      */
81     public function set_context(\context $context) : content_writer {
82         $this->context = $context;
84         return $this;
85     }
87     /**
88      * Export the supplied data within the current context, at the supplied subcontext.
89      *
90      * @param   array           $subcontext The location within the current context that this data belongs.
91      * @param   \stdClass       $data       The data to be exported
92      * @return  content_writer
93      */
94     public function export_data(array $subcontext, \stdClass $data) : content_writer {
95         $path = $this->get_path($subcontext, 'data.json');
97         $this->write_data($path, json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT));
99         return $this;
100     }
102     /**
103      * Export metadata about the supplied subcontext.
104      *
105      * Metadata consists of a key/value pair and a description of the value.
106      *
107      * @param   array           $subcontext The location within the current context that this data belongs.
108      * @param   string          $key        The metadata name.
109      * @param   string          $value      The metadata value.
110      * @param   string          $description    The description of the value.
111      * @return  content_writer
112      */
113     public function export_metadata(array $subcontext, string $key, $value, string $description) : content_writer {
114         $path = $this->get_full_path($subcontext, 'metadata.json');
116         if (file_exists($path)) {
117             $data = json_decode(file_get_contents($path));
118         } else {
119             $data = (object) [];
120         }
122         $data->$key = (object) [
123             'value' => $value,
124             'description' => $description,
125         ];
127         $path = $this->get_path($subcontext, 'metadata.json');
128         $this->write_data($path, json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT));
130         return $this;
131     }
133     /**
134      * Export a piece of related data.
135      *
136      * @param   array           $subcontext The location within the current context that this data belongs.
137      * @param   string          $name       The name of the file to be exported.
138      * @param   \stdClass       $data       The related data to export.
139      * @return  content_writer
140      */
141     public function export_related_data(array $subcontext, $name, $data) : content_writer {
142         return $this->export_custom_file($subcontext, "{$name}.json",
143             json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT));
144     }
146     /**
147      * Export a piece of data in a custom format.
148      *
149      * @param   array           $subcontext The location within the current context that this data belongs.
150      * @param   string          $filename   The name of the file to be exported.
151      * @param   string          $filecontent    The content to be exported.
152      */
153     public function export_custom_file(array $subcontext, $filename, $filecontent) : content_writer {
154         $filename = clean_param($filename, PARAM_FILE);
155         $path = $this->get_path($subcontext, $filename);
156         $this->write_data($path, $filecontent);
158         return $this;
159     }
161     /**
162      * Prepare a text area by processing pluginfile URLs within it.
163      *
164      * @param   array           $subcontext The location within the current context that this data belongs.
165      * @param   string          $component  The name of the component that the files belong to.
166      * @param   string          $filearea   The filearea within that component.
167      * @param   string          $itemid     Which item those files belong to.
168      * @param   string          $text       The text to be processed
169      * @return  string                      The processed string
170      */
171     public function rewrite_pluginfile_urls(array $subcontext, $component, $filearea, $itemid, $text) : string {
172         // Need to take into consideration the subcontext to provide the full path to this file.
173         $subcontextpath = '';
174         if (!empty($subcontext)) {
175             $subcontextpath = DIRECTORY_SEPARATOR . implode(DIRECTORY_SEPARATOR, $subcontext);
176         }
177         $path = $this->get_context_path();
178         $path = implode(DIRECTORY_SEPARATOR, $path) . $subcontextpath;
179         $returnstring = $path . DIRECTORY_SEPARATOR . $this->get_files_target_url($component, $filearea, $itemid) . '/';
180         $returnstring = clean_param($returnstring, PARAM_PATH);
182         return str_replace('@@PLUGINFILE@@/', $returnstring, $text);
183     }
185     /**
186      * Export all files within the specified component, filearea, itemid combination.
187      *
188      * @param   array           $subcontext The location within the current context that this data belongs.
189      * @param   string          $component  The name of the component that the files belong to.
190      * @param   string          $filearea   The filearea within that component.
191      * @param   string          $itemid     Which item those files belong to.
192      */
193     public function export_area_files(array $subcontext, $component, $filearea, $itemid) : content_writer {
194         $fs = get_file_storage();
195         $files = $fs->get_area_files($this->context->id, $component, $filearea, $itemid);
196         foreach ($files as $file) {
197             $this->export_file($subcontext, $file);
198         }
200         return $this;
201     }
203     /**
204      * Export the specified file in the target location.
205      *
206      * @param   array           $subcontext The location within the current context that this data belongs.
207      * @param   \stored_file    $file       The file to be exported.
208      */
209     public function export_file(array $subcontext, \stored_file $file) : content_writer {
210         if (!$file->is_directory()) {
211             $pathitems = array_merge(
212                 $subcontext,
213                 [$this->get_files_target_path($file->get_component(), $file->get_filearea(), $file->get_itemid())],
214                 [$file->get_filepath()]
215             );
216             $path = $this->get_path($pathitems, $file->get_filename());
217             $fullpath = $this->get_full_path($pathitems, $file->get_filename());
218             check_dir_exists(dirname($fullpath), true, true);
219             $this->files[$path] = $file;
220         }
222         return $this;
223     }
225     /**
226      * Export the specified user preference.
227      *
228      * @param   string          $component  The name of the component.
229      * @param   string          $key        The name of th key to be exported.
230      * @param   string          $value      The value of the preference
231      * @param   string          $description    A description of the value
232      * @return  content_writer
233      */
234     public function export_user_preference(string $component, string $key, string $value, string $description) : content_writer {
235         $subcontext = [
236             get_string('userpreferences'),
237         ];
238         $fullpath = $this->get_full_path($subcontext, "{$component}.json");
239         $path = $this->get_path($subcontext, "{$component}.json");
241         if (file_exists($fullpath)) {
242             $data = json_decode(file_get_contents($fullpath));
243         } else {
244             $data = (object) [];
245         }
247         $data->$key = (object) [
248             'value' => $value,
249             'description' => $description,
250         ];
251         $this->write_data($path, json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT));
253         return $this;
254     }
256     /**
257      * Determine the path for the current context.
258      *
259      * @return array The context path.
260      * @throws \coding_exception
261      */
262     protected function get_context_path() : array {
263         $path = [];
264         $contexts = array_reverse($this->context->get_parent_contexts(true));
265         foreach ($contexts as $context) {
266             $name = $context->get_context_name();
267             $id = ' _.' . $context->id;
268             $path[] = shorten_text(clean_param($name, PARAM_FILE),
269                     self::MAX_CONTEXT_NAME_LENGTH, true, json_decode('"' . '\u2026' . '"')) . $id;
270         }
272         return $path;
273     }
275     /**
276      * Get the relative file path within the current context, and subcontext, using the specified filename.
277      *
278      * @param   string[]        $subcontext The location within the current context to export this data.
279      * @param   string          $name       The intended filename, including any extensions.
280      * @return  string                      The fully-qualfiied file path.
281      */
282     protected function get_path(array $subcontext, string $name) : string {
283         $subcontext = shorten_filenames($subcontext, MAX_FILENAME_SIZE, true);
284         $name = shorten_filename($name, MAX_FILENAME_SIZE, true);
286         // This weird code is to look for a subcontext that contains a number and append an '_' to the front.
287         // This is because there seems to be some weird problem with array_merge_recursive used in finalise_content().
288         $subcontext = array_map(function($data) {
289             $data = clean_param($data, PARAM_PATH);
290             if (stripos($data, DIRECTORY_SEPARATOR) !== false) {
291                 $newpath = explode(DIRECTORY_SEPARATOR, $data);
292                 $newpath = array_map(function($value) {
293                     if (is_numeric($value)) {
294                         return '_' . $value;
295                     }
296                     return $value;
297                 }, $newpath);
298                 return implode(DIRECTORY_SEPARATOR, $newpath);
299             } else if (is_numeric($data)) {
300                 $data = '_' . $data;
301             }
302             return $data;
303         }, $subcontext);
305         // Combine the context path, and the subcontext data.
306         $path = array_merge(
307             $this->get_context_path(),
308             $subcontext
309         );
311         // Join the directory together with the name.
312         $filepath = implode(DIRECTORY_SEPARATOR, $path) . DIRECTORY_SEPARATOR . $name;
314         // To use backslash, it must be doubled ("\\\\" PHP string).
315         $separator = str_replace('\\', '\\\\', DIRECTORY_SEPARATOR);
316         return preg_replace('@(' . $separator . '|/)+@', $separator, $filepath);
317     }
319     /**
320      * Get the fully-qualified file path within the current context, and subcontext, using the specified filename.
321      *
322      * @param   string[]        $subcontext The location within the current context to export this data.
323      * @param   string          $name       The intended filename, including any extensions.
324      * @return  string                      The fully-qualfiied file path.
325      */
326     protected function get_full_path(array $subcontext, string $name) : string {
327         $path = array_merge(
328             [$this->path],
329             [$this->get_path($subcontext, $name)]
330         );
332         // Join the directory together with the name.
333         $filepath = implode(DIRECTORY_SEPARATOR, $path);
335         // To use backslash, it must be doubled ("\\\\" PHP string).
336         $separator = str_replace('\\', '\\\\', DIRECTORY_SEPARATOR);
337         return preg_replace('@(' . $separator . '|/)+@', $separator, $filepath);
338     }
340     /**
341      * Get a path within a subcontext where exported files should be written to.
342      *
343      * @param string $component The name of the component that the files belong to.
344      * @param string $filearea The filearea within that component.
345      * @param string $itemid Which item those files belong to.
346      * @return string The path
347      */
348     protected function get_files_target_path($component, $filearea, $itemid) : string {
350         // We do not need to include the component because we organise things by context.
351         $parts = ['_files', $filearea];
353         if (!empty($itemid)) {
354             $parts[] = $itemid;
355         }
357         return implode(DIRECTORY_SEPARATOR, $parts);
358     }
360     /**
361      * Get a relative url to the directory of the exported files within a subcontext.
362      *
363      * @param string $component The name of the component that the files belong to.
364      * @param string $filearea The filearea within that component.
365      * @param string $itemid Which item those files belong to.
366      * @return string The url
367      */
368     protected function get_files_target_url($component, $filearea, $itemid) : string {
369         // We do not need to include the component because we organise things by context.
370         $parts = ['_files', $filearea];
372         if (!empty($itemid)) {
373             $parts[] = '_' . $itemid;
374         }
376         return implode('/', $parts);
377     }
379     /**
380      * Write the data to the specified path.
381      *
382      * @param   string          $path       The path to export the data at.
383      * @param   string          $data       The data to be exported.
384      * @throws  \moodle_exception           If the file cannot be written for some reason.
385      */
386     protected function write_data(string $path, string $data) {
387         $targetpath = $this->path . DIRECTORY_SEPARATOR . $path;
388         check_dir_exists(dirname($targetpath), true, true);
389         if (file_put_contents($targetpath, $data) === false) {
390             throw new \moodle_exception('cannotsavefile', 'error', '', $targetpath);
391         }
392         $this->files[$path] = $targetpath;
393     }
395     /**
396      * Copy a file to the specified path.
397      *
398      * @param  array  $path        Current location of the file.
399      * @param  array  $destination Destination path to copy the file to.
400      */
401     protected function copy_data(array $path, array $destination) {
402         global $CFG;
403         $filename = array_pop($destination);
404         $destdirectory = implode(DIRECTORY_SEPARATOR, $destination);
405         $fulldestination = $this->path . DIRECTORY_SEPARATOR . $destdirectory;
406         check_dir_exists($fulldestination, true, true);
407         $fulldestination .= $filename;
408         $currentpath = $CFG->dirroot . DIRECTORY_SEPARATOR . implode(DIRECTORY_SEPARATOR, $path);
409         copy($currentpath, $fulldestination);
410         $this->files[$destdirectory . DIRECTORY_SEPARATOR . $filename] = $fulldestination;
411     }
413     /**
414      * This creates three different bits of data from all of the files that will be
415      * exported.
416      * $tree - A multidimensional array of the navigation tree structure.
417      * $treekey - An array with the short path of the file and element data for
418      *            html (data_file_{number} or 'No var')
419      * $allfiles - All *.json files that need to be added as an index to be referenced
420      *             by the js files to display the user data.
421      *
422      * @return array returns a tree, tree key, and a list of all files.
423      */
424     protected function prepare_for_export() : Array {
425         $tree = [];
426         $treekey = [];
427         $allfiles = [];
428         $i = 1;
429         foreach ($this->files as $shortpath => $fullfile) {
431             // Generate directory tree as an associative array.
432             $items = explode(DIRECTORY_SEPARATOR, $shortpath);
433             $newitems = $this->condense_array($items);
434             $tree = array_merge_recursive($tree, $newitems);
436             if (is_string($fullfile)) {
437                 $filearray = explode(DIRECTORY_SEPARATOR, $shortpath);
438                 $filename = array_pop($filearray);
439                 $filenamearray = explode('.', $filename);
440                 // Don't process files that are not json files.
441                 if (end($filenamearray) !== 'json') {
442                     continue;
443                 }
444                 // Chop the last two characters of the extension. json => js.
445                 $filename = substr($filename, 0, -2);
446                 array_push($filearray, $filename);
447                 $newshortpath = implode(DIRECTORY_SEPARATOR, $filearray);
449                 $varname = 'data_file_' . $i;
450                 $i++;
452                 $quicktemp = clean_param($shortpath, PARAM_PATH);
453                 $treekey[$quicktemp] = $varname;
454                 $allfiles[$varname] = clean_param($newshortpath, PARAM_PATH);
456                 // Need to load up the current json file and add a variable (varname mentioned above) at the start.
457                 // Then save it as a js file.
458                 $content = $this->get_file_content($fullfile);
459                 $jsondecodedcontent = json_decode($content);
460                 $jsonencodedcontent = json_encode($jsondecodedcontent, JSON_PRETTY_PRINT);
461                 $variablecontent = 'var ' . $varname . ' = ' . $jsonencodedcontent;
463                 $this->write_data($newshortpath, $variablecontent);
464             } else {
465                 $treekey[clean_param($shortpath, PARAM_PATH)] = 'No var';
466             }
467         }
468         return [$tree, $treekey, $allfiles];
469     }
471     /**
472      * Add more detail to the tree to help with sorting and display in the renderer.
473      *
474      * @param  array  $tree       The file structure currently as a multidimensional array.
475      * @param  array  $treekey    An array of the current file paths.
476      * @param  array  $currentkey The current short path of the tree.
477      * @return array An array of objects that has additional data.
478      */
479     protected function make_tree_object(array $tree, array $treekey, array $currentkey = []) : Array {
480         $newtree = [];
481         // Try to extract the context id and then add the context object.
482         $addcontext = function($index, $object) {
483             if (stripos($index, '_.') !== false) {
484                 $namearray = explode('_.', $index);
485                 $contextid = array_pop($namearray);
486                 if (is_numeric($contextid)) {
487                     $object[$index]->name = implode('_.', $namearray);
488                     $object[$index]->context = \context::instance_by_id($contextid);
489                 }
490             } else {
491                 $object[$index]->name = $index;
492             }
493         };
494         // Just add the final data to the tree object.
495         $addfinalfile = function($directory, $treeleaf, $file) use ($treekey) {
496             $url = implode(DIRECTORY_SEPARATOR, $directory);
497             $url = clean_param($url, PARAM_PATH);
498             $treeleaf->name = $file;
499             $treeleaf->itemtype = 'item';
500             $gokey = clean_param($url . '/' . $file, PARAM_PATH);
501             if (isset($treekey[$gokey]) && $treekey[$gokey] !== 'No var') {
502                 $treeleaf->datavar = $treekey[$gokey];
503             } else {
504                 $treeleaf->url = new \moodle_url($url . '/' . $file);
505             }
506         };
508         foreach ($tree as $key => $value) {
509             $newtree[$key] = new \stdClass();
510             if (is_array($value)) {
511                 $newtree[$key]->itemtype = 'treeitem';
512                 // The array merge recursive adds a numeric index, and so we only add to the current
513                 // key if it is now numeric.
514                 $currentkey = is_numeric($key) ? $currentkey : array_merge($currentkey, [$key]);
516                 // Try to extract the context id and then add the context object.
517                 $addcontext($key, $newtree);
518                 $newtree[$key]->children = $this->make_tree_object($value, $treekey, $currentkey);
520                 if (!is_numeric($key)) {
521                     // We're heading back down the tree, so remove the last key.
522                     array_pop($currentkey);
523                 }
524             } else {
525                 // If the key is not numeric then we want to add a directory and put the file under that.
526                 if (!is_numeric($key)) {
527                     $newtree[$key]->itemtype = 'treeitem';
528                     // Try to extract the context id and then add the context object.
529                     $addcontext($key, $newtree);
530                      array_push($currentkey, $key);
532                     $newtree[$key]->children[$value] = new \stdClass();
533                     $addfinalfile($currentkey, $newtree[$key]->children[$value], $value);
534                     array_pop($currentkey);
535                 } else {
536                     // If the key is just a number then we just want to show the file instead.
537                     $addfinalfile($currentkey, $newtree[$key], $value);
538                 }
539             }
540         }
541         return $newtree;
542     }
544     /**
545      * Sorts the tree list into an order that makes more sense.
546      * Order is:
547      * 1 - Items with a context first, the lower the number the higher up the tree.
548      * 2 - Items that are directories.
549      * 3 - Items that are log directories.
550      * 4 - Links to a page.
551      *
552      * @param  array $tree The tree structure to order.
553      */
554     protected function sort_my_list(array &$tree) {
555         uasort($tree, function($a, $b) {
556             if (isset($a->context) && isset($b->context)) {
557                 return $a->context->contextlevel <=> $b->context->contextlevel;
558             }
559             if (isset($a->context) && !isset($b->context)) {
560                 return -1;
561             }
562             if (isset($b->context) && !isset($a->context)) {
563                 return 1;
564             }
565             if ($a->itemtype == 'treeitem' && $b->itemtype == 'treeitem') {
566                 // Ugh need to check that this plugin has not been uninstalled.
567                 if ($this->check_plugin_is_installed('tool_log')) {
568                     if (trim($a->name) == get_string('privacy:path:logs', 'tool_log')) {
569                         return 1;
570                     } else if (trim($b->name) == get_string('privacy:path:logs', 'tool_log')) {
571                         return -1;
572                     }
573                     return 0;
574                 }
575             }
576             if ($a->itemtype == 'treeitem' && $b->itemtype == 'item') {
577                 return -1;
578             }
579             if ($b->itemtype == 'treeitem' && $a->itemtype == 'item') {
580                 return 1;
581             }
582             return 0;
583         });
584         foreach ($tree as $treeobject) {
585             if (isset($treeobject->children)) {
586                 $this->sort_my_list($treeobject->children);
587             }
588         }
589     }
591     /**
592      * Check to see if a specified plugin is installed.
593      *
594      * @param  string $component The component name e.g. tool_log
595      * @return bool Whether this component is installed.
596      */
597     protected function check_plugin_is_installed(string $component) : Bool {
598         if (!isset($this->checkedplugins[$component])) {
599             $pluginmanager = \core_plugin_manager::instance();
600             $plugin = $pluginmanager->get_plugin_info($component);
601             $this->checkedplugins[$component] = !is_null($plugin);
602         }
603         return $this->checkedplugins[$component];
604     }
606     /**
607      * Writes the appropriate files for creating an HTML index page for human navigation of the user data export.
608      */
609     protected function write_html_data() {
610         global $PAGE, $SITE, $USER, $CFG;
612         // Do this first before adding more files to $this->files.
613         list($tree, $treekey, $allfiles) = $this->prepare_for_export();
614         // Add more detail to the tree such as contexts.
615         $richtree = $this->make_tree_object($tree, $treekey);
616         // Now that we have more detail we can use that to sort it.
617         $this->sort_my_list($richtree);
619         // Copy over the JavaScript required to display the html page.
620         $jspath = ['privacy', 'export_files', 'general.js'];
621         $targetpath = ['js', 'general.js'];
622         $this->copy_data($jspath, $targetpath);
624         $jquery = ['lib', 'jquery', 'jquery-3.4.1.min.js'];
625         $jquerydestination = ['js', 'jquery-3.4.1.min.js'];
626         $this->copy_data($jquery, $jquerydestination);
628         $requirecurrentpath = ['lib', 'requirejs', 'require.min.js'];
629         $destination = ['js', 'require.min.js'];
630         $this->copy_data($requirecurrentpath, $destination);
632         $treepath = ['lib', 'amd', 'build', 'tree.min.js'];
633         $destination = ['js', 'tree.min.js'];
634         $this->copy_data($treepath, $destination);
636         // Icons to be used.
637         $expandediconpath = ['pix', 't', 'expanded.svg'];
638         $this->copy_data($expandediconpath, ['pix', 'expanded.svg']);
639         $collapsediconpath = ['pix', 't', 'collapsed.svg'];
640         $this->copy_data($collapsediconpath, ['pix', 'collapsed.svg']);
641         $naviconpath = ['pix', 'i', 'navigationitem.svg'];
642         $this->copy_data($naviconpath, ['pix', 'navigationitem.svg']);
643         $moodleimgpath = ['pix', 'moodlelogo.svg'];
644         $this->copy_data($moodleimgpath, ['pix', 'moodlelogo.svg']);
646         // Additional required css.
647         $csspath = ['theme', 'boost', 'style', 'moodle.css'];
648         $destination = ['moodle.css'];
649         $this->copy_data($csspath, $destination);
651         $csspath = ['privacy', 'export_files', 'general.css'];
652         $destination = ['general.css'];
653         $this->copy_data($csspath, $destination);
655         // Create an index file that lists all, to be newly created, js files.
656         $encoded = json_encode($allfiles,  JSON_PRETTY_PRINT);
657         $encoded = 'var user_data_index = ' . $encoded;
659         $path = 'js' . DIRECTORY_SEPARATOR . 'data_index.js';
660         $this->write_data($path, $encoded);
662         $output = $PAGE->get_renderer('core_privacy');
663         $navigationpage = new \core_privacy\output\exported_navigation_page(current($richtree));
664         $navigationhtml = $output->render_navigation($navigationpage);
666         $systemname = format_string($SITE->fullname, true, ['context' => \context_system::instance()]);
667         $fullusername = fullname($USER);
668         $siteurl = $CFG->wwwroot;
670         // Create custom index.html file.
671         $rtl = right_to_left();
672         $htmlpage = new \core_privacy\output\exported_html_page($navigationhtml, $systemname, $fullusername, $rtl, $siteurl);
673         $outputpage = $output->render_html_page($htmlpage);
674         $this->write_data('index.html', $outputpage);
675     }
677     /**
678      * Perform any required finalisation steps and return the location of the finalised export.
679      *
680      * @return  string
681      */
682     public function finalise_content() : string {
683         $this->write_html_data();
685         $exportfile = make_request_directory() . '/export.zip';
687         $fp = get_file_packer();
688         $fp->archive_to_pathname($this->files, $exportfile);
690         // Reset the writer to prevent any further writes.
691         writer::reset();
693         return $exportfile;
694     }
696     /**
697      * Creates a multidimensional array out of array elements.
698      *
699      * @param  array  $array Array which items are to be condensed into a multidimensional array.
700      * @return array The multidimensional array.
701      */
702     protected function condense_array(array $array) : Array {
703         if (count($array) === 2) {
704             return [$array[0] => $array[1]];
705         }
706         if (isset($array[0])) {
707             return [$array[0] => $this->condense_array(array_slice($array, 1))];
708         }
709         return [];
710     }
712     /**
713      * Get the contents of a file.
714      *
715      * @param  string $filepath The file path.
716      * @return string contents of the file.
717      * @throws \moodle_exception If the file cannot be opened.
718      */
719     protected function get_file_content(string $filepath) : String {
720         $content = file_get_contents($filepath);
721         if ($content === false) {
722             throw new \moodle_exception('cannotopenfile', 'error', '', $filepath);
723         }
724         return $content;
725     }