Merge branch 'MDL-67062-master' of git://github.com/sarjona/moodle
[moodle.git] / h5p / classes / framework.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  * \core_h5p\framework class
19  *
20  * @package    core_h5p
21  * @copyright  2019 Mihail Geshoski <mihail@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_h5p;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Moodle's implementation of the H5P framework interface.
31  *
32  * @package    core_h5p
33  * @copyright  2019 Mihail Geshoski <mihail@moodle.com>
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class framework implements \H5PFrameworkInterface {
38     /** @var string The path to the last uploaded h5p */
39     private $lastuploadedfolder;
41     /** @var string The path to the last uploaded h5p file */
42     private $lastuploadedfile;
44     /** @var stored_file The .h5p file */
45     private $file;
47     /**
48      * Returns info for the current platform.
49      * Implements getPlatformInfo.
50      *
51      * @return array An associative array containing:
52      *               - name: The name of the platform, for instance "Moodle"
53      *               - version: The version of the platform, for instance "3.8"
54      *               - h5pVersion: The version of the H5P component
55      */
56     public function getPlatformInfo() {
57         global $CFG;
59         return array(
60             'name' => 'Moodle',
61             'version' => $CFG->version,
62             'h5pVersion' => $CFG->version,
63         );
64     }
66     /**
67      * Fetches a file from a remote server using HTTP GET.
68      * Implements fetchExternalData.
69      *
70      * @param string $url Where you want to get or send data
71      * @param array $data Data to post to the URL
72      * @param bool $blocking Set to 'FALSE' to instantly time out (fire and forget)
73      * @param string $stream Path to where the file should be saved
74      * @return string The content (response body). NULL if something went wrong
75      */
76     public function fetchExternalData($url, $data = null, $blocking = true, $stream = null) {
78         if ($stream === null) {
79             // Download file.
80             set_time_limit(0);
82             // Get the extension of the remote file.
83             $parsedurl = parse_url($url);
84             $ext = pathinfo($parsedurl['path'], PATHINFO_EXTENSION);
86             // Generate local tmp file path.
87             $fs = new \core_h5p\file_storage();
88             $localfolder = $fs->getTmpPath();
89             $stream = $localfolder;
91             // Add the remote file's extension to the temp file.
92             if ($ext) {
93                 $stream .= '.' . $ext;
94             }
96             $this->getUploadedH5pFolderPath($localfolder);
97             $this->getUploadedH5pPath($stream);
98         }
100         $response = download_file_content($url, null, $data, true, 300, 20,
101                 false, $stream);
103         if (empty($response->error) && ($response->status != '404')) {
104             return $response->results;
105         } else {
106             $this->setErrorMessage($response->error, 'failed-fetching-external-data');
107         }
108     }
110     /**
111      * Set the tutorial URL for a library. All versions of the library is set.
112      * Implements setLibraryTutorialUrl.
113      *
114      * @param string $libraryname
115      * @param string $url
116      */
117     public function setLibraryTutorialUrl($libraryname, $url) {
118         // Tutorial url is currently not being used or stored in libraries.
119     }
121     /**
122      * Set an error message.
123      * Implements setErrorMessage.
124      *
125      * @param string $message The error message
126      * @param string $code An optional code
127      */
128     public function setErrorMessage($message, $code = null) {
129         if ($message !== null) {
130             $this->set_message('error', $message, $code);
131         }
132     }
134     /**
135      * Set an info message.
136      * Implements setInfoMessage.
137      *
138      * @param string $message The info message
139      */
140     public function setInfoMessage($message) {
141         if ($message !== null) {
142             $this->set_message('info', $message);
143         }
144     }
146     /**
147      * Return messages.
148      * Implements getMessages.
149      *
150      * @param string $type The message type, e.g. 'info' or 'error'
151      * @return string[] Array of messages
152      */
153     public function getMessages($type) {
154         global $SESSION;
156         // Return and reset messages.
157         $messages = array();
158         if (isset($SESSION->core_h5p_messages[$type])) {
159             $messages = $SESSION->core_h5p_messages[$type];
160             unset($SESSION->core_h5p_messages[$type]);
161             if (empty($SESSION->core_h5p_messages)) {
162                 unset($SESSION->core_h5p_messages);
163             }
164         }
166         return $messages;
167     }
169     /**
170      * Translation function.
171      * The purpose of this function is to map the strings used in the core h5p methods
172      * and replace them with the translated ones. If a translation for a particular string
173      * is not available, the default message (key) will be returned.
174      * Implements t.
175      *
176      * @param string $message The english string to be translated
177      * @param array $replacements An associative array of replacements to make after translation
178      * @return string Translated string or the english string if a translation is not available
179      */
180     public function t($message, $replacements = array()) {
182         // Create mapping.
183         $translationsmap = [
184             'The file you uploaded is not a valid HTML5 Package (It does not have the .h5p file extension)' => 'noextension',
185             'The file you uploaded is not a valid HTML5 Package (We are unable to unzip it)' => 'nounzip',
186             'The main h5p.json file is not valid' => 'nojson',
187             'Library directory name must match machineName or machineName-majorVersion.minorVersion (from library.json).' .
188                 ' (Directory: %directoryName , machineName: %machineName, majorVersion: %majorVersion, minorVersion:' .
189                 ' %minorVersion)'
190                 => 'librarydirectoryerror',
191             'A valid content folder is missing' => 'missingcontentfolder',
192             'A valid main h5p.json file is missing' => 'invalidmainjson',
193             'Missing required library @library' => 'missinglibrary',
194             "Note that the libraries may exist in the file you uploaded, but you're not allowed to upload new libraries." .
195                 ' Contact the site administrator about this.' => 'missinguploadpermissions',
196             'Invalid library name: %name' => 'invalidlibraryname',
197             'Could not find library.json file with valid json format for library %name' => 'missinglibraryjson',
198             'Invalid semantics.json file has been included in the library %name' => 'invalidsemanticsjson',
199             'Invalid language file %file in library %library' => 'invalidlanguagefile',
200             'Invalid language file %languageFile has been included in the library %name' => 'invalidlanguagefile2',
201             'The file "%file" is missing from library: "%name"' => 'missinglibraryfile',
202             'The system was unable to install the <em>%component</em> component from the package, it requires a newer' .
203                 ' version of the H5P plugin. This site is currently running version %current, whereas the required version' .
204                 ' is %required or higher. You should consider upgrading and then try again.' => 'missingcoreversion',
205             "Invalid data provided for %property in %library. Boolean expected." => 'invalidlibrarydataboolean',
206             "Invalid data provided for %property in %library" => 'invalidlibrarydata',
207             "Can't read the property %property in %library" => 'invalidlibraryproperty',
208             'The required property %property is missing from %library' => 'missinglibraryproperty',
209             'Illegal option %option in %library' => 'invalidlibraryoption',
210             'Added %new new H5P library and updated %old old one.' => 'addedandupdatedss',
211             'Added %new new H5P library and updated %old old ones.' => 'addedandupdatedsp',
212             'Added %new new H5P libraries and updated %old old one.' => 'addedandupdatedps',
213             'Added %new new H5P libraries and updated %old old ones.' => 'addedandupdatedpp',
214             'Added %new new H5P library.' => 'addednewlibrary',
215             'Added %new new H5P libraries.' => 'addednewlibraries',
216             'Updated %old H5P library.' => 'updatedlibrary',
217             'Updated %old H5P libraries.' => 'updatedlibraries',
218             'Missing dependency @dep required by @lib.' => 'missingdependency',
219             'Provided string is not valid according to regexp in semantics. (value: "%value", regexp: "%regexp")'
220                 => 'invalidstring',
221             'File "%filename" not allowed. Only files with the following extensions are allowed: %files-allowed.'
222                 => 'invalidfile',
223             'Invalid selected option in multi-select.' => 'invalidmultiselectoption',
224             'Invalid selected option in select.' => 'invalidselectoption',
225             'H5P internal error: unknown content type "@type" in semantics. Removing content!' => 'invalidsemanticstype',
226             'Copyright information' => 'copyrightinfo',
227             'Title' => 'title',
228             'Author' => 'author',
229             'Year(s)' => 'years',
230             'Year' => 'year',
231             'Source' => 'source',
232             'License' => 'license',
233             'Undisclosed' => 'undisclosed',
234             'General Public License v3' => 'gpl',
235             'Public Domain' => 'pd',
236             'Public Domain Dedication and Licence' => 'pddl',
237             'Public Domain Mark' => 'pdm',
238             'Public Domain Mark (PDM)' => 'pdm',
239             'Copyright' => 'copyrightstring',
240             'The mbstring PHP extension is not loaded. H5P need this to function properly' => 'missingmbstring',
241             'The version of the H5P library %machineName used in this content is not valid. Content contains %contentLibrary, ' .
242                 'but it should be %semanticsLibrary.' => 'wrongversion',
243             'The H5P library %library used in the content is not valid' => 'invalidlibrarynamed',
244             'Fullscreen' => 'fullscreen',
245             'Disable fullscreen' => 'disablefullscreen',
246             'Download' => 'download',
247             'Rights of use' => 'copyright',
248             'Embed' => 'embed',
249             'Size' => 'size',
250             'Show advanced' => 'showadvanced',
251             'Hide advanced' => 'hideadvanced',
252             'Include this script on your website if you want dynamic sizing of the embedded content:' => 'resizescript',
253             'Close' => 'close',
254             'Thumbnail' => 'thumbnail',
255             'No copyright information available for this content.' => 'nocopyright',
256             'Download this content as a H5P file.' => 'downloadtitle',
257             'View copyright information for this content.' => 'copyrighttitle',
258             'View the embed code for this content.' => 'embedtitle',
259             'Visit H5P.org to check out more cool content.' => 'h5ptitle',
260             'This content has changed since you last used it.' => 'contentchanged',
261             "You'll be starting over." => 'startingover',
262             'by' => 'by',
263             'Show more' => 'showmore',
264             'Show less' => 'showless',
265             'Sublevel' => 'sublevel',
266             'Confirm action' => 'confirmdialogheader',
267             'Please confirm that you wish to proceed. This action is not reversible.' => 'confirmdialogbody',
268             'Cancel' => 'cancellabel',
269             'Confirm' => 'confirmlabel',
270             '4.0 International' => 'licenseCC40',
271             '3.0 Unported' => 'licenseCC30',
272             '2.5 Generic' => 'licenseCC25',
273             '2.0 Generic' => 'licenseCC20',
274             '1.0 Generic' => 'licenseCC10',
275             'General Public License' => 'licenseGPL',
276             'Version 3' => 'licenseV3',
277             'Version 2' => 'licenseV2',
278             'Version 1' => 'licenseV1',
279             'CC0 1.0 Universal (CC0 1.0) Public Domain Dedication' => 'licenseCC010',
280             'CC0 1.0 Universal' => 'licenseCC010U',
281             'License Version' => 'licenseversion',
282             'Creative Commons' => 'creativecommons',
283             'Attribution' => 'ccattribution',
284             'Attribution (CC BY)' => 'ccattribution',
285             'Attribution-ShareAlike' => 'ccattributionsa',
286             'Attribution-ShareAlike (CC BY-SA)' => 'ccattributionsa',
287             'Attribution-NoDerivs' => 'ccattributionnd',
288             'Attribution-NoDerivs (CC BY-ND)' => 'ccattributionnd',
289             'Attribution-NonCommercial' => 'ccattributionnc',
290             'Attribution-NonCommercial (CC BY-NC)' => 'ccattributionnc',
291             'Attribution-NonCommercial-ShareAlike' => 'ccattributionncsa',
292             'Attribution-NonCommercial-ShareAlike (CC BY-NC-SA)' => 'ccattributionncsa',
293             'Attribution-NonCommercial-NoDerivs' => 'ccattributionncnd',
294             'Attribution-NonCommercial-NoDerivs (CC BY-NC-ND)' => 'ccattributionncnd',
295             'Public Domain Dedication (CC0)' => 'ccpdd',
296             'Years (from)' => 'yearsfrom',
297             'Years (to)' => 'yearsto',
298             "Author's name" => 'authorname',
299             "Author's role" => 'authorrole',
300             'Editor' => 'editor',
301             'Licensee' => 'licensee',
302             'Originator' => 'originator',
303             'Any additional information about the license' => 'additionallicenseinfo',
304             'License Extras' => 'licenseextras',
305             'Changelog' => 'changelog',
306             'Content Type' => 'contenttype',
307             'Date' => 'date',
308             'Changed by' => 'changedby',
309             'Description of change' => 'changedescription',
310             'Photo cropped, text changed, etc.' => 'changeplaceholder',
311             'Author comments' => 'authorcomments',
312             'Comments for the editor of the content (This text will not be published as a part of copyright info)'
313                 => 'authorcommentsdescription',
314             'Reuse' => 'reuse',
315             'Reuse Content' => 'reuseContent',
316             'Reuse this content.' => 'reuseDescription',
317             'Content is copied to the clipboard' => 'contentCopied',
318             'Connection lost. Results will be stored and sent when you regain connection.' => 'connectionLost',
319             'Connection reestablished.' => 'connectionReestablished',
320             'Attempting to submit stored results.' => 'resubmitScores',
321             'Your connection to the server was lost' => 'offlineDialogHeader',
322             'We were unable to send information about your completion of this task. Please check your internet connection.'
323                 => 'offlineDialogBody',
324             'Retrying in :num....' => 'offlineDialogRetryMessage',
325             'Retry now' => 'offlineDialogRetryButtonLabel',
326             'Successfully submitted results.' => 'offlineSuccessfulSubmit',
327             'One of the files inside the package exceeds the maximum file size allowed. (%file %used > %max)'
328                 => 'fileExceedsMaxSize',
329             'The total size of the unpacked files exceeds the maximum size allowed. (%used > %max)'
330                 => 'unpackedFilesExceedsMaxSize',
331             'Unable to read file from the package: %fileName' => 'couldNotReadFileFromZip',
332             'Unable to parse JSON from the package: %fileName' => 'couldNotParseJSONFromZip',
333             'A problem with the server write access was detected. Please make sure that your server can write to your data folder.' => 'nowriteaccess',
334             'H5P hub communication has been disabled because one or more H5P requirements failed.' => 'hubcommunicationdisabled',
335             'Site could not be registered with the hub. Please contact your site administrator.' => 'sitecouldnotberegistered',
336             'The H5P Hub has been disabled until this problem can be resolved. You may still upload libraries through the "H5P Libraries" page.' => 'hubisdisableduploadlibraries',
337             'When you have revised your server setup you may re-enable H5P hub communication in H5P Settings.' => 'reviseserversetupandretry',
338             'You have been provided a unique key that identifies you with the Hub when receiving new updates. The key is available for viewing in the "H5P Settings" page.' => 'sitekeyregistered',
339             'Your PHP max post size is quite small. With your current setup, you may not upload files larger than {$a->%number} MB. This might be a problem when trying to upload H5Ps, images and videos. Please consider to increase it to more than 5MB' => 'maxpostsizetoosmall',
340             'Your PHP max upload size is bigger than your max post size. This is known to cause issues in some installations.' => 'uploadsizelargerthanpostsize',
341             'Your PHP max upload size is quite small. With your current setup, you may not upload files larger than {$a->%number} MB. This might be a problem when trying to upload H5Ps, images and videos. Please consider to increase it to more than 5MB.' => 'maxuploadsizetoosmall',
342             'Your PHP version does not support ZipArchive.' => 'noziparchive',
343             'Your PHP version is outdated. H5P requires version 5.2 to function properly. Version 5.6 or later is recommended.' => 'oldphpversion',
344             'Your server does not have SSL enabled. SSL should be enabled to ensure a secure connection with the H5P hub.' => 'sslnotenabled',
345             'Your site was successfully registered with the H5P Hub.' => 'successfullyregisteredwithhub'
346         ];
348         if (isset($translationsmap[$message])) {
349             return get_string($translationsmap[$message], 'core_h5p', $replacements);
350         }
352         debugging("String translation cannot be found. Please add a string definition for '" .
353             $message . "' in the core_h5p component.", DEBUG_DEVELOPER);
355         return $message;
356     }
358     /**
359      * Get URL to file in the specifimake_pluginfile_urlc library.
360      * Implements getLibraryFileUrl.
361      *
362      * @param string $libraryfoldername The name or path of the library's folder
363      * @param string $filename The file name
364      * @return string URL to file
365      */
366     public function getLibraryFileUrl($libraryfoldername, $filename) {
367         global $DB;
369         // Remove unnecessary slashes (first and last, if present) from the path to the folder
370         // of the library file.
371         $libraryfilepath = trim($libraryfoldername, '/');
373         // Get the folder name of the library from the path.
374         // The first element should represent the folder name of the library.
375         $libfoldername = explode('/', $libraryfilepath)[0];
377         $factory = new \core_h5p\factory();
378         $core = $factory->get_core();
380         // The provided folder name of the library must have a valid format (can be parsed).
381         // The folder name is parsed with a purpose of getting the library related information
382         // such as 'machineName', 'majorVersion' and 'minorVersion'.
383         // This information is later used to retrieve the library ID.
384         if (!$libdata = $core->libraryFromString($libfoldername, true)) {
385             debugging('The provided string value "' . $libfoldername .
386                 '" is not a valid name for a library folder.', DEBUG_DEVELOPER);
388             return;
389         }
391         $params = array(
392             'machinename' => $libdata['machineName'],
393             'majorversion' => $libdata['majorVersion'],
394             'minorversion' => $libdata['minorVersion']
395         );
397         $libraries = $DB->get_records('h5p_libraries', $params, 'patchversion DESC', 'id',
398             0, 1);
400         if (!$library = reset($libraries)) {
401             debugging('The library "' . $libfoldername . '" does not exist.', DEBUG_DEVELOPER);
403             return;
404         }
406         $context = \context_system::instance();
408         return \moodle_url::make_pluginfile_url($context->id, 'core_h5p', 'libraries',
409             $library->id, '/' . $libraryfilepath . '/', $filename)->out();
410     }
412     /**
413      * Get the Path to the last uploaded h5p.
414      * Implements getUploadedH5PFolderPath.
415      *
416      * @param string $setpath The path to the folder of the last uploaded h5p
417      * @return string Path to the folder where the last uploaded h5p for this session is located
418      */
419     public function getUploadedH5pFolderPath($setpath = null) {
420         if ($setpath !== null) {
421             $this->lastuploadedfolder = $setpath;
422         }
424         if (!isset($this->lastuploadedfolder)) {
425             throw new \coding_exception('Using getUploadedH5pFolderPath() before path is set');
426         }
428         return $this->lastuploadedfolder;
429     }
431     /**
432      * Get the path to the last uploaded h5p file.
433      * Implements getUploadedH5PPath.
434      *
435      * @param string $setpath The path to the last uploaded h5p
436      * @return string Path to the last uploaded h5p
437      */
438     public function getUploadedH5pPath($setpath = null) {
439         if ($setpath !== null) {
440             $this->lastuploadedfile = $setpath;
441         }
443         if (!isset($this->lastuploadedfile)) {
444             throw new \coding_exception('Using getUploadedH5pPath() before path is set');
445         }
447         return $this->lastuploadedfile;
448     }
450     /**
451      * Load addon libraries.
452      * Implements loadAddons.
453      *
454      * @return array The array containing the addon libraries
455      */
456     public function loadAddons() {
457         global $DB;
459         $addons = array();
461         $records = $DB->get_records_sql(
462                 "SELECT l1.id AS library_id,
463                             l1.machinename AS machine_name,
464                             l1.majorversion AS major_version,
465                             l1.minorversion AS minor_version,
466                             l1.patchversion AS patch_version,
467                             l1.addto AS add_to,
468                             l1.preloadedjs AS preloaded_js,
469                             l1.preloadedcss AS preloaded_css
470                        FROM {h5p_libraries} l1
471                   LEFT JOIN {h5p_libraries} l2
472                          ON l1.machinename = l2.machinename
473                         AND (l1.majorversion < l2.majorversion
474                              OR (l1.majorversion = l2.majorversion
475                                  AND l1.minorversion < l2.minorversion))
476                       WHERE l1.addto IS NOT NULL
477                         AND l2.machinename IS NULL");
479         // NOTE: These are treated as library objects but are missing the following properties:
480         // title, droplibrarycss, fullscreen, runnable, semantics.
482         // Extract num from records.
483         foreach ($records as $addon) {
484             $addons[] = \H5PCore::snakeToCamel($addon);
485         }
487         return $addons;
488     }
490     /**
491      * Load config for libraries.
492      * Implements getLibraryConfig.
493      *
494      * @param array|null $libraries List of libraries
495      * @return array|null The library config if it exists, null otherwise
496      */
497     public function getLibraryConfig($libraries = null) {
498         global $CFG;
499         return isset($CFG->core_h5p_library_config) ? $CFG->core_h5p_library_config : null;
500     }
502     /**
503      * Get a list of the current installed libraries.
504      * Implements loadLibraries.
505      *
506      * @return array Associative array containing one entry per machine name.
507      *               For each machineName there is a list of libraries(with different versions).
508      */
509     public function loadLibraries() {
510         global $DB;
512         $results = $DB->get_records('h5p_libraries', [], 'title ASC, majorversion ASC, minorversion ASC',
513             'id, machinename AS machine_name, majorversion AS major_version, minorversion AS minor_version,
514             patchversion AS patch_version, runnable, title');
516         $libraries = array();
517         foreach ($results as $library) {
518             $libraries[$library->machine_name][] = $library;
519         }
521         return $libraries;
522     }
524     /**
525      * Returns the URL to the library admin page.
526      * Implements getAdminUrl.
527      *
528      * @return string URL to admin page
529      */
530     public function getAdminUrl() {
531         // Not supported.
532     }
534     /**
535      * Return the library's ID.
536      * Implements getLibraryId.
537      *
538      * @param string $machinename The librarys machine name
539      * @param string $majorversion Major version number for library (optional)
540      * @param string $minorversion Minor version number for library (optional)
541      * @return int|bool Identifier, or false if non-existent
542      */
543     public function getLibraryId($machinename, $majorversion = null, $minorversion = null) {
544         global $DB;
546         $params = array(
547             'machinename' => $machinename
548         );
550         if ($majorversion !== null) {
551             $params['majorversion'] = $majorversion;
552         }
554         if ($minorversion !== null) {
555             $params['minorversion'] = $minorversion;
556         }
558         $libraries = $DB->get_records('h5p_libraries', $params,
559             'majorversion DESC, minorversion DESC, patchversion DESC', 'id', 0, 1);
561         // Get the latest version which matches the input parameters.
562         if ($libraries) {
563             $library = reset($libraries);
564             return $library->id ?? false;
565         }
567         return false;
568     }
570     /**
571      * Get file extension whitelist.
572      * Implements getWhitelist.
573      *
574      * The default extension list is part of h5p, but admins should be allowed to modify it.
575      *
576      * @param boolean $islibrary TRUE if this is the whitelist for a library. FALSE if it is the whitelist
577      *                           for the content folder we are getting.
578      * @param string $defaultcontentwhitelist A string of file extensions separated by whitespace.
579      * @param string $defaultlibrarywhitelist A string of file extensions separated by whitespace.
580      * @return string A string containing the allowed file extensions separated by whitespace.
581      */
582     public function getWhitelist($islibrary, $defaultcontentwhitelist, $defaultlibrarywhitelist) {
583         return $defaultcontentwhitelist . ($islibrary ? ' ' . $defaultlibrarywhitelist : '');
584     }
586     /**
587      * Is the library a patched version of an existing library?
588      * Implements isPatchedLibrary.
589      *
590      * @param array $library An associative array containing:
591      *                       - machineName: The library machine name
592      *                       - majorVersion: The librarys major version
593      *                       - minorVersion: The librarys minor version
594      *                       - patchVersion: The librarys patch version
595      * @return boolean TRUE if the library is a patched version of an existing library FALSE otherwise
596      */
597     public function isPatchedLibrary($library) {
598         global $DB;
600         $sql = "SELECT id
601                   FROM {h5p_libraries}
602                  WHERE machinename = :machinename
603                    AND majorversion = :majorversion
604                    AND minorversion = :minorversion
605                    AND patchversion < :patchversion";
607         $library = $DB->get_records_sql(
608             $sql,
609             array(
610                 'machinename' => $library['machineName'],
611                 'majorversion' => $library['majorVersion'],
612                 'minorversion' => $library['minorVersion'],
613                 'patchversion' => $library['patchVersion']
614             ),
615             0,
616             1
617         );
619         return !empty($library);
620     }
622     /**
623      * Is H5P in development mode?
624      * Implements isInDevMode.
625      *
626      * @return boolean TRUE if H5P development mode is active FALSE otherwise
627      */
628     public function isInDevMode() {
629         return false; // Not supported (Files in moodle not editable).
630     }
632     /**
633      * Is the current user allowed to update libraries?
634      * Implements mayUpdateLibraries.
635      *
636      * @return boolean TRUE if the user is allowed to update libraries,
637      *                 FALSE if the user is not allowed to update libraries.
638      */
639     public function mayUpdateLibraries() {
640         return helper::can_update_library($this->get_file());
641     }
643     /**
644      * Get the .h5p file.
645      *
646      * @return stored_file The .h5p file.
647      */
648     public function get_file(): \stored_file {
649         if (!isset($this->file)) {
650             throw new \coding_exception('Using get_file() before file is set');
651         }
653         return $this->file;
654     }
656     /**
657      * Set the .h5p file.
658      *
659      * @param  stored_file $file The .h5p file.
660      */
661     public function set_file(\stored_file $file): void {
662         $this->file = $file;
663     }
665     /**
666      * Store data about a library.
667      * Implements saveLibraryData.
668      *
669      * Also fills in the libraryId in the libraryData object if the object is new.
670      *
671      * @param array $librarydata Associative array containing:
672      *                           - libraryId: The id of the library if it is an existing library
673      *                           - title: The library's name
674      *                           - machineName: The library machineName
675      *                           - majorVersion: The library's majorVersion
676      *                           - minorVersion: The library's minorVersion
677      *                           - patchVersion: The library's patchVersion
678      *                           - runnable: 1 if the library is a content type, 0 otherwise
679      *                           - fullscreen(optional): 1 if the library supports fullscreen, 0 otherwise
680      *                           - embedtypes: list of supported embed types
681      *                           - preloadedJs(optional): list of associative arrays containing:
682      *                             - path: path to a js file relative to the library root folder
683      *                           - preloadedCss(optional): list of associative arrays containing:
684      *                             - path: path to css file relative to the library root folder
685      *                           - dropLibraryCss(optional): list of associative arrays containing:
686      *                             - machineName: machine name for the librarys that are to drop their css
687      *                           - semantics(optional): Json describing the content structure for the library
688      * @param bool $new Whether it is a new or existing library.
689      */
690     public function saveLibraryData(&$librarydata, $new = true) {
691         global $DB;
693         // Some special properties needs some checking and converting before they can be saved.
694         $preloadedjs = $this->library_parameter_values_to_csv($librarydata, 'preloadedJs', 'path');
695         $preloadedcss = $this->library_parameter_values_to_csv($librarydata, 'preloadedCss', 'path');
696         $droplibrarycss = $this->library_parameter_values_to_csv($librarydata, 'dropLibraryCss', 'machineName');
698         if (!isset($librarydata['semantics'])) {
699             $librarydata['semantics'] = '';
700         }
701         if (!isset($librarydata['fullscreen'])) {
702             $librarydata['fullscreen'] = 0;
703         }
704         $embedtypes = '';
705         if (isset($librarydata['embedTypes'])) {
706             $embedtypes = implode(', ', $librarydata['embedTypes']);
707         }
709         $library = (object) array(
710             'title' => $librarydata['title'],
711             'machinename' => $librarydata['machineName'],
712             'majorversion' => $librarydata['majorVersion'],
713             'minorversion' => $librarydata['minorVersion'],
714             'patchversion' => $librarydata['patchVersion'],
715             'runnable' => $librarydata['runnable'],
716             'fullscreen' => $librarydata['fullscreen'],
717             'embedtypes' => $embedtypes,
718             'preloadedjs' => $preloadedjs,
719             'preloadedcss' => $preloadedcss,
720             'droplibrarycss' => $droplibrarycss,
721             'semantics' => $librarydata['semantics'],
722             'addto' => isset($librarydata['addTo']) ? json_encode($librarydata['addTo']) : null,
723             'coremajor' => isset($librarydata['coreApi']['majorVersion']) ? $librarydata['coreApi']['majorVersion'] : null,
724             'coreminor' => isset($librarydata['coreApi']['majorVersion']) ? $librarydata['coreApi']['minorVersion'] : null,
725         );
727         if ($new) {
728             // Create new library and keep track of id.
729             $library->id = $DB->insert_record('h5p_libraries', $library);
730             $librarydata['libraryId'] = $library->id;
731         } else {
732             // Update library data.
733             $library->id = $librarydata['libraryId'];
734             // Save library data.
735             $DB->update_record('h5p_libraries', $library);
736             // Remove old dependencies.
737             $this->deleteLibraryDependencies($librarydata['libraryId']);
738         }
739     }
741     /**
742      * Insert new content.
743      * Implements insertContent.
744      *
745      * @param array $content An associative array containing:
746      *                       - id: The content id
747      *                       - params: The content in json format
748      *                       - library: An associative array containing:
749      *                         - libraryId: The id of the main library for this content
750      *                       - disable: H5P Button display options
751      *                       - pathnamehash: The pathnamehash linking the record with the entry in the mdl_files table
752      *                       - contenthash: The contenthash linking the record with the entry in the mdl_files table
753      * @param int $contentmainid Main id for the content if this is a system that supports versions
754      * @return int The ID of the newly inserted content
755      */
756     public function insertContent($content, $contentmainid = null) {
757         return $this->updateContent($content);
758     }
760     /**
761      * Update old content or insert new content.
762      * Implements updateContent.
763      *
764      * @param array $content An associative array containing:
765      *                       - id: The content id
766      *                       - params: The content in json format
767      *                       - library: An associative array containing:
768      *                         - libraryId: The id of the main library for this content
769      *                       - disable: H5P Button display options
770      *                       - pathnamehash: The pathnamehash linking the record with the entry in the mdl_files table
771      *                       - contenthash: The contenthash linking the record with the entry in the mdl_files table
772      * @param int $contentmainid Main id for the content if this is a system that supports versions
773      * @return int The ID of the newly inserted or updated content
774      */
775     public function updateContent($content, $contentmainid = null) {
776         global $DB;
778         if (!isset($content['pathnamehash'])) {
779             $content['pathnamehash'] = '';
780         }
782         if (!isset($content['contenthash'])) {
783             $content['contenthash'] = '';
784         }
786         // If the libraryid declared in the package is empty, get the latest version.
787         if (empty($content['library']['libraryId'])) {
788             $mainlibrary = $this->get_latest_library_version($content['library']['machineName']);
789             if (empty($mainlibrary)) {
790                 // Raise an error if the main library is not defined and the latest version doesn't exist.
791                 $message = $this->t('Missing required library @library', ['@library' => $content['library']['machineName']]);
792                 $this->setErrorMessage($message, 'missing-required-library');
793                 return false;
794             }
795             $content['library']['libraryId'] = $mainlibrary->id;
796         }
798         $data = [
799             'jsoncontent' => $content['params'],
800             'displayoptions' => $content['disable'],
801             'mainlibraryid' => $content['library']['libraryId'],
802             'timemodified' => time(),
803             'filtered' => null,
804             'pathnamehash' => $content['pathnamehash'],
805             'contenthash' => $content['contenthash']
806         ];
808         if (!isset($content['id'])) {
809             $data['timecreated'] = $data['timemodified'];
810             $id = $DB->insert_record('h5p', $data);
811         } else {
812             $id = $data['id'] = $content['id'];
813             $DB->update_record('h5p', $data);
814         }
816         return $id;
817     }
819     /**
820      * Resets marked user data for the given content.
821      * Implements resetContentUserData.
822      *
823      * @param int $contentid The h5p content id
824      */
825     public function resetContentUserData($contentid) {
826         // Currently, we do not store user data for a content.
827     }
829     /**
830      * Save what libraries a library is depending on.
831      * Implements saveLibraryDependencies.
832      *
833      * @param int $libraryid Library Id for the library we're saving dependencies for
834      * @param array $dependencies List of dependencies as associative arrays containing:
835      *                            - machineName: The library machineName
836      *                            - majorVersion: The library's majorVersion
837      *                            - minorVersion: The library's minorVersion
838      * @param string $dependencytype The type of dependency
839      */
840     public function saveLibraryDependencies($libraryid, $dependencies, $dependencytype) {
841         global $DB;
843         foreach ($dependencies as $dependency) {
844             // Find dependency library.
845             $dependencylibrary = $DB->get_record('h5p_libraries',
846                 array(
847                     'machinename' => $dependency['machineName'],
848                     'majorversion' => $dependency['majorVersion'],
849                     'minorversion' => $dependency['minorVersion']
850                 )
851             );
853             // Create relation.
854             $DB->insert_record('h5p_library_dependencies', array(
855                 'libraryid' => $libraryid,
856                 'requiredlibraryid' => $dependencylibrary->id,
857                 'dependencytype' => $dependencytype
858             ));
859         }
860     }
862     /**
863      * Give an H5P the same library dependencies as a given H5P.
864      * Implements copyLibraryUsage.
865      *
866      * @param int $contentid Id identifying the content
867      * @param int $copyfromid Id identifying the content to be copied
868      * @param int $contentmainid Main id for the content, typically used in frameworks
869      */
870     public function copyLibraryUsage($contentid, $copyfromid, $contentmainid = null) {
871         // Currently not being called.
872     }
874     /**
875      * Deletes content data.
876      * Implements deleteContentData.
877      *
878      * @param int $contentid Id identifying the content
879      */
880     public function deleteContentData($contentid) {
881         global $DB;
883         // Remove content.
884         $DB->delete_records('h5p', array('id' => $contentid));
886         // Remove content library dependencies.
887         $this->deleteLibraryUsage($contentid);
888     }
890     /**
891      * Delete what libraries a content item is using.
892      * Implements deleteLibraryUsage.
893      *
894      * @param int $contentid Content Id of the content we'll be deleting library usage for
895      */
896     public function deleteLibraryUsage($contentid) {
897         global $DB;
899         $DB->delete_records('h5p_contents_libraries', array('h5pid' => $contentid));
900     }
902     /**
903      * Saves what libraries the content uses.
904      * Implements saveLibraryUsage.
905      *
906      * @param int $contentid Id identifying the content
907      * @param array $librariesinuse List of libraries the content uses
908      */
909     public function saveLibraryUsage($contentid, $librariesinuse) {
910         global $DB;
912         $droplibrarycsslist = array();
913         foreach ($librariesinuse as $dependency) {
914             if (!empty($dependency['library']['dropLibraryCss'])) {
915                 $droplibrarycsslist = array_merge($droplibrarycsslist,
916                         explode(', ', $dependency['library']['dropLibraryCss']));
917             }
918         }
920         foreach ($librariesinuse as $dependency) {
921             $dropcss = in_array($dependency['library']['machineName'], $droplibrarycsslist) ? 1 : 0;
922             $DB->insert_record('h5p_contents_libraries', array(
923                 'h5pid' => $contentid,
924                 'libraryid' => $dependency['library']['libraryId'],
925                 'dependencytype' => $dependency['type'],
926                 'dropcss' => $dropcss,
927                 'weight' => $dependency['weight']
928             ));
929         }
930     }
932     /**
933      * Get number of content/nodes using a library, and the number of dependencies to other libraries.
934      * Implements getLibraryUsage.
935      *
936      * @param int $id Library identifier
937      * @param boolean $skipcontent Optional. Set as true to get number of content instances for library
938      * @return array The array contains two elements, keyed by 'content' and 'libraries'.
939      *               Each element contains a number
940      */
941     public function getLibraryUsage($id, $skipcontent = false) {
942         global $DB;
944         if ($skipcontent) {
945             $content = -1;
946         } else {
947             $sql = "SELECT COUNT(distinct c.id)
948                       FROM {h5p_libraries} l
949                       JOIN {h5p_contents_libraries} cl ON l.id = cl.libraryid
950                       JOIN {h5p} c ON cl.h5pid = c.id
951                      WHERE l.id = :libraryid";
953             $sqlargs = array(
954                 'libraryid' => $id
955             );
957             $content = $DB->count_records_sql($sql, $sqlargs);
958         }
960         $libraries = $DB->count_records('h5p_library_dependencies', ['requiredlibraryid' => $id]);
962         return array(
963             'content' => $content,
964             'libraries' => $libraries,
965         );
966     }
968     /**
969      * Loads a library.
970      * Implements loadLibrary.
971      *
972      * @param string $machinename The library's machine name
973      * @param int $majorversion The library's major version
974      * @param int $minorversion The library's minor version
975      * @return array|bool Returns FALSE if the library does not exist
976      *                     Otherwise an associative array containing:
977      *                     - libraryId: The id of the library if it is an existing library,
978      *                     - title: The library's name,
979      *                     - machineName: The library machineName
980      *                     - majorVersion: The library's majorVersion
981      *                     - minorVersion: The library's minorVersion
982      *                     - patchVersion: The library's patchVersion
983      *                     - runnable: 1 if the library is a content type, 0 otherwise
984      *                     - fullscreen: 1 if the library supports fullscreen, 0 otherwise
985      *                     - embedTypes: list of supported embed types
986      *                     - preloadedJs: comma separated string with js file paths
987      *                     - preloadedCss: comma separated sting with css file paths
988      *                     - dropLibraryCss: list of associative arrays containing:
989      *                       - machineName: machine name for the librarys that are to drop their css
990      *                     - semantics: Json describing the content structure for the library
991      *                     - preloadedDependencies(optional): list of associative arrays containing:
992      *                       - machineName: Machine name for a library this library is depending on
993      *                       - majorVersion: Major version for a library this library is depending on
994      *                       - minorVersion: Minor for a library this library is depending on
995      *                     - dynamicDependencies(optional): list of associative arrays containing:
996      *                       - machineName: Machine name for a library this library is depending on
997      *                       - majorVersion: Major version for a library this library is depending on
998      *                       - minorVersion: Minor for a library this library is depending on
999      */
1000     public function loadLibrary($machinename, $majorversion, $minorversion) {
1001         global $DB;
1003         $library = $DB->get_record('h5p_libraries', array(
1004             'machinename' => $machinename,
1005             'majorversion' => $majorversion,
1006             'minorversion' => $minorversion
1007         ));
1009         if (!$library) {
1010             return false;
1011         }
1013         $librarydata = array(
1014             'libraryId' => $library->id,
1015             'title' => $library->title,
1016             'machineName' => $library->machinename,
1017             'majorVersion' => $library->majorversion,
1018             'minorVersion' => $library->minorversion,
1019             'patchVersion' => $library->patchversion,
1020             'runnable' => $library->runnable,
1021             'fullscreen' => $library->fullscreen,
1022             'embedTypes' => $library->embedtypes,
1023             'preloadedJs' => $library->preloadedjs,
1024             'preloadedCss' => $library->preloadedcss,
1025             'dropLibraryCss' => $library->droplibrarycss,
1026             'semantics'     => $library->semantics
1027         );
1029         $sql = 'SELECT hl.id, hl.machinename, hl.majorversion, hl.minorversion, hll.dependencytype
1030                   FROM {h5p_library_dependencies} hll
1031                   JOIN {h5p_libraries} hl ON hll.requiredlibraryid = hl.id
1032                  WHERE hll.libraryid = :libraryid
1033               ORDER BY hl.id ASC';
1035         $sqlargs = array(
1036             'libraryid' => $library->id
1037         );
1039         $dependencies = $DB->get_records_sql($sql, $sqlargs);
1041         foreach ($dependencies as $dependency) {
1042             $librarydata[$dependency->dependencytype . 'Dependencies'][] = array(
1043                 'machineName' => $dependency->machinename,
1044                 'majorVersion' => $dependency->majorversion,
1045                 'minorVersion' => $dependency->minorversion
1046             );
1047         }
1049         return $librarydata;
1050     }
1052     /**
1053      * Loads library semantics.
1054      * Implements loadLibrarySemantics.
1055      *
1056      * @param string $name Machine name for the library
1057      * @param int $majorversion The library's major version
1058      * @param int $minorversion The library's minor version
1059      * @return string The library's semantics as json
1060      */
1061     public function loadLibrarySemantics($name, $majorversion, $minorversion) {
1062         global $DB;
1064         $semantics = $DB->get_field('h5p_libraries', 'semantics',
1065             array(
1066                 'machinename' => $name,
1067                 'majorversion' => $majorversion,
1068                 'minorversion' => $minorversion
1069             )
1070         );
1072         return ($semantics === false ? null : $semantics);
1073     }
1075     /**
1076      * Makes it possible to alter the semantics, adding custom fields, etc.
1077      * Implements alterLibrarySemantics.
1078      *
1079      * @param array $semantics Associative array representing the semantics
1080      * @param string $name The library's machine name
1081      * @param int $majorversion The library's major version
1082      * @param int $minorversion The library's minor version
1083      */
1084     public function alterLibrarySemantics(&$semantics, $name, $majorversion, $minorversion) {
1085         global $DB;
1087         $library = $DB->get_record('h5p_libraries',
1088             array(
1089                 'machinename' => $name,
1090                 'majorversion' => $majorversion,
1091                 'minorversion' => $minorversion,
1092             )
1093         );
1095         if ($library) {
1096             $library->semantics = json_encode($semantics);
1097             $DB->update_record('h5p_libraries', $library);
1098         }
1099     }
1101     /**
1102      * Delete all dependencies belonging to given library.
1103      * Implements deleteLibraryDependencies.
1104      *
1105      * @param int $libraryid Library identifier
1106      */
1107     public function deleteLibraryDependencies($libraryid) {
1108         global $DB;
1110         $DB->delete_records('h5p_library_dependencies', array('libraryid' => $libraryid));
1111     }
1113     /**
1114      * Start an atomic operation against the dependency storage.
1115      * Implements lockDependencyStorage.
1116      */
1117     public function lockDependencyStorage() {
1118         // Library development mode not supported.
1119     }
1121     /**
1122      * Start an atomic operation against the dependency storage.
1123      * Implements unlockDependencyStorage.
1124      */
1125     public function unlockDependencyStorage() {
1126         // Library development mode not supported.
1127     }
1129     /**
1130      * Delete a library from database and file system.
1131      * Implements deleteLibrary.
1132      *
1133      * @param stdClass $library Library object with id, name, major version and minor version
1134      */
1135     public function deleteLibrary($library) {
1136         $factory = new \core_h5p\factory();
1137         \core_h5p\api::delete_library($factory, $library);
1138     }
1140     /**
1141      * Load content.
1142      * Implements loadContent.
1143      *
1144      * @param int $id Content identifier
1145      * @return array Associative array containing:
1146      *               - id: Identifier for the content
1147      *               - params: json content as string
1148      *               - embedType: list of supported embed types
1149      *               - disable: H5P Button display options
1150      *               - title: H5P content title
1151      *               - slug: Human readable content identifier that is unique
1152      *               - libraryId: Id for the main library
1153      *               - libraryName: The library machine name
1154      *               - libraryMajorVersion: The library's majorVersion
1155      *               - libraryMinorVersion: The library's minorVersion
1156      *               - libraryEmbedTypes: CSV of the main library's embed types
1157      *               - libraryFullscreen: 1 if fullscreen is supported. 0 otherwise
1158      *               - metadata: The content's metadata
1159      */
1160     public function loadContent($id) {
1161         global $DB;
1163         $sql = "SELECT hc.id, hc.jsoncontent, hc.displayoptions, hl.id AS libraryid,
1164                        hl.machinename, hl.title, hl.majorversion, hl.minorversion, hl.fullscreen,
1165                        hl.embedtypes, hl.semantics, hc.filtered
1166                   FROM {h5p} hc
1167                   JOIN {h5p_libraries} hl ON hl.id = hc.mainlibraryid
1168                  WHERE hc.id = :h5pid";
1170         $sqlargs = array(
1171             'h5pid' => $id
1172         );
1174         $data = $DB->get_record_sql($sql, $sqlargs);
1176         // Return null if not found.
1177         if ($data === false) {
1178             return null;
1179         }
1181         // Some databases do not support camelCase, so we need to manually
1182         // map the values to the camelCase names used by the H5P core.
1183         $content = array(
1184             'id' => $data->id,
1185             'params' => $data->jsoncontent,
1186             // It has been decided that the embedtype will be always set to 'iframe' (at least for now) because the 'div'
1187             // may cause conflicts with CSS and JS in some cases.
1188             'embedType' => 'iframe',
1189             'disable' => $data->displayoptions,
1190             'title' => $data->title,
1191             'slug' => \H5PCore::slugify($data->title) . '-' . $data->id,
1192             'filtered' => $data->filtered,
1193             'libraryId' => $data->libraryid,
1194             'libraryName' => $data->machinename,
1195             'libraryMajorVersion' => $data->majorversion,
1196             'libraryMinorVersion' => $data->minorversion,
1197             'libraryEmbedTypes' => $data->embedtypes,
1198             'libraryFullscreen' => $data->fullscreen,
1199             'metadata' => ''
1200         );
1202         return $content;
1203     }
1205     /**
1206      * Load dependencies for the given content of the given type.
1207      * Implements loadContentDependencies.
1208      *
1209      * @param int $id Content identifier
1210      * @param int $type The dependency type
1211      * @return array List of associative arrays containing:
1212      *               - libraryId: The id of the library if it is an existing library
1213      *               - machineName: The library machineName
1214      *               - majorVersion: The library's majorVersion
1215      *               - minorVersion: The library's minorVersion
1216      *               - patchVersion: The library's patchVersion
1217      *               - preloadedJs(optional): comma separated string with js file paths
1218      *               - preloadedCss(optional): comma separated sting with css file paths
1219      *               - dropCss(optional): csv of machine names
1220      *               - dependencyType: The dependency type
1221      */
1222     public function loadContentDependencies($id, $type = null) {
1223         global $DB;
1225         $query = "SELECT hcl.id AS unidepid, hl.id AS library_id, hl.machinename AS machine_name,
1226                          hl.majorversion AS major_version, hl.minorversion AS minor_version,
1227                          hl.patchversion AS patch_version, hl.preloadedcss AS preloaded_css,
1228                          hl.preloadedjs AS preloaded_js, hcl.dropcss AS drop_css,
1229                          hcl.dependencytype as dependency_type
1230                     FROM {h5p_contents_libraries} hcl
1231                     JOIN {h5p_libraries} hl ON hcl.libraryid = hl.id
1232                    WHERE hcl.h5pid = :h5pid";
1233         $queryargs = array(
1234             'h5pid' => $id
1235         );
1237         if ($type !== null) {
1238             $query .= " AND hcl.dependencytype = :dependencytype";
1239             $queryargs['dependencytype'] = $type;
1240         }
1242         $query .= " ORDER BY hcl.weight";
1243         $data = $DB->get_records_sql($query, $queryargs);
1245         $dependencies = array();
1246         foreach ($data as $dependency) {
1247             unset($dependency->unidepid);
1248             $dependencies[$dependency->machine_name] = \H5PCore::snakeToCamel($dependency);
1249         }
1251         return $dependencies;
1252     }
1254     /**
1255      * Get stored setting.
1256      * Implements getOption.
1257      *
1258      * @param string $name Identifier for the setting
1259      * @param string $default Optional default value if settings is not set
1260      * @return mixed Return  Whatever has been stored as the setting
1261      */
1262     public function getOption($name, $default = false) {
1263         if ($name == core::DISPLAY_OPTION_DOWNLOAD || $name == core::DISPLAY_OPTION_EMBED) {
1264             // For now, the download and the embed displayoptions are disabled by default, so only will be rendered when
1265             // defined in the displayoptions DB field.
1266             // This check should be removed if they are added as new H5P settings, to let admins to define the default value.
1267             return \H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_OFF;
1268         }
1270         $value = get_config('core_h5p', $name);
1271         if ($value === false) {
1272             return $default;
1273         }
1274         return $value;
1275     }
1277     /**
1278      * Stores the given setting.
1279      * For example when did we last check h5p.org for updates to our libraries.
1280      * Implements setOption.
1281      *
1282      * @param string $name Identifier for the setting
1283      * @param mixed $value Data Whatever we want to store as the setting
1284      */
1285     public function setOption($name, $value) {
1286         set_config($name, $value, 'core_h5p');
1287     }
1289     /**
1290      * This will update selected fields on the given content.
1291      * Implements updateContentFields().
1292      *
1293      * @param int $id Content identifier
1294      * @param array $fields Content fields, e.g. filtered
1295      */
1296     public function updateContentFields($id, $fields) {
1297         global $DB;
1299         $content = new \stdClass();
1300         $content->id = $id;
1302         foreach ($fields as $name => $value) {
1303             // Skip 'slug' as it currently does not exist in the h5p content table.
1304             if ($name == 'slug') {
1305                 continue;
1306             }
1308             $content->$name = $value;
1309         }
1311         $DB->update_record('h5p', $content);
1312     }
1314     /**
1315      * Will clear filtered params for all the content that uses the specified.
1316      * libraries. This means that the content dependencies will have to be rebuilt and the parameters re-filtered.
1317      * Implements clearFilteredParameters().
1318      *
1319      * @param array $libraryids Array of library ids
1320      */
1321     public function clearFilteredParameters($libraryids) {
1322         global $DB;
1324         if (empty($libraryids)) {
1325             return;
1326         }
1328         list($insql, $inparams) = $DB->get_in_or_equal($libraryids);
1330         $DB->set_field_select('h5p', 'filtered', null,
1331             "mainlibraryid $insql", $inparams);
1332     }
1334     /**
1335      * Get number of contents that has to get their content dependencies rebuilt.
1336      * and parameters re-filtered.
1337      * Implements getNumNotFiltered().
1338      *
1339      * @return int The number of contents that has to get their content dependencies rebuilt
1340      *             and parameters re-filtered
1341      */
1342     public function getNumNotFiltered() {
1343         global $DB;
1345         $sql = "SELECT COUNT(id)
1346                   FROM {h5p}
1347                  WHERE " . $DB->sql_compare_text('filtered') . " IS NULL";
1349         return $DB->count_records_sql($sql);
1350     }
1352     /**
1353      * Get number of contents using library as main library.
1354      * Implements getNumContent().
1355      *
1356      * @param int $libraryid The library ID
1357      * @param array $skip The array of h5p content ID's that should be ignored
1358      * @return int The number of contents using library as main library
1359      */
1360     public function getNumContent($libraryid, $skip = null) {
1361         global $DB;
1363         $notinsql = '';
1364         $params = array();
1366         if (!empty($skip)) {
1367             list($sql, $params) = $DB->get_in_or_equal($skip, SQL_PARAMS_NAMED, 'param', false);
1368             $notinsql = " AND id {$sql}";
1369         }
1371         $sql = "SELECT COUNT(id)
1372                   FROM {h5p}
1373                  WHERE mainlibraryid = :libraryid {$notinsql}";
1375         $params['libraryid'] = $libraryid;
1377         return $DB->count_records_sql($sql, $params);
1378     }
1380     /**
1381      * Determines if content slug is used.
1382      * Implements isContentSlugAvailable.
1383      *
1384      * @param string $slug The content slug
1385      * @return boolean Whether the content slug is used
1386      */
1387     public function isContentSlugAvailable($slug) {
1388         // By default the slug should be available as it's currently generated as a unique
1389         // value for each h5p content (not stored in the h5p table).
1390         return true;
1391     }
1393     /**
1394      * Generates statistics from the event log per library.
1395      * Implements getLibraryStats.
1396      *
1397      * @param string $type Type of event to generate stats for
1398      * @return array Number values indexed by library name and version
1399      */
1400     public function getLibraryStats($type) {
1401         // Event logs are not being stored.
1402     }
1404     /**
1405      * Aggregate the current number of H5P authors.
1406      * Implements getNumAuthors.
1407      *
1408      * @return int The current number of H5P authors
1409      */
1410     public function getNumAuthors() {
1411         // Currently, H5P authors are not being stored.
1412     }
1414     /**
1415      * Stores hash keys for cached assets, aggregated JavaScripts and
1416      * stylesheets, and connects it to libraries so that we know which cache file
1417      * to delete when a library is updated.
1418      * Implements saveCachedAssets.
1419      *
1420      * @param string $key Hash key for the given libraries
1421      * @param array $libraries List of dependencies(libraries) used to create the key
1422      */
1423     public function saveCachedAssets($key, $libraries) {
1424         global $DB;
1426         foreach ($libraries as $library) {
1427             $cachedasset = new \stdClass();
1428             $cachedasset->libraryid = $library['libraryId'];
1429             $cachedasset->hash = $key;
1431             $DB->insert_record('h5p_libraries_cachedassets', $cachedasset);
1432         }
1433     }
1435     /**
1436      * Locate hash keys for given library and delete them.
1437      * Used when cache file are deleted.
1438      * Implements deleteCachedAssets.
1439      *
1440      * @param int $libraryid Library identifier
1441      * @return array List of hash keys removed
1442      */
1443     public function deleteCachedAssets($libraryid) {
1444         global $DB;
1446         // Get all the keys so we can remove the files.
1447         $results = $DB->get_records('h5p_libraries_cachedassets', ['libraryid' => $libraryid]);
1449         $hashes = array_map(function($result) {
1450             return $result->hash;
1451         }, $results);
1453         if (!empty($hashes)) {
1454             list($sql, $params) = $DB->get_in_or_equal($hashes, SQL_PARAMS_NAMED);
1455             // Remove all invalid keys.
1456             $DB->delete_records_select('h5p_libraries_cachedassets', 'hash ' . $sql, $params);
1458             // Remove also the cachedassets files.
1459             $fs = new file_storage();
1460             $fs->deleteCachedAssets($hashes);
1461         }
1463         return $hashes;
1464     }
1466     /**
1467      * Get the amount of content items associated to a library.
1468      * Implements getLibraryContentCount.
1469      *
1470      * return array The number of content items associated to a library
1471      */
1472     public function getLibraryContentCount() {
1473         global $DB;
1475         $contentcount = array();
1477         $sql = "SELECT h.mainlibraryid,
1478                        l.machinename,
1479                        l.majorversion,
1480                        l.minorversion,
1481                        COUNT(h.id) AS count
1482                   FROM {h5p} h
1483              LEFT JOIN {h5p_libraries} l
1484                     ON h.mainlibraryid = l.id
1485               GROUP BY h.mainlibraryid, l.machinename, l.majorversion, l.minorversion";
1487         // Count content using the same content type.
1488         $res = $DB->get_records_sql($sql);
1490         // Extract results.
1491         foreach ($res as $lib) {
1492             $contentcount["{$lib->machinename} {$lib->majorversion}.{$lib->minorversion}"] = $lib->count;
1493         }
1495         return $contentcount;
1496     }
1498     /**
1499      * Will trigger after the export file is created.
1500      * Implements afterExportCreated.
1501      *
1502      * @param array $content The content
1503      * @param string $filename The file name
1504      */
1505     public function afterExportCreated($content, $filename) {
1506         // Not being used.
1507     }
1509     /**
1510      * Check whether a user has permissions to execute an action, such as embed H5P content.
1511      * Implements hasPermission.
1512      *
1513      * @param  \H5PPermission $permission Permission type
1514      * @param  int $id Id need by platform to determine permission
1515      * @return boolean true if the user can execute the action defined in $permission; false otherwise
1516      */
1517     public function hasPermission($permission, $id = null) {
1518         // H5P capabilities have not been introduced.
1519     }
1521     /**
1522      * Replaces existing content type cache with the one passed in.
1523      * Implements replaceContentTypeCache.
1524      *
1525      * @param object $contenttypecache Json with an array called 'libraries' containing the new content type cache
1526      *                                 that should replace the old one
1527      */
1528     public function replaceContentTypeCache($contenttypecache) {
1529         // Currently, content type caches are not being stored.
1530     }
1532     /**
1533      * Checks if the given library has a higher version.
1534      * Implements libraryHasUpgrade.
1535      *
1536      * @param array $library An associative array containing:
1537      *                       - machineName: The library machineName
1538      *                       - majorVersion: The library's majorVersion
1539      *                       - minorVersion: The library's minorVersion
1540      * @return boolean Whether the library has a higher version
1541      */
1542     public function libraryHasUpgrade($library) {
1543         global $DB;
1545         $sql = "SELECT id
1546                   FROM {h5p_libraries}
1547                  WHERE machinename = :machinename
1548                    AND (majorversion > :majorversion1
1549                     OR (majorversion = :majorversion2 AND minorversion > :minorversion))";
1551         $results = $DB->get_records_sql(
1552             $sql,
1553             array(
1554                 'machinename' => $library['machineName'],
1555                 'majorversion1' => $library['majorVersion'],
1556                 'majorversion2' => $library['majorVersion'],
1557                 'minorversion' => $library['minorVersion']
1558             ),
1559             0,
1560             1
1561         );
1563         return !empty($results);
1564     }
1566     /**
1567      * Get current H5P language code.
1568      *
1569      * @return string Language Code
1570      */
1571     public static function get_language() {
1572         static $map;
1574         if (empty($map)) {
1575             // Create mapping for "converting" language codes.
1576             $map = array(
1577                 'no' => 'nb'
1578             );
1579         }
1581         // Get current language in Moodle.
1582         $language = str_replace('_', '-', strtolower(\current_language()));
1584         // Try to map.
1585         return $map[$language] ?? $language;
1586     }
1588     /**
1589      * Store messages until they can be printed to the current user.
1590      *
1591      * @param string $type Type of messages, e.g. 'info', 'error', etc
1592      * @param string $newmessage The message
1593      * @param string $code The message code
1594      */
1595     private function set_message(string $type, string $newmessage = null, string $code = null) {
1596         global $SESSION;
1598         // We expect to get out an array of strings when getting info
1599         // and an array of objects when getting errors for consistency across platforms.
1600         // This implementation should be improved for consistency across the data type returned here.
1601         if ($type === 'error') {
1602             $SESSION->core_h5p_messages[$type][] = (object) array(
1603                 'code' => $code,
1604                 'message' => $newmessage
1605             );
1606         } else {
1607             $SESSION->core_h5p_messages[$type][] = $newmessage;
1608         }
1609     }
1611     /**
1612      * Convert list of library parameter values to csv.
1613      *
1614      * @param array $librarydata Library data as found in library.json files
1615      * @param string $key Key that should be found in $librarydata
1616      * @param string $searchparam The library parameter (Default: 'path')
1617      * @return string Library parameter values separated by ', '
1618      */
1619     private function library_parameter_values_to_csv(array $librarydata, string $key, string $searchparam = 'path'): string {
1620         if (isset($librarydata[$key])) {
1621             $parametervalues = array();
1622             foreach ($librarydata[$key] as $file) {
1623                 foreach ($file as $index => $value) {
1624                     if ($index === $searchparam) {
1625                         $parametervalues[] = $value;
1626                     }
1627                 }
1628             }
1629             return implode(', ', $parametervalues);
1630         }
1631         return '';
1632     }
1634     /**
1635      * Get the latest library version.
1636      *
1637      * @param  string $machinename The library's machine name
1638      * @return stdClass|null An object with the latest library version
1639      */
1640     public function get_latest_library_version(string $machinename): ?\stdClass {
1641         global $DB;
1643         $libraries = $DB->get_records('h5p_libraries', ['machinename' => $machinename],
1644             'majorversion DESC, minorversion DESC, patchversion DESC', '*', 0, 1);
1645         if ($libraries) {
1646             return reset($libraries);
1647         }
1649         return null;
1650     }