MDL-66609 core_h5p: Player and embed.php implementation
[moodle.git] / h5p / lib.php
CommitLineData
35b62d00
SA
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/>.
16
17/**
18 * Callbacks.
19 *
20 * @package core_h5p
21 * @copyright 2019 Bas Brands <bas@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24defined('MOODLE_INTERNAL') || die();
25
26/**
27 * Serve the files from the core_h5p file areas.
28 *
29 * @package core_h5p
30 * @category files
31 *
32 * @param stdClass $course the course object
33 * @param stdClass $cm the course module object
34 * @param stdClass $context the newmodule's context
35 * @param string $filearea the name of the file area
36 * @param array $args extra arguments (itemid, path)
37 * @param bool $forcedownload whether or not force download
38 * @param array $options additional options affecting the file serving
39 *
40 * @return bool Returns false if we don't find a file.
41 */
42function core_h5p_pluginfile($course, $cm, $context, string $filearea, array $args, bool $forcedownload,
43 array $options = []) : bool {
44 global $DB;
45
46 $filesettingsset = false;
47
48 switch ($filearea) {
49 default:
50 return false; // Invalid file area.
51
52 case \core_h5p\file_storage::LIBRARY_FILEAREA:
53 if ($context->contextlevel != CONTEXT_SYSTEM) {
54 return false; // Invalid context because the libraries are loaded always in the context system.
55 }
56
57 $itemid = null;
58
59 // The files that can be delivered to this function are unfortunately out of our control. Some of the
60 // references are embedded into the JavaScript of the files and we have no ability to inject an item id.
61 // We also don't know the location of the item id when we do include it, so we look for the first numeric
62 // value and try to serve that file.
63 foreach ($args as $key => $value) {
64 if (is_numeric($value)) {
65 $itemid = $value;
66 unset($args[$key]);
67 break;
68 }
69 }
70
71 if (!isset($itemid)) {
72 // We didn't find an item id to use, so we fall back to retrieving the record using all the other
73 // fields. The combination of component, filearea, filepath, and filename is enough for a unique
74 // record.
75 $filename = array_pop($args);
76 $filepath = '/' . implode('/', $args) . '/';
77 $itemid = $DB->get_field('files', 'itemid', [
78 'component' => \core_h5p\file_storage::COMPONENT,
79 'filearea' => \core_h5p\file_storage::LIBRARY_FILEAREA,
80 'filepath' => $filepath,
81 'filename' => $filename
82 ]);
83 $filesettingsset = true;
84 }
85 break;
86 case \core_h5p\file_storage::CONTENT_FILEAREA:
87 if ($context->contextlevel != CONTEXT_SYSTEM) {
88 return false; // Invalid context because the content files are loaded always in the context system.
89 }
90 $itemid = array_shift($args);
91 break;
92 case \core_h5p\file_storage::CACHED_ASSETS_FILEAREA:
93 case \core_h5p\file_storage::EXPORT_FILEAREA:
94 $itemid = 0;
95 break;
96 }
97
98 if (!$filesettingsset) {
99 $filename = array_pop($args);
100 $filepath = (!$args ? '/' : '/' . implode('/', $args) . '/');
101 }
102
103 $fs = get_file_storage();
104 $file = $fs->get_file($context->id, \core_h5p\file_storage::COMPONENT, $filearea, $itemid, $filepath, $filename);
105 if (!$file) {
106 return false; // No such file.
107 }
108
109 send_stored_file($file, null, 0, $forcedownload, $options);
110
111 return true;
112}