├── .gitignore
├── pix
    ├── icon.png
    └── icon.svg
├── templates
    ├── contact_site_administrator.mustache
    ├── iframe_embedding_disabled.mustache
    ├── mobile_view_page.mustache
    └── review.mustache
├── .jshintrc
├── .gitmodules
├── thirdpartylibs.xml
├── embed.css
├── settings-hide-key.js
├── version.php
├── db
    ├── events.php
    ├── mobile.php
    ├── messages.php
    ├── tasks.php
    ├── install.php
    └── access.php
├── editor.js
├── dataviews.js
├── classes
    ├── event
    │   ├── course_module_instance_list_viewed.php
    │   ├── attempt_submitted.php
    │   └── course_module_viewed.php
    ├── task
    │   ├── remove_old_log_entries.php
    │   ├── look_for_updates.php
    │   ├── remove_old_auth_tokens.php
    │   └── remove_tmpfiles.php
    ├── content_type_cache_form.php
    ├── event.php
    ├── output
    │   └── mobile.php
    ├── mobile_auth.php
    ├── xapi_result.php
    ├── upload_libraries_form.php
    ├── editor_ajax.php
    ├── user_grades.php
    ├── content_user_data.php
    └── view_assets.php
├── xapi-custom-report.css
├── styles.css
├── README.md
├── view.php
├── renderer.php
├── backup
    └── moodle2
    │   ├── backup_hvp_activity_task.class.php
    │   ├── restore_hvp_activity_task.class.php
    │   ├── backup_hvp_stepslib.php
    │   └── restore_hvp_stepslib.php
├── autoloader.php
├── embed.php
├── embed.js
├── index.php
├── .travis.yml
├── upgrade_content_page.php
├── grade.php
├── library_list.php
├── xapi-collector.js
├── .eslintrc
├── settings.php
├── review.php
└── ajax.php


/.gitignore:
--------------------------------------------------------------------------------
1 | files/tmp/*
2 | files/content/*
3 | files/libraries/*
4 | *~
5 | 


--------------------------------------------------------------------------------
/pix/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marinaglancy/moodle-mod_hvp/stable/pix/icon.png


--------------------------------------------------------------------------------
/templates/contact_site_administrator.mustache:
--------------------------------------------------------------------------------
1 | <div style="padding: 1em;">This site is not configured properly for displaying mobile H5P content. Please contact a site administrator.</div>


--------------------------------------------------------------------------------
/.jshintrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "esversion": 6,
 3 |   "globals": {
 4 |     "H5PDataView": true,
 5 |     "H5P": true,
 6 |     "H5PIntegration": true,
 7 |     "HVPSettingsHideKey": true,
 8 |     "console": true
 9 |   }
10 | }
11 | 


--------------------------------------------------------------------------------
/templates/iframe_embedding_disabled.mustache:
--------------------------------------------------------------------------------
1 | <div style="padding: 1em">
2 |     <div>Iframe embedding must be enabled in order to display H5P content in the mobile app.</div>
3 |     <div>You can enable it by checking "Allow frame embedding" in <a href="/admin/settings.php?section=httpsecurity" core-link>Site Administration / Security / Http Security</a></div>
4 | </div>


--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
 1 | [submodule "library"]
 2 | 	path = library
 3 | 	url = https://github.com/h5p/h5p-php-library.git
 4 | 	branch = stable
 5 | [submodule "editor"]
 6 | 	path = editor
 7 | 	url = https://github.com/h5p/h5p-editor-php-library.git
 8 | 	branch = stable
 9 | [submodule "reporting"]
10 | 	path = reporting
11 | 	url = https://github.com/h5p/h5p-php-report.git
12 | 	branch = stable
13 | 


--------------------------------------------------------------------------------
/templates/mobile_view_page.mustache:
--------------------------------------------------------------------------------
 1 | {{=<% %>=}}
 2 | <div style="height: 100%; width: 100%; background: white;">
 3 |     <iframe
 4 |             src="<% wwwroot %>/mod/hvp/embed.php?id=<% cmid %>&user_id=<% user_id %>&secret=<% secret %>"
 5 |             frameborder="0"
 6 |             allow="microphone; camera"
 7 |             allowfullscreen="allowfullscreen">
 8 |     </iframe>
 9 | </div>
10 | 


--------------------------------------------------------------------------------
/thirdpartylibs.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <libraries>
 3 |     <library>
 4 |         <location>library</location>
 5 |         <name>H5P Core</name>
 6 |         <version>1.13</version>
 7 |         <license>MIT</license>
 8 |     </library>
 9 |     <library>
10 |         <location>editor</location>
11 |         <name>H5P Editor</name>
12 |         <version>(86b5450)</version>
13 |         <license>MIT</license>
14 |     </library>
15 |     <library>
16 |         <location>reporting</location>
17 |         <name>H5P Reporting</name>
18 |         <version>(8fe2c5d)</version>
19 |         <license>MIT</license>
20 |     </library>
21 | </libraries>
22 | 


--------------------------------------------------------------------------------
/embed.css:
--------------------------------------------------------------------------------
 1 | body.h5p-embed {
 2 |     font-family: Sans-Serif;
 3 |     width: 100%;
 4 |     height: 100%;
 5 |     margin: 0;
 6 |     padding: 0;
 7 | }
 8 | 
 9 | body.h5p-embed.h5p-resizing {
10 |     overflow: hidden;
11 | }
12 | 
13 | body.h5p-embed .h5p-container {
14 |     overflow: hidden;
15 | }
16 | 
17 | body.h5p-embed .h5p-content {
18 |     font-size: 16px;
19 |     line-height: 1.5em;
20 |     width: 100%;
21 |     height: auto;
22 | }
23 | 
24 | body.h5p-embed .h5p-fullscreen .h5p-content,
25 | body.h5p-embed .h5p-semi-fullscreen .h5p-content {
26 |     height: 100%;
27 | }
28 | 
29 | body.h5p-embed .clearer,
30 | body.h5p-embed #maincontent,
31 | body.h5p-embed #user-notifications {
32 |     display: none;
33 | }


--------------------------------------------------------------------------------
/settings-hide-key.js:
--------------------------------------------------------------------------------
 1 | /* global HVPSettingsHideKey */
 2 | /**
 3 |  * Prepares for hiding of the Site Key setting since you cannot modify attributes and such in Moodle.
 4 |  */
 5 | (function($) {
 6 |     $(document).ready(function() {
 7 |         if (!window.HVPSettingsHideKey) {
 8 |             return;
 9 |         }
10 | 
11 |         var $input = $('#' + HVPSettingsHideKey.input);
12 |         if (!$input.length) {
13 |             return;
14 |         }
15 | 
16 |         var placeHolder = $input.val() || HVPSettingsHideKey.value ? HVPSettingsHideKey.placeholder : HVPSettingsHideKey.empty;
17 |         $input.attr('maxlength', 36)
18 |             .attr('placeholder', placeHolder)
19 |             .data('value', HVPSettingsHideKey.value)
20 |             .val('');
21 | 
22 |         $('<button/>', {
23 |             'type': 'button',
24 |             'class': 'h5p-reveal-value',
25 |             'text': HVPSettingsHideKey.reveal,
26 |             'data': {
27 |                 'control': HVPSettingsHideKey.input,
28 |                 'hide': HVPSettingsHideKey.hide
29 |             },
30 |             insertAfter: $input
31 |         });
32 |     });
33 | })(H5P.jQuery);
34 | 


--------------------------------------------------------------------------------
/version.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/>.
16 | 
17 | /**
18 |  * @package    mod
19 |  * @subpackage hvp
20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 |  */
23 | 
24 | defined('MOODLE_INTERNAL') || die();
25 | 
26 | $plugin->version   = 2020080400;
27 | $plugin->requires  = 2013051403;
28 | $plugin->cron      = 0;
29 | $plugin->component = 'mod_hvp';
30 | $plugin->maturity  = MATURITY_STABLE;
31 | $plugin->release   = '1.21.0';
32 | 


--------------------------------------------------------------------------------
/db/events.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/>.
16 | 
17 | /**
18 |  * Add event handlers for H5P
19 |  *
20 |  * @package    mod_hvp
21 |  * @category   event
22 |  * @copyright  2020 Joubel AS <contact@joubel.com>
23 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 |  */
25 | 
26 | 
27 | defined('MOODLE_INTERNAL') || die();
28 | 
29 | $observers = array(
30 | 
31 |     // Handle attempt submitted event, as a way to send confirmation messages asynchronously.
32 |     array(
33 |         'eventname'   => '\mod_hvp\event\attempt_submitted',
34 |         'includefile' => '/mod/hvp/locallib.php',
35 |         'callback'    => 'hvp_attempt_submitted_handler',
36 |         'internal'    => false
37 |     ),
38 | );
39 | 


--------------------------------------------------------------------------------
/editor.js:
--------------------------------------------------------------------------------
 1 | (function($) {
 2 | 
 3 |   /**
 4 |    * Get closest row of element
 5 |    *
 6 |    * @param {jQuery} $el
 7 |    * @returns {jQuery}
 8 |    */
 9 |   function getRow($el) {
10 |     return $el.closest('.fitem');
11 |   }
12 | 
13 |     /**
14 |      * Initializes editor
15 |      */
16 |   function init() {
17 |     var $editor = $('.h5p-editor');
18 |     var $fileField = $('input[name="h5pfile"]');
19 | 
20 |     if (H5PIntegration.hubIsEnabled) {
21 |       // TODO: This can easily break in new themes. Improve robustness of this
22 |       // by not including h5paction in form, when it should not be used.
23 |       $('input[name="h5paction"]').parents('.fitem').last().hide();
24 |     }
25 | 
26 |     const mformId = H5PIntegration.editor && H5PIntegration.editor.formId !== null
27 |       ? H5PIntegration.editor.formId
28 |       : 'mform1';
29 | 
30 |     // Cancel validation and submission of form if clicking cancel button
31 |     const cancelSubmitCallback = function ($button) {
32 |       return $button.is('[name="cancel"]');
33 |     };
34 | 
35 |     H5PEditor.init(
36 |       $('#' + mformId),
37 |       $('input[name="h5paction"]'),
38 |       getRow($fileField),
39 |       getRow($editor),
40 |       $editor,
41 |       $('input[name="h5plibrary"]'),
42 |       $('input[name="h5pparams"]'),
43 |       $('input[name="h5pmaxscore"]'),
44 |       $('input[name="name"]'),
45 |       cancelSubmitCallback
46 |     );
47 |   }
48 | 
49 |   $(document).ready(init);
50 | })(H5P.jQuery);
51 | 


--------------------------------------------------------------------------------
/db/mobile.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/>.
16 | 
17 | defined('MOODLE_INTERNAL') || die();
18 | 
19 | $addons = array(
20 |     "mod_hvp" => array( // Plugin identifier.
21 |         'handlers' => array( // Different places where the plugin will display content.
22 |             'coursehvp' => array( // Handler unique name (alphanumeric).
23 |                 'delegate'    => 'CoreCourseModuleDelegate', // Delegate (where to display the link to the plugin).
24 |                 'method'      => 'mobile_course_view', // Main function in \mod_certificate\output\mobile.
25 |                 'displaydata' => array(
26 |                     'icon'  => $CFG->wwwroot . '/mod/hvp/pix/icon.svg',
27 |                     'class' => '',
28 |                 ),
29 |             )
30 |         )
31 |     )
32 | );
33 | 


--------------------------------------------------------------------------------
/dataviews.js:
--------------------------------------------------------------------------------
 1 | /* global H5PDataView */
 2 | (function($) {
 3 | 
 4 |     /**
 5 |    * Creates a new dataview.
 6 |    *
 7 |    * @private
 8 |    * @param {object} dataView Structure
 9 |    * @param {string} dataView.source AJAX URL for data view
10 |    * @param {object[]} dataView.headers Header text and props
11 |    * @param {boolean[]} dataView.filters Which fields to allow filtering for
12 |    * @param {object} dataView.order Default order by and direction
13 |    * @param {object} dataView.l10n Translations
14 |    * @param {Element} wrapper Where in the DOM should the dataview be appended
15 |    * @param {function} loaded Callback for when the dataview is ready
16 |    */
17 |     var createDataView = function(dataView, wrapper, loaded) {
18 |         new H5PDataView(
19 |         wrapper,
20 |         dataView.source,
21 |         dataView.headers,
22 |         dataView.l10n,
23 |         undefined,
24 |         dataView.filters,
25 |         loaded,
26 |         dataView.order
27 |         );
28 |     };
29 | 
30 |     // Create data views when page is done loading.
31 |     $(document).ready(function() {
32 |         for (var id in H5PIntegration.dataViews) {
33 |             if (!H5PIntegration.dataViews.hasOwnProperty(id)) {
34 |                 continue;
35 |             }
36 | 
37 |             var wrapper = $('#' + id).get(0);
38 |             if (wrapper !== undefined) {
39 |                 createDataView(H5PIntegration.dataViews[id], wrapper);
40 |             }
41 |         }
42 |     });
43 | })(H5P.jQuery);
44 | 


--------------------------------------------------------------------------------
/pix/icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!-- Generator: Adobe Illustrator 19.2.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
 3 | <svg version="1.1" width="24" height="24" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
 4 | 	 viewBox="0 0 1000 1000" style="enable-background:new 0 0 1000 1000;" xml:space="preserve">
 5 | <style type="text/css">
 6 | 	.st0{fill:#1D1D1D;}
 7 | 	.st1{fill:#FFFFFF;}
 8 | </style>
 9 | <g>
10 | 	<rect class="st0" width="1000" height="1000"/>
11 | 	<g>
12 | 		<path class="st1" d="M880,347.5c-20.1-19.2-50.3-28.5-90.6-28.5H682h-29v73H490.7l-13.3,56.3c11.1-5.2,26.8-9.7,37.7-12.3
13 | 			c10.9-2.6,21.7-1.8,32.3-1.8c36.1,0,65.3,11.2,87.8,33c22.5,21.8,33.7,49.4,33.7,82.5c0,23.3-5.8,45.7-17.3,67.2
14 | 			c-11.6,21.5-28,38.4-49.2,49.7c-7.6,4.1-16,3.8-25.2,10.4H682h29V545h66.1c44.9,0,78.3-10.1,100.2-30.6
15 | 			c21.9-20.5,32.8-48.8,32.8-85.2C910.1,393.8,900.1,366.7,880,347.5z M788.6,460.4c-8.7,7.5-23.8,10.6-45.3,10.6H711v-79h36.8
16 | 			c20.8,0,35,3.8,42.6,11.7c7.5,7.9,11.3,17.1,11.3,28.4C801.7,443.7,797.3,452.9,788.6,460.4z"/>
17 | 		<path class="st1" d="M511.5,499.3c-19.5,0-36.3,11.3-44.4,27.6l-97.6-13.3L413.6,319h-58.3H323v152H206V319H94v358h112V545h117
18 | 			v132h32.3H459c-16.6-6.6-30.8-11.6-42.5-20.4c-11.9-8.9-21.5-19.3-28.9-30.6c-7.4-11.3-13.2-24-18.1-40.9l97.7-14.1
19 | 			c8.1,16.2,24.9,27.3,44.3,27.3c27.4,0,49.6-22.2,49.6-49.6C561,521.5,538.8,499.3,511.5,499.3z"/>
20 | 	</g>
21 | </g>
22 | </svg>
23 | 


--------------------------------------------------------------------------------
/classes/event/course_module_instance_list_viewed.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/>.
16 | 
17 | /**
18 |  * The mod_hvp instance list viewed event.
19 |  *
20 |  * @package    mod_hvp
21 |  * @copyright  @copyright  2016 Joubel AS <contact@joubel.com>
22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 |  */
24 | 
25 | namespace mod_hvp\event;
26 | 
27 | defined('MOODLE_INTERNAL') || die();
28 | 
29 | /**
30 |  * The mod_hvp instance list viewed event class.
31 |  *
32 |  * @package    mod_hvp
33 |  * @copyright  @copyright  2016 Joubel AS <contact@joubel.com>
34 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 |  */
36 | class course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed
37 | {
38 |     // No code required here as the parent class handles it all.
39 | }
40 | 


--------------------------------------------------------------------------------
/templates/review.mustache:
--------------------------------------------------------------------------------
 1 | <div class="clearer"></div>
 2 | <div class="h5p-reporting-main-container">
 3 |   <div class="h5p-reporting-main-header">
 4 | 
 5 |     <!--Title-->
 6 |     <div class="h5p-reporting-main-title">{{title}}</div>
 7 | 
 8 |     <!--Scoring-->
 9 |     {{# maxScore }}
10 |     <div class="h5p-reporting-main-score-wrapper">
11 | 
12 |       <!--Raw score-->
13 |       <div class="h5p-reporting-main-score-container">
14 |         <span class="h5p-reporting-main-score-label">
15 |           {{# str }} reportingscorelabel, mod_hvp {{/ str }}
16 |         </span>
17 |         <span class="h5p-reporting-main-score">
18 |           <span class="h5p-reporting-main-score-raw-score">
19 |             {{rawScore}}
20 |           </span>
21 |           {{# str }} reportingscoredelimiter, mod_hvp {{/ str }} {{maxScore}}
22 |         </span>
23 |       </div>
24 | 
25 |       <!--Scaled score-->
26 |       <div class="h5p-reporting-main-scaled-container">
27 |         <span class="h5p-reporting-scaled-label">
28 |           {{# str }} reportingscaledscorelabel, mod_hvp {{/ str }}
29 |         </span>
30 |         <span class="h5p-reporting-scaled-score">
31 |           <span class="h5p-reporting-main-score-scaled-score">
32 |             {{scaledScore}}
33 |           </span>
34 |           {{# str }} reportingscoredelimiter, mod_hvp {{/ str }} {{maxScaledScore}}
35 |         </span>
36 |       </div>
37 |     </div>
38 |     {{/ maxScore }}
39 | 
40 |   </div>
41 | 
42 |   <!--Render report as html-->
43 |   <div class="h5p-report-view">{{{report}}}</div>
44 | </div>
45 | 


--------------------------------------------------------------------------------
/db/messages.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/>.
16 | 
17 | /**
18 |  * Defines message providers (types of message sent) for the hvp module.
19 |  *
20 |  * @package   mod_hvp
21 |  * @copyright 2020 Joubel AS <contact@joubel.com>
22 |  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 |  */
24 | 
25 | defined('MOODLE_INTERNAL') || die();
26 | 
27 | $messageproviders = array(
28 |     // Notify teacher that a student has submitted an attempt.
29 |     'submission' => array(
30 |         'capability' => 'mod/hvp:emailnotifysubmission'
31 |     ),
32 | 
33 |     // Confirm a student's quiz attempt.
34 |     'confirmation' => array(
35 |         'capability' => 'mod/hvp:emailconfirmsubmission',
36 |         'defaults' => array(
37 |             'airnotifier' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_LOGGEDIN + MESSAGE_DEFAULT_LOGGEDOFF,
38 |         ),
39 |     ),
40 | );
41 | 


--------------------------------------------------------------------------------
/classes/event/attempt_submitted.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/>.
16 | 
17 | /**
18 |  * Attempt submitted event
19 |  *
20 |  * @package    mod_hvp
21 |  * @copyright  2020 Joubel AS <contact@joubel.com>
22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 |  */
24 | 
25 | namespace mod_hvp\event;
26 | 
27 | defined('MOODLE_INTERNAL') || die();
28 | 
29 | /**
30 |  * The mod_hvp instance list viewed event class.
31 |  *
32 |  * @package    mod_hvp
33 |  * @copyright  @copyright  2016 Joubel AS <contact@joubel.com>
34 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 |  */
36 | class attempt_submitted extends \core\event\base
37 | {
38 | 
39 |     /**
40 |      * @inheritDoc
41 |      */
42 |     protected function init() {
43 |         $this->data['crud'] = 'u';
44 |         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/classes/event/course_module_viewed.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/>.
16 | 
17 | /**
18 |  * The mod_hvp course module viewed event.
19 |  *
20 |  * @package    mod_hvp
21 |  * @copyright  @copyright  2016 Joubel AS <contact@joubel.com>
22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 |  */
24 | 
25 | namespace mod_hvp\event;
26 | 
27 | defined('MOODLE_INTERNAL') || die();
28 | 
29 | /**
30 |  * The mod_hvp course module viewed event class.
31 |  *
32 |  * @package    mod_hvp
33 |  * @copyright  @copyright  2016 Joubel AS <contact@joubel.com>
34 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 |  */
36 | class course_module_viewed extends \core\event\course_module_viewed
37 | {
38 | 
39 |     /**
40 |      * Set basic properties for the event.
41 |      */
42 |     protected function init() {
43 |         $this->data['objecttable'] = 'hvp';
44 |         $this->data['crud'] = 'r';
45 |         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/xapi-custom-report.css:
--------------------------------------------------------------------------------
 1 | body .h5p-result {
 2 |     background: #FFF;
 3 |     border: solid 1px #C9C9C9;
 4 |     box-shadow: 0 0 20px 0 rgba(0, 0, 0, 0.12);
 5 |     color: #5C5C5C;
 6 |     font-size: 15px;
 7 |     height: auto;
 8 |     margin: 1em 0;
 9 |     padding: 30px;
10 | }
11 | 
12 | body .h5p-compound-container {
13 |     border: none;
14 |     box-shadow: none;
15 |     margin: 0;
16 |     padding: 0;
17 | }
18 | 
19 | body .h5p-reporting-main-title {
20 |     display: inline-block;
21 |     font-size: 1.3em;
22 |     font-weight: 600;
23 | }
24 | 
25 | body .h5p-reporting-main-container {
26 |     margin: 10px;
27 | }
28 | 
29 | body .h5p-reporting-main-header {
30 |     display: flex;
31 |     justify-content: space-between;
32 |     align-items: center;
33 |     margin-bottom: 10px;
34 | 
35 |     background-color: #F3F3F3;
36 |     border-bottom: solid 1px #DFDFDF;
37 |     padding: 0.7em 2em;
38 | }
39 | 
40 | body .h5p-reporting-main-score-wrapper {
41 |     display: inline-block;
42 |     font-size: 0.95em;
43 |     font-weight: bold;
44 |     text-align: right;
45 | }
46 | 
47 | body .h5p-reporting-scaled-label,
48 | body .h5p-reporting-main-score-label {
49 |     font-weight: normal;
50 | }
51 | 
52 | /* Properly formats content after it has been cleaned */
53 | body .h5p-reporting-main-score-container,
54 | body .h5p-reporting-main-scaled-container {
55 |     display: block;
56 | }
57 | 
58 | body .h5p-reporting-main-score-label,
59 | body .h5p-reporting-main-score,
60 | body .h5p-reporting-score-label,
61 | body .h5p-reporting-score,
62 | body .h5p-reporting-scaled-label,
63 | body .h5p-reporting-scaled-score {
64 |     display: inline-block;
65 | }
66 | 
67 | body .h5p-reporting-main-score {
68 |     margin-left: 0.4em;
69 | }
70 | 


--------------------------------------------------------------------------------
/classes/task/remove_old_log_entries.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/>.
16 | /**
17 |  * Defines the task which looks for H5P updates.
18 |  *
19 |  * @package    mod_hvp
20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 |  */
23 | 
24 | namespace mod_hvp\task;
25 | 
26 | defined('MOODLE_INTERNAL') || die();
27 | 
28 | /**
29 |  * The mod_hvp look for updates task class
30 |  *
31 |  * @package    mod_hvp
32 |  * @copyright  2016 Joubel AS <contact@joubel.com>
33 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 |  */
35 | class remove_old_log_entries extends \core\task\scheduled_task {
36 |     public function get_name() {
37 |         return get_string('removeoldlogentries', 'mod_hvp');
38 |     }
39 | 
40 |     public function execute() {
41 |         global $DB;
42 | 
43 |         require_once(__DIR__ . '/../../autoloader.php');
44 |         // @codingStandardsIgnoreLine
45 |         $olderthan = (time() - \H5PEventBase::$log_time);
46 |         $DB->execute("DELETE FROM {hvp_events} WHERE created_at < {$olderthan}");
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/classes/task/look_for_updates.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/>.
16 | /**
17 |  * Defines the task which looks for H5P updates.
18 |  *
19 |  * @package    mod_hvp
20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 |  */
23 | 
24 | namespace mod_hvp\task;
25 | 
26 | defined('MOODLE_INTERNAL') || die();
27 | 
28 | /**
29 |  * The mod_hvp look for updates task class
30 |  *
31 |  * @package    mod_hvp
32 |  * @copyright  2016 Joubel AS <contact@joubel.com>
33 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 |  */
35 | class look_for_updates extends \core\task\scheduled_task {
36 |     public function get_name() {
37 |         return get_string('lookforupdates', 'mod_hvp');
38 |     }
39 | 
40 |     public function execute() {
41 |         // Check to make sure external communications hasn't been disabled.
42 |         if (get_config('mod_hvp', 'hub_is_enabled') || get_config('mod_hvp', 'send_usage_statistics')) {
43 |             $core = \mod_hvp\framework::instance();
44 |             $core->fetchLibrariesMetadata();
45 |         }
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/classes/task/remove_old_auth_tokens.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/>.
16 | 
17 | /**
18 |  * Defines the task which removes old mobile auth tokens from the hvp_auth table.
19 |  *
20 |  * @package    mod_hvp
21 |  * @copyright  2019 Joubel AS <contact@joubel.com>
22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 |  */
24 | 
25 | namespace mod_hvp\task;
26 | 
27 | use mod_hvp\mobile_auth;
28 | 
29 | defined('MOODLE_INTERNAL') || die();
30 | 
31 | /**
32 |  * The mod_hvp remove old auth tokens class
33 |  *
34 |  * @package    mod_hvp
35 |  * @copyright  2019 Joubel AS <contact@joubel.com>
36 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 |  */
38 | class remove_old_auth_tokens extends \core\task\scheduled_task {
39 |     public function get_name() {
40 |         return get_string('removeoldmobileauthentries', 'mod_hvp');
41 |     }
42 | 
43 |     public function execute() {
44 |         global $DB;
45 | 
46 |         require_once(__DIR__ . '/../../autoloader.php');
47 |         $deletethreshold = time() - mobile_auth::VALID_TIME;
48 |         $DB->delete_records_select('hvp_auth', 'created_at < :threshold', array(
49 |             'threshold' => $deletethreshold,
50 |         ));
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/styles.css:
--------------------------------------------------------------------------------
 1 | .h5p-data-view table {
 2 |     border: 1px solid #E5E5E5;
 3 |     box-shadow: 0 1px 1px rgba(0, 0, 0, .04);
 4 |     table-layout: fixed;
 5 |     width: 100%;
 6 | }
 7 | 
 8 | .h5p-data-view td,
 9 | .h5p-data-view th {
10 |     color: #555;
11 |     font-size: 13px;
12 |     line-height: 1.5em;
13 |     padding: 8px 10px;
14 |     vertical-align: top;
15 |     word-wrap: break-word;
16 | }
17 | 
18 | .h5p-data-view th {
19 |     color: #32373C;
20 |     font-size: 14px;
21 |     font-weight: normal;
22 |     line-height: 1.4em;
23 | }
24 | 
25 | .h5p-data-view thead th {
26 |     border-bottom: 1px solid #E1E1E1;
27 | }
28 | 
29 | .h5p-data-view tfoot td {
30 |     border-top: 1px solid #E1E1E1;
31 |     font-size: 14px;
32 | }
33 | 
34 | .h5p-data-view tr:nth-child(odd) {
35 |     background-color: #F9F9F9;
36 | }
37 | 
38 | .h5p-pagination {
39 |     line-height: 2em;
40 |     text-align: center;
41 | }
42 | 
43 | .h5p-pagination > span,
44 | .h5p-pagination > input {
45 |     margin: 0 1em;
46 | }
47 | 
48 | .h5p-pagination button {
49 |     margin: 0;
50 | }
51 | 
52 | .h5p-data-view input[type="text"] {
53 |     margin-bottom: 0.5em;
54 | }
55 | 
56 | .h5p-data-view input[type="text"]::-ms-clear {
57 |     display: none;
58 | }
59 | 
60 | .h5p-data-view th[role="button"] {
61 |     cursor: pointer;
62 | }
63 | 
64 | .h5p-data-view th[role="button"].h5p-sort:after,
65 | .h5p-data-view th[role="button"]:hover:after,
66 | .h5p-data-view th[role="button"].h5p-sort.h5p-reverse:hover:after {
67 |     content: "\25BE";
68 |     left: 0.5em;
69 |     position: relative;
70 |     top: -1px;
71 | }
72 | 
73 | .h5p-data-view th[role="button"].h5p-sort.h5p-reverse:after,
74 | .h5p-data-view th[role="button"].h5p-sort:hover:after {
75 |     content: "\25B4";
76 |     top: -2px;
77 | }
78 | 
79 | .h5p-data-view th[role="button"]:hover:after,
80 | .h5p-data-view th[role="button"].h5p-sort.h5p-reverse:hover:after,
81 | .h5p-data-view th[role="button"].h5p-sort:hover:after {
82 |     color: #999;
83 | }
84 | .content-upgrade-log {
85 |   color: red;
86 | }
87 | 


--------------------------------------------------------------------------------
/db/tasks.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/>.
16 | /**
17 |  * Defines the task which looks for H5P updates.
18 |  *
19 |  * @package    mod_hvp
20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 |  */
23 | 
24 | defined('MOODLE_INTERNAL') || die();
25 | 
26 | $tasks = array(
27 |     array(
28 |         'classname' => 'mod_hvp\task\look_for_updates',
29 |         'blocking' => 0,
30 |         'minute' => 'R',
31 |         'hour' => 'R',
32 |         'day' => '*',
33 |         'dayofweek' => '*',
34 |         'month' => '*'
35 |     ),
36 |     array(
37 |         'classname' => 'mod_hvp\task\remove_tmpfiles',
38 |         'blocking' => 0,
39 |         'minute' => 'R',
40 |         'hour' => 'R',
41 |         'day' => '*',
42 |         'dayofweek' => '*',
43 |         'month' => '*'
44 |     ),
45 |     array(
46 |         'classname' => 'mod_hvp\task\remove_old_log_entries',
47 |         'blocking' => 0,
48 |         'minute' => 'R',
49 |         'hour' => 'R',
50 |         'day' => '*',
51 |         'dayofweek' => '*',
52 |         'month' => '*'
53 |     ),
54 |     array(
55 |         'classname' => 'mod_hvp\task\remove_old_auth_tokens',
56 |         'blocking' => 0,
57 |         'minute' => 'R',
58 |         'hour' => '*',
59 |         'day' => '*',
60 |         'dayofweek' => '*',
61 |         'month' => '*'
62 |     )
63 | );
64 | 


--------------------------------------------------------------------------------
/classes/content_type_cache_form.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/>.
16 | /**
17 |  * \mod_hvp\content_type_cache_form class
18 |  *
19 |  * @package    mod_hvp
20 |  * @copyright  2017 Joubel AS
21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 |  */
23 | namespace mod_hvp;
24 | 
25 | defined('MOODLE_INTERNAL') || die();
26 | 
27 | global $CFG;
28 | require_once($CFG->libdir . '/formslib.php');
29 | 
30 | /**
31 |  * Form to update the content type cache that mirrors the available libraries in the H5P hub.
32 |  *
33 |  * @package    mod_hvp
34 |  * @copyright  2017 Joubel AS
35 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 |  */
37 | class content_type_cache_form extends \moodleform {
38 | 
39 |     /**
40 |      * Define form elements
41 |      */
42 |     public function definition() {
43 |         // Get form.
44 |         $mform = $this->_form;
45 | 
46 |         // Get and format date.
47 |         $lastupdate = get_config('mod_hvp', 'content_type_cache_updated_at');
48 | 
49 |         $dateformatted = $lastupdate ? \userdate($lastupdate) : get_string('ctcacheneverupdated', 'hvp');
50 | 
51 |         // Add last update info.
52 |         $mform->addElement('static', 'lastupdate',
53 |             get_string('ctcachelastupdatelabel', 'hvp'), $dateformatted);
54 | 
55 |         $mform->addElement('static', 'lastupdatedescription', '',
56 |             get_string('ctcachedescription', 'hvp'));
57 | 
58 |         // Update cache button.
59 |         $this->add_action_buttons(false, get_string('ctcachebuttonlabel', 'hvp'));
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/classes/task/remove_tmpfiles.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/>.
16 | /**
17 |  * Defines the task which removes old tmp files
18 |  *
19 |  * @package    mod_hvp
20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 |  */
23 | 
24 | namespace mod_hvp\task;
25 | 
26 | defined('MOODLE_INTERNAL') || die();
27 | 
28 | /**
29 |  * The mod_hvp look for updates task class
30 |  *
31 |  * @package    mod_hvp
32 |  * @copyright  2016 Joubel AS <contact@joubel.com>
33 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 |  */
35 | class remove_tmpfiles extends \core\task\scheduled_task {
36 |     public function get_name() {
37 |         return get_string('removetmpfiles', 'mod_hvp');
38 |     }
39 | 
40 |     public function execute() {
41 |         global $DB;
42 |         $tmpfiles = $DB->get_records_sql(
43 |                 "SELECT f.id
44 |                    FROM {hvp_tmpfiles} tf
45 |                    JOIN {files} f ON f.id = tf.id
46 |                   WHERE f.timecreated < ?",
47 |                 array(time() - 86400)
48 |         );
49 |         if (empty($tmpfiles)) {
50 |             return; // Nothing to clean up.
51 |         }
52 | 
53 |         $fs = get_file_storage();
54 |         foreach ($tmpfiles as $tmpfile) {
55 |             // Delete file.
56 |             $file = $fs->get_file_by_id($tmpfile->id);
57 |             $file->delete();
58 | 
59 |             // Remove tmpfile entry.
60 |             $DB->delete_records('hvp_tmpfiles', array('id' => $tmpfile->id));
61 |         }
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/db/install.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/>.
16 | 
17 | defined('MOODLE_INTERNAL') || die();
18 | 
19 | function xmldb_hvp_install() {
20 | 
21 |     // Try to install all the default content types.
22 |     require_once(__DIR__ . '/../autoloader.php');
23 | 
24 |     // Fetch info about library updates.
25 |     $core = \mod_hvp\framework::instance('core');
26 |     $core->fetchLibrariesMetadata();
27 | 
28 |     // Check that plugin is set up correctly.
29 |     $core->checkSetupForRequirements();
30 | 
31 |     // Print any messages.
32 |     echo '<h3>' . get_string('welcomeheader', 'hvp') . '</h3>' .
33 |          '<p>' .
34 |          get_string('welcomegettingstarted', 'hvp', array(
35 |              'moodle_tutorial' => 'href="https://h5p.org/moodle" target="_blank"',
36 |              'example_content' => 'href="https://h5p.org/content-types-and-applications" target="_blank"'
37 |          )) .
38 |          '</p>' .
39 |          '<p>' .
40 |          get_string('welcomecommunity', 'hvp', array(
41 |              'forums' => 'href="https://h5p.org/forum" target="_blank"'
42 |          )) .
43 |          '</p>' .
44 |          '<p>' . get_string('welcomecontactus', 'hvp',
45 |             'href="https://h5p.org/contact" target="_blank"') .
46 |          '</p>';
47 | 
48 |     // Notify of communication with H5P Hub.
49 |     // @codingStandardsIgnoreLine
50 |     echo "<p>H5P fetches content types directly from the H5P Hub. In order to do this the H5P plugin will communicate with the Hub once a day to fetch information about new and updated content types. It will send in anonymous data to the Hub about H5P usage. Read more at <a href=\"https://h5p.org/tracking-the-usage-of-h5p\">the plugin communication page at H5P.org</a>.</p>";
51 | 
52 |     \mod_hvp\framework::printMessages('info', \mod_hvp\framework::messages('info'));
53 |     \mod_hvp\framework::printMessages('error', \mod_hvp\framework::messages('error'));
54 | }
55 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # H5P Moodle Plugin
 2 | 
 3 | Create and add rich content inside your LMS for free. Some examples of what you
 4 | get with H5P are Interactive Video, Quizzes, Collage and Timeline.
 5 | 
 6 | ## Usage
 7 | 
 8 | If you intend to use the repository directly in production, make sure that you're using the "Stable" branch, as this is the production branch.
 9 | There are no guarantees for the state of the other branches at any given time.
10 | Also make sure that all submodules are pulled as well using:
11 | 
12 | ```
13 | git submodule update --init
14 | ```
15 | 
16 | ## Description
17 | 
18 | One of the great benefits with using H5P is that it gives you access to lots of
19 | different [interactive content types](https://h5p.org/content-types-and-applications).
20 | 
21 | Another great benefit with H5P is that it allows you to easily share and reuse
22 | content. To reuse content, you just download the H5P you would like to edit and
23 | make your changes – e.g. translate to a new language or adjust it to a new
24 | situation.
25 | 
26 | H5P is:
27 | 
28 | * Open Source
29 | * Free to Use
30 | * HTML5
31 | * Responsive
32 | 
33 | The H5P community is actively contributing to improve H5P. Updates and new
34 | features are continuously made available on the community portal
35 | [H5P.org](https://h5p.org).
36 | 
37 | View our [setup for Moodle](https://h5p.org/moodle) to get information on how
38 | to get started with H5P.
39 | 
40 | ### GDPR Compliance
41 | Information useful to help you achieve GDPR compliance while using this plugin
42 | can be found at [H5P.org's GDPR Compliance](https://h5p.org/plugin-gdpr-compliance) page.
43 | 
44 | ### Development Version
45 | Warning! Never use the development version in production, there are no guarantees for which state the development branches are in at a given time.
46 | 
47 | Inside your `moodle/mod` folder you run the following command:
48 | ```
49 | git clone -b master https://github.com/h5p/h5p-moodle-plugin.git hvp && cd hvp && git submodule update --init
50 | ```
51 | 
52 | ### Enabling The Plugin
53 | In Moodle, go to administrator -> plugin overview, and press 'Update database'.
54 | 
55 | ## Settings
56 | Settings can be found at: Site Administration -> Plugins -> Activity Modules -> H5P
57 | 
58 | ## Contributing
59 | Feel free to contribute by:
60 | * Submitting translations to the [Moodle AMOS translator](https://lang.moodle.org/local/amos/view.php)
61 | * Testing and creating issues. But remember to check if the issues is already
62 | reported before creating a new one. Perhaps you can contribute to an already
63 | existing issue?
64 | * Solving issues and submitting code through Pull Requests to the 'master' branch or on a separate feature branch.
65 | 


--------------------------------------------------------------------------------
/view.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/>.
16 | /**
17 |  * View H5P Content
18 |  *
19 |  * @package    mod_hvp
20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 |  */
23 | require_once("../../config.php");
24 | require_once("locallib.php");
25 | 
26 | global $PAGE, $DB, $CFG, $OUTPUT;
27 | 
28 | $id = required_param('id', PARAM_INT);
29 | 
30 | // Verify course context.
31 | $cm = get_coursemodule_from_id('hvp', $id);
32 | if (!$cm) {
33 |     print_error('invalidcoursemodule');
34 | }
35 | $course = $DB->get_record('course', array('id' => $cm->course));
36 | if (!$course) {
37 |     print_error('coursemisconf');
38 | }
39 | require_course_login($course, true, $cm);
40 | $context = context_module::instance($cm->id);
41 | require_capability('mod/hvp:view', $context);
42 | 
43 | // Set up view assets.
44 | $view    = new \mod_hvp\view_assets($cm, $course);
45 | $content = $view->getcontent();
46 | $view->validatecontent();
47 | 
48 | // Configure page.
49 | $PAGE->set_url(new \moodle_url('/mod/hvp/view.php', array('id' => $id)));
50 | $PAGE->set_title(format_string($content['title']));
51 | $PAGE->set_heading($course->fullname);
52 | 
53 | // Add H5P assets to page.
54 | $view->addassetstopage();
55 | $view->logviewed();
56 | 
57 | // Print page HTML.
58 | echo $OUTPUT->header();
59 | echo $OUTPUT->heading(format_string($content['title']));
60 | echo '<div class="clearer"></div>';
61 | 
62 | // Output introduction.
63 | if (trim(strip_tags($content['intro'], '<img>'))) {
64 |     echo $OUTPUT->box_start('mod_introbox', 'hvpintro');
65 |     echo format_module_intro('hvp', (object) array(
66 |         'intro'       => $content['intro'],
67 |         'introformat' => $content['introformat'],
68 |     ), $cm->id);
69 |     echo $OUTPUT->box_end();
70 | }
71 | 
72 | // Print any messages.
73 | \mod_hvp\framework::printMessages('info', \mod_hvp\framework::messages('info'));
74 | \mod_hvp\framework::printMessages('error', \mod_hvp\framework::messages('error'));
75 | 
76 | $view->outputview();
77 | echo $OUTPUT->footer();
78 | 


--------------------------------------------------------------------------------
/classes/event.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/>.
16 | 
17 | /**
18 |  * The mod_hvp event logger, makes it easy to track events throughout
19 |  * the H5P system.
20 |  *
21 |  * @package    mod_hvp
22 |  * @copyright  2016 Joubel AS
23 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 |  */
25 | 
26 | namespace mod_hvp;
27 | defined('MOODLE_INTERNAL') || die();
28 | 
29 | class event extends \H5PEventBase {
30 |     private $user;
31 | 
32 |      /**
33 |       * @inheritdoc
34 |       */
35 |     public function __construct($type, $subtype = null, $contentid = null,
36 |         $contenttitle = null, $libraryname = null, $libraryversion = null) {
37 |         global $USER;
38 | 
39 |         // Track the who initiated the event.
40 |         $this->user = $USER->id;
41 | 
42 |         parent::__construct($type, $subtype, $contentid, $contenttitle, $libraryname, $libraryversion);
43 |     }
44 | 
45 |     /**
46 |      * Store the event.
47 |      *
48 |      * @return int Event ID
49 |      */
50 |     protected function save() {
51 |         global $DB;
52 | 
53 |         // Get data in array format without null values.
54 |         $data = $this->getDataArray();
55 | 
56 |         // Add user.
57 |         $data['user_id'] = $this->user;
58 | 
59 |         return $DB->insert_record('hvp_events', $data);
60 |     }
61 | 
62 |     /**
63 |      * @inheritdoc
64 |      */
65 |     // @codingStandardsIgnoreLine
66 |     protected function saveStats() {
67 |         global $DB;
68 |         $type = $this->type . ' ' . $this->sub_type;
69 | 
70 |         // Grab current counter to check if it exists.
71 |         $id = $DB->get_field_sql(
72 |             "SELECT id
73 |                FROM {hvp_counters}
74 |               WHERE type = ?
75 |                 AND library_name = ?
76 |                 AND library_version = ?",
77 |             array($type, $this->library_name, $this->library_version)
78 |         );
79 | 
80 |         if ($id === false) {
81 |             // No counter found, insert new one.
82 |             $DB->insert_record('hvp_counters', array(
83 |                 'type' => $type,
84 |                 'library_name' => $this->library_name,
85 |                 'library_version' => $this->library_version,
86 |                 'num' => 1
87 |             ));
88 |         } else {
89 |             // Update num+1.
90 |             $DB->execute(
91 |                 "UPDATE {hvp_counters}
92 |                     SET num = num + 1
93 |                   WHERE id = ?",
94 |                 array($id)
95 |             );
96 |         }
97 |     }
98 | }
99 | 


--------------------------------------------------------------------------------
/renderer.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/>.
16 | 
17 | /**
18 |  * Defines the renderer for the hvp (H5P) module.
19 |  *
20 |  * @package     mod_hvp
21 |  * @copyright   2016 Joubel AS <contact@joubel.com>
22 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 |  */
24 | 
25 | defined('MOODLE_INTERNAL') || die();
26 | 
27 | /**
28 |  * The renderer for the hvp module.
29 |  *
30 |  * @copyright   2016 Joubel AS <contact@joubel.com>
31 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32 |  *
33 |  * @SuppressWarnings(PHPMD)
34 |  */
35 | class mod_hvp_renderer extends plugin_renderer_base {
36 | 
37 |     /**
38 |      * Alter which stylesheets are loaded for H5P. This is useful for adding
39 |      * your own custom styles or replacing existing ones.
40 |      *
41 |      * @param object $scripts List of stylesheets that will be loaded
42 |      * @param array $libraries Array of libraries indexed by the library's machineName
43 |      * @param string $embedtype Possible values: div, iframe, external, editor
44 |      */
45 |     public function hvp_alter_styles(&$scripts, $libraries, $embedtype) {
46 |     }
47 | 
48 |     /**
49 |      * Alter which scripts are loaded for H5P. Useful for adding your
50 |      * own custom scripts or replacing existing ones.
51 |      *
52 |      * @param object $scripts List of JavaScripts that will be loaded
53 |      * @param array $libraries Array of libraries indexed by the library's machineName
54 |      * @param string $embedtype Possible values: div, iframe, external, editor
55 |      */
56 |     public function hvp_alter_scripts(&$scripts, $libraries, $embedtype) {
57 |     }
58 | 
59 |     /**
60 |      * Alter semantics before they are processed. This is useful for changing
61 |      * how the editor looks and how content parameters are filtered.
62 |      *
63 |      * @param object $semantics Semantics as object
64 |      * @param string $name Machine name of library
65 |      * @param int $majorversion Major version of library
66 |      * @param int $minorversion Minor version of library
67 |      */
68 |     public function hvp_alter_semantics(&$semantics, $name, $majorversion, $minorversion) {
69 |     }
70 | 
71 |     /**
72 |      * Alter parameters of H5P content after it has been filtered through
73 |      * semantics. This is useful for adapting the content to the current context.
74 |      *
75 |      * @param object $parameters The content parameters for the library
76 |      * @param string $name The machine readable name of the library
77 |      * @param int $majorversion Major version of the library
78 |      * @param int $minorversion Minor version of the library
79 |      */
80 |     public function hvp_alter_filtered_parameters(&$parameters, $name, $majorversion, $minorversion) {
81 |     }
82 | }
83 | 


--------------------------------------------------------------------------------
/backup/moodle2/backup_hvp_activity_task.class.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/>.
16 | 
17 | /**
18 |  * Defines backup_hvp_activity_task class
19 |  *
20 |  * @package     mod_hvp
21 |  * @category    backup
22 |  * @copyright   2016 Joubel AS <contact@joubel.com>
23 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 |  */
25 | 
26 | defined('MOODLE_INTERNAL') || die();
27 | 
28 | require_once($CFG->dirroot . '/mod/hvp/backup/moodle2/backup_hvp_stepslib.php');
29 | 
30 | /**
31 |  * Provides the steps to perform one complete backup of a H5P instance
32 |  *
33 |  * @copyright   2018 Joubel AS <contact@joubel.com>
34 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 |  */
36 | class backup_hvp_activity_task extends backup_activity_task {
37 | 
38 |     /**
39 |      * No specific settings for this activity
40 |      */
41 |     protected function define_my_settings() {
42 |     }
43 | 
44 |     /**
45 |      * Defines a backup step to store the instance data in the hvp.xml file
46 |      */
47 |     protected function define_my_steps() {
48 |         global $CFG;
49 | 
50 |         // Add hvp activity data and content files.
51 |         $this->add_step(new backup_hvp_activity_structure_step('hvp_structure', 'hvp.xml'));
52 | 
53 |         // Allow user to override library backup.
54 |         $backuplibraries = !(isset($CFG->mod_hvp_backup_libraries) && $CFG->mod_hvp_backup_libraries === '0');
55 | 
56 |         // Exclude hvp libraries step for local 'imports'.
57 |         if ($backuplibraries && backup_controller_dbops::backup_includes_files($this->plan->get_backupid())) {
58 | 
59 |             // Note that this step will only run once per backup as it generates
60 |             // a shared resource.
61 |             $this->add_step(new backup_hvp_libraries_structure_step('hvp_libraries', 'hvp_libraries.xml'));
62 |         }
63 |     }
64 | 
65 |     /**
66 |      * Encodes URLs to the index.php and view.php scripts
67 |      *
68 |      * @param string $content some HTML text that eventually contains URLs to the activity instance scripts
69 |      * @return string the content with the URLs encoded
70 |      */
71 |     static public function encode_content_links($content) {
72 |         global $CFG;
73 | 
74 |         $base = preg_quote($CFG->wwwroot, "/");
75 | 
76 |         // Link to the list of glossaries.
77 |         $search = "/(".$base."\/mod\/hvp\/index.php\?id\=)([0-9]+)/";
78 |         $content = preg_replace($search, '$@HVPINDEX*$2@$', $content);
79 | 
80 |         // Link to hvp view by module id.
81 |         $search = "/(".$base."\/mod\/hvp\/view.php\?id\=)([0-9]+)/";
82 |         $content = preg_replace($search, '$@HVPVIEWBYID*$2@$', $content);
83 | 
84 |         // Link to hvp embed by module id.
85 |         $search = "/(".$base."\/mod\/hvp\/embed.php\?id\=)([0-9]+)/";
86 |         $content = preg_replace($search, '$@HVPEMBEDBYID*$2@$', $content);
87 | 
88 |         return $content;
89 |     }
90 | }
91 | 


--------------------------------------------------------------------------------
/classes/output/mobile.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/>.
16 | 
17 | namespace mod_hvp\output;
18 | 
19 | defined('MOODLE_INTERNAL') || die();
20 | 
21 | use context_module;
22 | use mod_hvp;
23 | 
24 | class mobile {
25 | 
26 |     public static function mobile_course_view($args) {
27 |         global $DB, $CFG, $OUTPUT, $USER;
28 | 
29 |         $cmid = $args['cmid'];
30 |         if (!$CFG->allowframembedding) {
31 |             $context = \context_system::instance();
32 |             if (has_capability('moodle/site:config', $context)) {
33 |                 $template = 'mod_hvp/iframe_embedding_disabled';
34 |             } else {
35 |                 $template = 'mod_hvp/contact_site_administrator';
36 |             }
37 |             return array(
38 |                 'templates' => array(
39 |                     array(
40 |                         'id' => 'noiframeembedding',
41 |                         'html' => $OUTPUT->render_from_template($template, [])
42 |                     )
43 |                 )
44 |             );
45 |         }
46 | 
47 |         // Verify course context.
48 |         $cm = get_coursemodule_from_id('hvp', $cmid);
49 |         if (!$cm) {
50 |             print_error('invalidcoursemodule');
51 |         }
52 |         $course = $DB->get_record('course', array('id' => $cm->course));
53 |         if (!$course) {
54 |             print_error('coursemisconf');
55 |         }
56 |         require_course_login($course, true, $cm);
57 |         $context = context_module::instance($cm->id);
58 |         require_capability('mod/hvp:view', $context);
59 | 
60 |         list($token, $secret) = mod_hvp\mobile_auth::create_embed_auth_token();
61 | 
62 |         // Store secret in database.
63 |         $auth             = $DB->get_record('hvp_auth', array(
64 |             'user_id' => $USER->id,
65 |         ));
66 |         $currenttimestamp = time();
67 |         if ($auth) {
68 |             $DB->update_record('hvp_auth', array(
69 |                 'id'         => $auth->id,
70 |                 'secret'     => $token,
71 |                 'created_at' => $currenttimestamp,
72 |             ));
73 |         } else {
74 |             $DB->insert_record('hvp_auth', array(
75 |                 'user_id'    => $USER->id,
76 |                 'secret'     => $token,
77 |                 'created_at' => $currenttimestamp
78 |             ));
79 |         }
80 | 
81 |         $data = [
82 |             'cmid'    => $cmid,
83 |             'wwwroot' => $CFG->wwwroot,
84 |             'user_id' => $USER->id,
85 |             'secret'  => urlencode($secret)
86 |         ];
87 | 
88 |         return array(
89 |             'templates'  => array(
90 |                 array(
91 |                     'id'   => 'main',
92 |                     'html' => $OUTPUT->render_from_template('mod_hvp/mobile_view_page', $data),
93 |                 ),
94 |             ),
95 |             'javascript' => file_get_contents($CFG->dirroot . '/mod/hvp/library/js/h5p-resizer.js'),
96 |         );
97 |     }
98 | }
99 | 


--------------------------------------------------------------------------------
/autoloader.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/>.
16 | 
17 | /**
18 |  * References files that should be automatically loaded
19 |  *
20 |  * @package    mod_hvp
21 |  * @copyright  2016 Joubel AS <contact@joubel.com>
22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 |  */
24 | defined('MOODLE_INTERNAL') || die();
25 | 
26 | /**
27 |  * A simple autoloader which makes it easy to load classes when you need them.
28 |  *
29 |  * @param string $class name
30 |  */
31 | function hvp_autoloader($class) {
32 |     global $CFG;
33 |     static $classmap;
34 |     if (!isset($classmap)) {
35 |         $classmap = array(
36 |         // Core.
37 |         'H5PCore' => 'library/h5p.classes.php',
38 |         'H5PFrameworkInterface' => 'library/h5p.classes.php',
39 |         'H5PContentValidator' => 'library/h5p.classes.php',
40 |         'H5PValidator' => 'library/h5p.classes.php',
41 |         'H5PStorage' => 'library/h5p.classes.php',
42 |         'H5PExport' => 'library/h5p.classes.php',
43 |         'H5PDevelopment' => 'library/h5p-development.class.php',
44 |         'H5PFileStorage' => 'library/h5p-file-storage.interface.php',
45 |         'H5PDefaultStorage' => 'library/h5p-default-storage.class.php',
46 |         'H5PEventBase' => 'library/h5p-event-base.class.php',
47 |         'H5PMetadata' => 'library/h5p-metadata.class.php',
48 | 
49 |         // Editor.
50 |         'H5peditor' => 'editor/h5peditor.class.php',
51 |         'H5PEditorAjax' => 'editor/h5peditor-ajax.class.php',
52 |         'H5PEditorAjaxInterface' => 'editor/h5peditor-ajax.interface.php',
53 |         'H5peditorFile' => 'editor/h5peditor-file.class.php',
54 |         'H5peditorStorage' => 'editor/h5peditor-storage.interface.php',
55 | 
56 |         // Reporting.
57 |         'H5PReport' => 'reporting/h5p-report.class.php',
58 |         'H5PReportXAPIData' => 'reporting/h5p-report-xapi-data.class.php',
59 |         'ChoiceProcessor' => 'reporting/type-processors/choice-processor.class.php',
60 |         'CompoundProcessor' => 'reporting/type-processors/compound-processor.class.php',
61 |         'FillInProcessor' => 'reporting/type-processors/fill-in-processor.class.php',
62 |         'LongChoiceProcessor' => 'reporting/type-processors/long-choice-processor.class.php',
63 |         'MatchingProcessor' => 'reporting/type-processors/matching-processor.class.php',
64 |         'TrueFalseProcessor' => 'reporting/type-processors/true-false-processor.class.php',
65 |         'IVOpenEndedQuestionProcessor' => 'reporting/type-processors/iv-open-ended-question-processor.class.php',
66 |         'TypeProcessor' => 'reporting/type-processors/type-processor.class.php',
67 |         'DocumentationToolProcessor' => 'reporting/type-processors/compound/documentation-tool-processor.class.php',
68 |         'GoalsPageProcessor' => 'reporting/type-processors/compound/goals-page-processor.class.php',
69 |         'GoalsAssessmentPageProcessor' => 'reporting/type-processors/compound/goals-assessment-page-processor.class.php',
70 |         'StandardPageProcessor' => 'reporting/type-processors/compound/standard-page-processor.class.php',
71 | 
72 |         // Plugin specific classes are loaded by Moodle.
73 |         );
74 |     }
75 | 
76 |     if (isset($classmap[$class])) {
77 |         require_once($CFG->dirroot . '/mod/hvp/' . $classmap[$class]);
78 |     }
79 | }
80 | spl_autoload_register('hvp_autoloader');
81 | 


--------------------------------------------------------------------------------
/embed.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/>.
 16 | /**
 17 |  * Embed H5P Content
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | require_once("../../config.php");
 24 | require_once("locallib.php");
 25 | 
 26 | global $PAGE, $DB, $CFG, $OUTPUT;
 27 | 
 28 | $id = required_param('id', PARAM_INT);
 29 | 
 30 | // Allow login through an authentication token.
 31 | $userid = optional_param('user_id', null, PARAM_ALPHANUMEXT);
 32 | $secret  = optional_param('secret', null, PARAM_RAW);
 33 | $disabledownload = false;
 34 | $disablefullscreen = false;
 35 | if (\mod_hvp\mobile_auth::has_valid_token($userid, $secret)) {
 36 |     $user = get_complete_user_data('id', $userid);
 37 |     complete_user_login($user);
 38 |     $disabledownload = true;
 39 |     $disablefullscreen = true;
 40 | }
 41 | 
 42 | // Verify course context.
 43 | $cm = get_coursemodule_from_id('hvp', $id);
 44 | if (!$cm) {
 45 |     print_error('invalidcoursemodule');
 46 | }
 47 | $course = $DB->get_record('course', array('id' => $cm->course));
 48 | if (!$course) {
 49 |     print_error('coursemisconf');
 50 | }
 51 | 
 52 | try {
 53 |     require_course_login($course, true, $cm, true, true);
 54 | } catch (Exception $e) {
 55 |     $PAGE->set_pagelayout('embedded');
 56 |     $root = \mod_hvp\view_assets::getsiteroot();
 57 |     $embedfailedsvg = new \moodle_url("{$root}/mod/hvp/library/images/h5p.svg");
 58 |     echo '<body style="margin:0">' .
 59 |          '<div style="background: #fafafa ' .
 60 |          'url(' . $embedfailedsvg->out() . ') no-repeat center;' .
 61 |          'background-size: 50% 50%;width: 100%;height: 100%;">' .
 62 |          '</div>' .
 63 |          '<div style="width:100%;position:absolute;top:75%;text-align:center;color:#434343;' .
 64 |          'font-family: Consolas,monaco,monospace"' .
 65 |          '>' .
 66 |          get_string('embedloginfailed', 'hvp') .
 67 |          '</div>' .
 68 |          '</body>';
 69 |     return;
 70 | }
 71 | $context = context_module::instance($cm->id);
 72 | require_capability('mod/hvp:view', $context);
 73 | 
 74 | // Unlock session during embed.
 75 | core\session\manager::write_close();
 76 | 
 77 | // Set up view assets.
 78 | $view = new \mod_hvp\view_assets($cm, $course, [
 79 |     'disabledownload'   => $disabledownload,
 80 |     'disablefullscreen' => $disablefullscreen
 81 | ]);
 82 | $content = $view->getcontent();
 83 | $view->validatecontent();
 84 | 
 85 | // Configure page.
 86 | $PAGE->set_url(new \moodle_url('/mod/hvp/embed.php', array('id' => $id)));
 87 | $PAGE->set_title(format_string($content['title']));
 88 | $PAGE->set_heading($course->fullname);
 89 | 
 90 | // Embed specific page setup.
 91 | $PAGE->add_body_class('h5p-embed');
 92 | $PAGE->set_pagelayout('embedded');
 93 | $root = \mod_hvp\view_assets::getsiteroot();
 94 | $PAGE->requires->css(new \moodle_url("{$root}/mod/hvp/embed.css"));
 95 | $PAGE->requires->js(new \moodle_url("{$root}/mod/hvp/embed.js"));
 96 | 
 97 | // Add H5P assets to page.
 98 | $view->addassetstopage();
 99 | $view->logviewed();
100 | 
101 | // Print page HTML.
102 | echo $OUTPUT->header();
103 | echo '<div class="clearer"></div>';
104 | 
105 | // Print any messages.
106 | \mod_hvp\framework::printMessages('info', \mod_hvp\framework::messages('info'));
107 | \mod_hvp\framework::printMessages('error', \mod_hvp\framework::messages('error'));
108 | 
109 | $view->outputview();
110 | echo $OUTPUT->footer();
111 | 


--------------------------------------------------------------------------------
/classes/mobile_auth.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/>.
 16 | 
 17 | /**
 18 |  * Helpers for authenticating mobile users through tokens
 19 |  *
 20 |  * @package    mod_hvp
 21 |  * @copyright  2019 Joubel AS
 22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 23 |  */
 24 | 
 25 | namespace mod_hvp;
 26 | 
 27 | defined('MOODLE_INTERNAL') || die();
 28 | 
 29 | class mobile_auth {
 30 | 
 31 |     const VALID_TIME = 60;
 32 | 
 33 |     /**
 34 |      * Generate embed auth token
 35 |      *
 36 |      * @param string $secret Secret phrase added to the hash
 37 |      * @param int $validfor Time factor that determines how long the token is valid
 38 |      *
 39 |      * @return array Login token and secret
 40 |      * @throws \Exception
 41 |      */
 42 |     public static function create_embed_auth_token($secret = null, $validfor = null) {
 43 |         if (!$validfor) {
 44 |             $validfor = self::get_time_factor();
 45 |         }
 46 | 
 47 |         if (empty($secret)) {
 48 |             if (function_exists('random_bytes')) {
 49 |                 $secret = base64_encode(random_bytes(15));
 50 |             } else if (function_exists('openssl_random_pseudo_bytes')) {
 51 |                 $secret = base64_encode(openssl_random_pseudo_bytes(15));
 52 |             } else {
 53 |                 $secret = uniqid('', true);
 54 |             }
 55 |         }
 56 | 
 57 |         return [
 58 |             hash('md5', 'embed_auth' . $validfor . $secret),
 59 |             $secret
 60 |         ];
 61 |     }
 62 | 
 63 |     /**
 64 |      * Validate embed auth token
 65 |      *
 66 |      * @param string $token
 67 |      * @param string $secret
 68 |      *
 69 |      * @return bool True if valid token was supplied
 70 |      * @throws \Exception
 71 |      */
 72 |     public static function validate_embed_auth_token($token, $secret) {
 73 |         $timefactor = self::get_time_factor();
 74 |         // Splitting into two halves and allowing both allows for fractions roundup in the time factor.
 75 |         list($generatedtoken) = self::create_embed_auth_token($secret, $timefactor);
 76 |         list($generatedtoken2) = self::create_embed_auth_token($secret, $timefactor - 1);
 77 |         return $token === $generatedtoken || $token === $generatedtoken2;
 78 |     }
 79 | 
 80 |     /**
 81 |      * Check if provided user_id and token are valid for authenticating the user
 82 |      *
 83 |      * @param string $userid
 84 |      * @param string $token
 85 |      *
 86 |      * @return bool True if token and user_id is valid
 87 |      * @throws \dml_exception
 88 |      */
 89 |     public static function has_valid_token($userid, $secret) {
 90 |         global $DB;
 91 | 
 92 |         if (!$userid || !$secret) {
 93 |             return false;
 94 |         }
 95 | 
 96 |         $auth = $DB->get_record('hvp_auth', array(
 97 |             'user_id' => $userid,
 98 |         ));
 99 |         if (!$auth) {
100 |             return false;
101 |         }
102 | 
103 |         $isvalid = self::validate_embed_auth_token($auth->secret, $secret);
104 | 
105 |         // Cleanup user's token when used.
106 |         if ($isvalid) {
107 |             $DB->delete_records('hvp_auth', array(
108 |                 'user_id' => $userid
109 |             ));
110 |         }
111 | 
112 |         return $isvalid;
113 |     }
114 | 
115 |     /**
116 |      * Get time factor for how long the token is valid
117 |      *
118 |      * @return float
119 |      */
120 |     public static function get_time_factor() {
121 |         return ceil(time() / self::VALID_TIME);
122 |     }
123 | }
124 | 


--------------------------------------------------------------------------------
/backup/moodle2/restore_hvp_activity_task.class.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/>.
 16 | 
 17 | /**
 18 |  * Describe how H5P activites are to be restored from backup
 19 |  *
 20 |  * @package     mod_hvp
 21 |  * @category    backup
 22 |  * @copyright   2016 Joubel AS <contact@joubel.com>
 23 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 24 |  */
 25 | 
 26 | defined('MOODLE_INTERNAL') || die();
 27 | 
 28 | require_once($CFG->dirroot . '/mod/hvp/backup/moodle2/restore_hvp_stepslib.php'); // Because it exists (must).
 29 | 
 30 | /**
 31 |  * Hvp restore task that provides all the settings and steps to perform one complete restore of the activity.
 32 |  *
 33 |  * @copyright   2018 Joubel AS <contact@joubel.com>
 34 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 35 |  */
 36 | class restore_hvp_activity_task extends restore_activity_task {
 37 | 
 38 |     /**
 39 |      * Define (add) particular settings this activity can have
 40 |      */
 41 |     protected function define_my_settings() {
 42 |         // No particular settings for this activity.
 43 |     }
 44 | 
 45 |     /**
 46 |      * Define (add) particular steps this activity can have
 47 |      */
 48 |     protected function define_my_steps() {
 49 |         // Add H5P libraries.
 50 |         $this->add_step(new restore_hvp_libraries_structure_step('hvp_structure', 'hvp_libraries.xml'));
 51 | 
 52 |         // Add H5P content.
 53 |         $this->add_step(new restore_hvp_activity_structure_step('hvp_structure', 'hvp.xml'));
 54 |     }
 55 | 
 56 |     /**
 57 |      * Define the contents in the activity that must be
 58 |      * processed by the link decoder
 59 |      */
 60 |     static public function define_decode_contents() {
 61 |         $contents = array();
 62 | 
 63 |         $contents[] = new restore_decode_content('hvp', array('intro'), 'hvp');
 64 | 
 65 |         return $contents;
 66 |     }
 67 | 
 68 |     /**
 69 |      * Define the decoding rules for links belonging
 70 |      * to the activity to be executed by the link decoder
 71 |      */
 72 |     static public function define_decode_rules() {
 73 |         $rules = array();
 74 | 
 75 |         $rules[] = new restore_decode_rule('HVPVIEWBYID', '/mod/hvp/view.php?id=$1', 'course_module');
 76 |         $rules[] = new restore_decode_rule('HVPINDEX', '/mod/hvp/index.php?id=$1', 'course');
 77 |         $rules[] = new restore_decode_rule('HVPEMBEDBYID', '/mod/hvp/embed.php?id=$1', 'course_module');
 78 | 
 79 |         return $rules;
 80 |     }
 81 | 
 82 |     /**
 83 |      * Define the restore log rules that will be applied
 84 |      * by the {@link restore_logs_processor} when restoring
 85 |      * hvp logs. It must return one array
 86 |      * of {@link restore_log_rule} objects
 87 |      */
 88 |     static public function define_restore_log_rules() {
 89 |         $rules = array();
 90 | 
 91 |         $rules[] = new restore_log_rule('hvp', 'add', 'view.php?id={course_module}', '{hvp}');
 92 |         $rules[] = new restore_log_rule('hvp', 'update', 'view.php?id={course_module}', '{hvp}');
 93 |         $rules[] = new restore_log_rule('hvp', 'view', 'view.php?id={course_module}', '{hvp}');
 94 | 
 95 |         return $rules;
 96 |     }
 97 | 
 98 |     /**
 99 |      * Define the restore log rules that will be applied
100 |      * by the {@link restore_logs_processor} when restoring
101 |      * course logs. It must return one array
102 |      * of {@link restore_log_rule} objects
103 |      *
104 |      * Note this rules are applied when restoring course logs
105 |      * by the restore final task, but are defined here at
106 |      * activity level. All them are rules not linked to any module instance (cmid = 0)
107 |      */
108 |     static public function define_restore_log_rules_for_course() {
109 |         $rules = array();
110 | 
111 |         $rules[] = new restore_log_rule('hvp', 'view all', 'index.php?id={course}', null);
112 | 
113 |         return $rules;
114 |     }
115 | }
116 | 


--------------------------------------------------------------------------------
/embed.js:
--------------------------------------------------------------------------------
  1 | /* global H5PEmbedCommunicator:true */
  2 | /**
  3 |  * When embedded the communicator helps talk to the parent page.
  4 |  * This is a copy of the H5P.communicator, which we need to communicate in this context
  5 |  *
  6 |  * @type {H5PEmbedCommunicator}
  7 |  */
  8 | H5PEmbedCommunicator = (function() {
  9 |     /**
 10 |      * @class
 11 |      * @private
 12 |      */
 13 |     function Communicator() {
 14 |         var self = this;
 15 | 
 16 |         // Maps actions to functions.
 17 |         var actionHandlers = {};
 18 | 
 19 |         // Register message listener.
 20 |         window.addEventListener('message', function receiveMessage(event) {
 21 |             if (window.parent !== event.source || event.data.context !== 'h5p') {
 22 |                 return; // Only handle messages from parent and in the correct context.
 23 |             }
 24 | 
 25 |             if (actionHandlers[event.data.action] !== undefined) {
 26 |                 actionHandlers[event.data.action](event.data);
 27 |             }
 28 |         }, false);
 29 | 
 30 |         /**
 31 |          * Register action listener.
 32 |          *
 33 |          * @param {string} action What you are waiting for
 34 |          * @param {function} handler What you want done
 35 |          */
 36 |         self.on = function(action, handler) {
 37 |             actionHandlers[action] = handler;
 38 |         };
 39 | 
 40 |         /**
 41 |          * Send a message to the all mighty father.
 42 |          *
 43 |          * @param {string} action
 44 |          * @param {Object} [data] payload
 45 |          */
 46 |         self.send = function(action, data) {
 47 |             if (data === undefined) {
 48 |                 data = {};
 49 |             }
 50 |             data.context = 'h5p';
 51 |             data.action = action;
 52 | 
 53 |             // Parent origin can be anything.
 54 |             window.parent.postMessage(data, '*');
 55 |         };
 56 |     }
 57 | 
 58 |     return (window.postMessage && window.addEventListener ? new Communicator() : undefined);
 59 | })();
 60 | 
 61 | document.onreadystatechange = function() {
 62 |     // Wait for instances to be initialize.
 63 |     if (document.readyState !== 'complete') {
 64 |         return;
 65 |     }
 66 | 
 67 |     // Check for H5P iFrame.
 68 |     var iFrame = document.querySelector('.h5p-iframe');
 69 |     if (!iFrame || !iFrame.contentWindow) {
 70 |         return;
 71 |     }
 72 |     var H5P = iFrame.contentWindow.H5P;
 73 | 
 74 |     // Check for H5P instances.
 75 |     if (!H5P || !H5P.instances || !H5P.instances[0]) {
 76 |         return;
 77 |     }
 78 | 
 79 |     var resizeDelay;
 80 |     var instance = H5P.instances[0];
 81 |     var parentIsFriendly = false;
 82 | 
 83 |     // Handle that the resizer is loaded after the iframe.
 84 |     H5PEmbedCommunicator.on('ready', function() {
 85 |         H5PEmbedCommunicator.send('hello');
 86 |     });
 87 | 
 88 |     // Handle hello message from our parent window.
 89 |     H5PEmbedCommunicator.on('hello', function() {
 90 |         // Initial setup/handshake is done.
 91 |         parentIsFriendly = true;
 92 | 
 93 |         // Hide scrollbars for correct size.
 94 |         iFrame.contentDocument.body.style.overflow = 'hidden';
 95 | 
 96 |         document.body.classList.add('h5p-resizing');
 97 | 
 98 |         // Content need to be resized to fit the new iframe size.
 99 |         H5P.trigger(instance, 'resize');
100 |     });
101 | 
102 |     // When resize has been prepared tell parent window to resize.
103 |     H5PEmbedCommunicator.on('resizePrepared', function() {
104 |         H5PEmbedCommunicator.send('resize', {
105 |             scrollHeight: iFrame.contentDocument.body.scrollHeight
106 |         });
107 |     });
108 | 
109 |     H5PEmbedCommunicator.on('resize', function() {
110 |         H5P.trigger(instance, 'resize');
111 |     });
112 | 
113 |     H5P.on(instance, 'resize', function() {
114 |         if (H5P.isFullscreen) {
115 |             return; // Skip iframe resize.
116 |         }
117 | 
118 |         // Use a delay to make sure iframe is resized to the correct size.
119 |         clearTimeout(resizeDelay);
120 |         resizeDelay = setTimeout(function() {
121 |             // Only resize if the iframe can be resized.
122 |             if (parentIsFriendly) {
123 |                 H5PEmbedCommunicator.send('prepareResize',
124 |                     {
125 |                         scrollHeight: iFrame.contentDocument.body.scrollHeight,
126 |                         clientHeight: iFrame.contentDocument.body.clientHeight
127 |                     }
128 |                 );
129 |             } else {
130 |                 H5PEmbedCommunicator.send('hello');
131 |             }
132 |         }, 0);
133 |     });
134 | 
135 |     // Trigger initial resize for instance.
136 |     H5P.trigger(instance, 'resize');
137 | };
138 | 


--------------------------------------------------------------------------------
/index.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/>.
 16 | /**
 17 |  * Form for creating new H5P Content
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | 
 24 | require_once('../../config.php');
 25 | 
 26 | // Get Course ID.
 27 | $id = optional_param('id', 0, PARAM_INT);
 28 | 
 29 | // Set URL.
 30 | $url = new \moodle_url('/mod/hvp/index.php', array('id' => $id));
 31 | $PAGE->set_url($url);
 32 | 
 33 | // Load Course.
 34 | $course = $DB->get_record('course', array('id' => $id));
 35 | if (!$course) {
 36 |     print_error('invalidcourseid');
 37 | }
 38 | 
 39 | // Require login.
 40 | require_course_login($course);
 41 | $PAGE->set_pagelayout('incourse');
 42 | $coursecontext = context_course::instance($course->id);
 43 | 
 44 | // Trigger instances list viewed event.
 45 | $params = array(
 46 |     'context' => context_course::instance($course->id)
 47 | );
 48 | $event = \mod_hvp\event\course_module_instance_list_viewed::create($params);
 49 | $event->add_record_snapshot('course', $course);
 50 | $event->trigger();
 51 | 
 52 | // Set title and heading.
 53 | $PAGE->set_title($course->shortname . ': ' . get_string('modulenameplural', 'mod_hvp'));
 54 | $PAGE->set_heading($course->fullname);
 55 | 
 56 | echo $OUTPUT->header();
 57 | 
 58 | // Load H5P list data.
 59 | $rawh5ps = $DB->get_records_sql("SELECT cm.id AS coursemodule,
 60 |                                      cw.section,
 61 |                                      cm.visible,
 62 |                                      h.name,
 63 |                                      hl.title AS librarytitle
 64 |                                 FROM {course_modules} cm,
 65 |                                      {course_sections} cw,
 66 |                                      {modules} md,
 67 |                                      {hvp} h,
 68 |                                      {hvp_libraries} hl
 69 |                                WHERE cm.course = ?
 70 |                                  AND cm.instance = h.id
 71 |                                  AND cm.section = cw.id
 72 |                                  AND md.name = 'hvp'
 73 |                                  AND md.id = cm.module
 74 |                                  AND hl.id = h.main_library_id
 75 |                              ", array($course->id));
 76 | if (!$rawh5ps) {
 77 |     notice(get_string('noh5ps', 'mod_hvp'), "../../course/view.php?id={$course->id}");
 78 |     die;
 79 | }
 80 | 
 81 | $modinfo = get_fast_modinfo($course, null);
 82 | if (empty($modinfo->instances['hvp'])) {
 83 |     $h5ps = $rawh5ps;
 84 | } else {
 85 |     // Lets try to order these bad boys.
 86 |     $h5ps = [];
 87 |     foreach ($modinfo->instances['hvp'] as $cm) {
 88 |         if (!$cm->uservisible || !isset($rawh5ps[$cm->id])) {
 89 |             continue; // Not visible or not found.
 90 |         }
 91 |         if (!empty($cm->extra)) {
 92 |             $rawh5ps[$cm->id]->extra = $cm->extra;
 93 |         }
 94 |         $h5ps[] = $rawh5ps[$cm->id];
 95 |     }
 96 | }
 97 | 
 98 | // Print H5P list.
 99 | $table = new html_table();
100 | $table->attributes['class'] = 'generaltable mod_index';
101 | 
102 | $table->head = array();
103 | $table->align = array();
104 | 
105 | $usesections = course_format_uses_sections($course->format);
106 | if ($usesections) {
107 |     // Section name.
108 |     $table->head[] = get_string('sectionname', 'format_'.$course->format);
109 |     $table->align[] = 'center';
110 | }
111 | 
112 | // Activity name.
113 | $table->head[] = get_string('name');
114 | $table->align[] = 'left';
115 | 
116 | // Content type.
117 | $table->head[] = 'Content Type';
118 | $table->align[] = 'left';
119 | 
120 | // Add data rows.
121 | foreach ($h5ps as $h5p) {
122 |     $row = [];
123 | 
124 |     if ($usesections) {
125 |         // Section name.
126 |         $row[] = get_section_name($course, $h5p->section);
127 |     }
128 | 
129 |     // Activity name.
130 |     $attrs = ($h5p->visible ? '' : ' class="dimmed"');
131 |     $row[] = "<a href=\"view.php?id={$h5p->coursemodule}\"{$attrs}>{$h5p->name}</a>";
132 | 
133 |     // Activity type.
134 |     $row[] = $h5p->librarytitle;
135 | 
136 |     $table->data[] = $row;
137 | }
138 | 
139 | echo html_writer::table($table);
140 | 
141 | echo $OUTPUT->footer();
142 | 


--------------------------------------------------------------------------------
/classes/xapi_result.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/>.
 16 | 
 17 | /**
 18 |  * The mod_hvp content user data.
 19 |  *
 20 |  * @package    mod_hvp
 21 |  * @since      Moodle 2.7
 22 |  * @copyright  2017 Joubel AS
 23 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 24 |  */
 25 | 
 26 | namespace mod_hvp;
 27 | 
 28 | defined('MOODLE_INTERNAL') || die();
 29 | 
 30 | /**
 31 |  * Class xapi_result handles xapi results and corresponding db operations.
 32 |  *
 33 |  * @package mod_hvp
 34 |  */
 35 | class xapi_result {
 36 | 
 37 |     /**
 38 |      * Handle xapi results endpoint
 39 |      */
 40 |     public static function handle_ajax() {
 41 |         // Validate token.
 42 |         if (!self::validate_token()) {
 43 |             $core = framework::instance();
 44 |             \H5PCore::ajaxError($core->h5pF->t('Invalid security token.'),
 45 |                 'INVALID_TOKEN');
 46 |             return;
 47 |         }
 48 | 
 49 |         $cm = get_coursemodule_from_id('hvp', required_param('contextId', PARAM_INT));
 50 |         if (!$cm) {
 51 |             \H5PCore::ajaxError('No such content');
 52 |             http_response_code(404);
 53 |             return;
 54 |         }
 55 | 
 56 |         $xapiresult = required_param('xAPIResult', PARAM_RAW);
 57 | 
 58 |         // Validate.
 59 |         $context = \context_module::instance($cm->id);
 60 |         if (!has_capability('mod/hvp:saveresults', $context)) {
 61 |             \H5PCore::ajaxError(get_string('nopermissiontosaveresult', 'hvp'));
 62 |             return;
 63 |         }
 64 | 
 65 |         $xapijson = json_decode($xapiresult);
 66 |         if (!$xapijson) {
 67 |             \H5PCore::ajaxError('Invalid json in xAPI data.');
 68 |             return;
 69 |         }
 70 | 
 71 |         if (!self::validate_xapi_data($xapijson)) {
 72 |             \H5PCore::ajaxError('Invalid xAPI data.');
 73 |             return;
 74 |         }
 75 | 
 76 |         // Delete any old results.
 77 |         self::remove_xapi_data($cm->instance);
 78 | 
 79 |         // Store results.
 80 |         self::store_xapi_data($cm->instance, $xapijson);
 81 | 
 82 |         // Successfully inserted xAPI result.
 83 |         \H5PCore::ajaxSuccess();
 84 |     }
 85 | 
 86 |     /**
 87 |      * Validate xAPI results token
 88 |      *
 89 |      * @return bool True if token was valid
 90 |      */
 91 |     private static function validate_token() {
 92 |         $token = required_param('token', PARAM_ALPHANUM);
 93 |         return \H5PCore::validToken('xapiresult', $token);
 94 | 
 95 |     }
 96 | 
 97 |     /**
 98 |      * Validate xAPI data
 99 |      *
100 |      * @param object $xapidata xAPI data
101 |      *
102 |      * @return bool True if valid data
103 |      */
104 |     private static function validate_xapi_data($xapidata) {
105 |         $xapidata = new \H5PReportXAPIData($xapidata);
106 |         return $xapidata->validateData();
107 |     }
108 | 
109 |     /**
110 |      * Store xAPI result(s)
111 |      *
112 |      * @param int $contentid Content id
113 |      * @param object $xapidata xAPI data
114 |      * @param int $parentid Parent id
115 |      */
116 |     private static function store_xapi_data($contentid, $xapidata, $parentid = null) {
117 |         global $DB, $USER;
118 | 
119 |         $xapidata = new \H5PReportXAPIData($xapidata, $parentid);
120 |         $insertedid = $DB->insert_record('hvp_xapi_results', (object) array(
121 |             'content_id' => $contentid,
122 |             'user_id' => $USER->id,
123 |             'parent_id' => $xapidata->getParentID(),
124 |             'interaction_type' => $xapidata->getInteractionType(),
125 |             'description' => $xapidata->getDescription(),
126 |             'correct_responses_pattern' => $xapidata->getCorrectResponsesPattern(),
127 |             'response' => $xapidata->getResponse(),
128 |             'additionals' => $xapidata->getAdditionals(),
129 |             'raw_score' => $xapidata->getScoreRaw(),
130 |             'max_score' => $xapidata->getScoreMax(),
131 |         ));
132 | 
133 |         // Save sub content statements data.
134 |         if ($xapidata->isCompound()) {
135 |             foreach ($xapidata->getChildren($contentid) as $child) {
136 |                 self::store_xapi_data($contentid, $child, $insertedid);
137 |             }
138 |         }
139 |     }
140 | 
141 |     /**
142 |      * Remove xAPI result(s)
143 |      *
144 |      * @param int $contentid Content id
145 |      */
146 |     private static function remove_xapi_data($contentid) {
147 |         global $DB, $USER;
148 | 
149 |         $DB->delete_records('hvp_xapi_results', array(
150 |             'content_id' => $contentid,
151 |             'user_id' => $USER->id
152 |         ));
153 |     }
154 | }
155 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
  1 | # This is the language of our project.
  2 | language: php
  3 | 
  4 | # Installs the required version of Firefox for Behat, an updated version
  5 | # of PostgreSQL and extra APT packages. Java 8 is only required
  6 | # for Mustache command.
  7 | addons:
  8 |  postgresql: "9.5"
  9 | 
 10 | services:
 11 |  - mysql
 12 |  - postgresql
 13 |  - docker
 14 | 
 15 | # Cache NPM's and Composer's caches to speed up build times.
 16 | cache:
 17 |  directories:
 18 |   - $HOME/.composer/cache
 19 |   - $HOME/.npm
 20 | 
 21 | # Determines which versions of PHP to test our project against.  Each version
 22 | # listed here will create a separate build and run the tests against that
 23 | # version of PHP.
 24 | php:
 25 |  - 7.0
 26 |  - 7.1
 27 |  - 7.2
 28 |  - 7.3
 29 |  - 7.4
 30 | 
 31 | # This section sets up the environment variables for the build.
 32 | env:
 33 |  global:
 34 |   # This line determines which version branch of Moodle to test against.
 35 |   - MOODLE_BRANCH=MOODLE_39_STABLE
 36 |   - IGNORE_PATHS=lang,editor,library,reporting
 37 |  # This matrix is used for testing against multiple databases.  So for
 38 |  # each version of PHP being tested, one build will be created for each
 39 |  # database listed here.  EG: for PHP 5.6, one build will be created
 40 |  # using PHP 5.6 and pgsql.  In addition, another build will be created
 41 |  # using PHP 5.6 and mysqli.
 42 |  matrix:
 43 |   - DB=pgsql
 44 |   - DB=mysqli
 45 | 
 46 | # Optionally, it is possible to specify a different Moodle repo to use
 47 | # (git://github.com/moodle/moodle.git is used by default):
 48 | # - MOODLE_REPO=git://github.com/username/moodle.git
 49 | 
 50 | # This lists steps that are run before the installation step.
 51 | before_install:
 52 |  # This disables XDebug which should speed up the build.
 53 |  - phpenv config-rm xdebug.ini
 54 |  # Currently we are inside of the clone of your repository.  We move up two
 55 |  # directories to build the project.
 56 |  - cd ../..
 57 |  # Install this project into a directory called "ci".
 58 |  - composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
 59 |  # Update the $PATH so scripts from this project can be called easily.
 60 |  - export PATH="$(cd ci/bin; pwd):$(cd ci/vendor/bin; pwd):$PATH"
 61 | 
 62 | # This lists steps that are run for installation and setup.
 63 | install:
 64 |  # Run the default install.  The overview of what this does:
 65 |  #    - Clone the Moodle project into a directory called moodle.
 66 |  #    - Create a data directory called moodledata.
 67 |  #    - Create Moodle config.php, database, etc.
 68 |  #    - Copy your plugin(s) into Moodle.
 69 |  #    - Run Composer install within Moodle.
 70 |  #    - Run NPM install in Moodle and in your plugin if it has a "package.json".
 71 |  #    - Run "grunt ignorefiles" within Moodle to update ignore file lists.
 72 |  #    - If your plugin has Behat features, then Behat will be setup.
 73 |  #    - If your plugin has unit tests, then PHPUnit will be setup.
 74 |  - moodle-plugin-ci install
 75 | 
 76 | # This lists steps that are run for the purposes of testing.  Any of
 77 | # these steps can be re-ordered or removed to your liking.  And of
 78 | # course, you can add any of your own custom steps.
 79 | script:
 80 |  # This step lints your PHP files to check for syntax errors.
 81 |  - moodle-plugin-ci phplint
 82 |  # This step runs the PHP Copy/Paste Detector on your plugin.
 83 |  # This helps to find code duplication.
 84 |  - moodle-plugin-ci phpcpd
 85 |  # This step runs the PHP Mess Detector on your plugin. This helps to find
 86 |  # potential problems with your code which can result in
 87 |  # refactoring opportunities.
 88 |  - moodle-plugin-ci phpmd
 89 |  # This step runs the Moodle Code Checker to make sure that your plugin
 90 |  # conforms to the Moodle coding standards.  It is highly recommended
 91 |  # that you keep this step.
 92 |  - moodle-plugin-ci codechecker
 93 |  # This step runs Moodle PHPDoc checker on your plugin.
 94 | # - moodle-plugin-ci phpdoc
 95 |  # This step runs some light validation on the plugin file structure
 96 |  # and code.  Validation can be plugin specific.
 97 |  - moodle-plugin-ci validate
 98 |  # This step validates your plugin's upgrade steps.
 99 |  - moodle-plugin-ci savepoints
100 |  # This step validates the HTML and Javascript in your Mustache templates.
101 | # - moodle-plugin-ci mustache
102 |  # This step runs Grunt tasks on the plugin.  By default, it tries to run
103 |  # tasks relevant to your plugin and Moodle version, but you can run
104 |  # specific tasks by passing them as options,
105 |  # EG: moodle-plugin-ci grunt -t task1 -t task2
106 | # - moodle-plugin-ci grunt
107 |  # This step runs the PHPUnit tests of your plugin.  If your plugin has
108 |  # PHPUnit tests, then it is highly recommended that you keep this step.
109 |  - moodle-plugin-ci phpunit
110 |  # This step runs the Behat tests of your plugin.  If your plugin has
111 |  # Behat tests, then it is highly recommended that you keep this step.
112 |  # There are two important options that you may want to use:
113 |  #   - The auto rerun option allows you to rerun failures X number of times,
114 |  #     default is 2, EG usage: --auto-rerun 3
115 |  #   - The dump option allows you to print the failure HTML to the console,
116 |  #     handy for debugging, EG usage: --dump
117 |  #   - The suite option allows you to set the theme to use for behat test. If
118 |  #     not specified, the default theme is used, EG usage: --suite boost


--------------------------------------------------------------------------------
/classes/upload_libraries_form.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/>.
 16 | 
 17 | /**
 18 |  * \mod_hvp\upload_libraries_form class
 19 |  *
 20 |  * @package    mod_hvp
 21 |  * @copyright  2016 Joubel AS
 22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 23 |  */
 24 | 
 25 | namespace mod_hvp;
 26 | 
 27 | defined('MOODLE_INTERNAL') || die();
 28 | 
 29 | // Load moodleform class.
 30 | require_once("$CFG->libdir/formslib.php");
 31 | 
 32 | /**
 33 |  * Form to upload new H5P libraries and upgrade existing once
 34 |  *
 35 |  * @package    mod_hvp
 36 |  * @copyright  2016 Joubel AS
 37 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 38 |  */
 39 | class upload_libraries_form extends \moodleform {
 40 | 
 41 |     /**
 42 |      * Define form elements
 43 |      */
 44 |     public function definition() {
 45 |         global $CFG, $OUTPUT;
 46 | 
 47 |         // Get form.
 48 |         $mform = $this->_form;
 49 | 
 50 |         // Add File Picker.
 51 |         $mform->addElement('filepicker', 'h5pfile', get_string('h5pfile', 'hvp'), null,
 52 |                    array('maxbytes' => $CFG->maxbytes, 'accepted_types' => '*.h5p'));
 53 | 
 54 |         // Add options.
 55 |         $mform->addElement('checkbox',
 56 |             'onlyupdate',
 57 |             get_string('options', 'hvp'),
 58 |             get_string('onlyupdate', 'hvp'),
 59 |             array('group' => 1)
 60 |         );
 61 |         $mform->setType('onlyupdate', PARAM_BOOL);
 62 |         $mform->setDefault('onlyupdate', false);
 63 | 
 64 |         $mform->addElement('checkbox',
 65 |             'disablefileextensioncheck',
 66 |             '',
 67 |             get_string('disablefileextensioncheck', 'hvp'),
 68 |             array('group' => 1)
 69 |         );
 70 |         $mform->setType('disablefileextensioncheck', PARAM_BOOL);
 71 |         $mform->setDefault('disablefileextensioncheck', false);
 72 | 
 73 |         $notification = $OUTPUT->notification(
 74 |             get_string('disablefileextensioncheckwarning', 'hvp'),
 75 |             'notifymessage'
 76 |         );
 77 |         $mform->addElement('static', '', '', $notification);
 78 | 
 79 |         // Upload button.
 80 |         $this->add_action_buttons(false, get_string('upload', 'hvp'));
 81 |     }
 82 | 
 83 |     /**
 84 |      * Preprocess incoming data
 85 |      *
 86 |      * @param array $defaultvalues default values for form
 87 |      */
 88 |     public function data_preprocessing(&$defaultvalues) {
 89 |         // Aaah.. we meet again h5pfile!.
 90 |         $draftitemid = file_get_submitted_draft_itemid('h5pfile');
 91 |         file_prepare_draft_area($draftitemid, $this->context->id, 'mod_hvp', 'package', 0);
 92 |         $defaultvalues['h5pfile'] = $draftitemid;
 93 |     }
 94 | 
 95 |     /**
 96 |      * Validate incoming data
 97 |      *
 98 |      * @param array $data array of ("fieldname"=>value) of submitted data
 99 |      * @param array $files array of uploaded files "element_name"=>tmp_file_path
100 |      * @return array of "element_name"=>"error_description" if there are errors,
101 |      *         or an empty array if everything is OK (true allowed for backwards compatibility too).
102 |      */
103 |     public function validation($data, $files) {
104 |         global $CFG;
105 |         $errors = array();
106 | 
107 |         // Check for file.
108 |         if (empty($data['h5pfile'])) {
109 |             $errors['h5pfile'] = get_string('required');
110 |             return $errors;
111 |         }
112 | 
113 |         $files = $this->get_draft_files('h5pfile');
114 |         if (count($files) < 1) {
115 |             $errors['h5pfile'] = get_string('required');
116 |             return $errors;
117 |         }
118 | 
119 |         // Add file so that core framework can find it.
120 |         $file = reset($files);
121 |         $interface = \mod_hvp\framework::instance('interface');
122 | 
123 |         $path = $CFG->tempdir . uniqid('/hvp-');
124 |         $interface->getUploadedH5pFolderPath($path);
125 |         $path .= '.h5p';
126 |         $interface->getUploadedH5pPath($path);
127 |         $file->copy_content_to($path);
128 | 
129 |         // Validate package.
130 |         $h5pvalidator = \mod_hvp\framework::instance('validator');
131 |         if (!$h5pvalidator->isValidPackage(true, isset($data['onlyupdate']))) {
132 |             // Errors while validating the package.
133 |             $errors = array_map(function ($message) {
134 |                 return $message->message;
135 |             }, framework::messages('error'));
136 | 
137 |             $messages = array_merge(framework::messages('info'), $errors);
138 |             $errors['h5pfile'] = implode('<br/>', $messages);
139 |         }
140 |         return $errors;
141 |     }
142 | }
143 | 


--------------------------------------------------------------------------------
/upgrade_content_page.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/>.
 16 | /**
 17 |  * Responsible for displaying the content upgrade page
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | 
 24 | require_once("../../config.php");
 25 | require_once($CFG->libdir.'/adminlib.php');
 26 | require_once("locallib.php");
 27 | 
 28 | // No guest autologin.
 29 | require_login(0, false);
 30 | 
 31 | $libraryid = required_param('library_id', PARAM_INT);
 32 | $pageurl = new moodle_url('/mod/hvp/upgrade_content_page.php', array('library_id' => $libraryid));
 33 | $PAGE->set_url($pageurl);
 34 | admin_externalpage_setup('h5plibraries');
 35 | $PAGE->set_title("{$SITE->shortname}: " . get_string('upgrade', 'hvp'));
 36 | 
 37 | // Inform moodle which menu entry currently is active!
 38 | $core = \mod_hvp\framework::instance();
 39 | global $DB;
 40 | $results = $DB->get_records_sql('SELECT hl2.id as id, hl2.machine_name as name, hl2.title, hl2.major_version,
 41 |                                         hl2.minor_version, hl2.patch_version
 42 |                                    FROM {hvp_libraries} hl1 JOIN {hvp_libraries} hl2 ON hl1.machine_name = hl2.machine_name
 43 |                                   WHERE hl1.id = ?
 44 |                                ORDER BY hl2.title ASC, hl2.major_version ASC, hl2.minor_version ASC', array($libraryid));
 45 | $versions = array();
 46 | foreach ($results as $result) {
 47 |     $versions[$result->id] = $result;
 48 | }
 49 | $library = $versions[$libraryid];
 50 | $upgrades = $core->getUpgrades($library, $versions);
 51 | 
 52 | $PAGE->set_heading(get_string('upgradeheading', 'hvp', $library->title . ' (' . \H5PCore::libraryVersion($library) . ')'));
 53 | 
 54 | // Get num of contents that can be upgraded.
 55 | $numcontents = $core->h5pF->getNumContent($libraryid);
 56 | if (count($versions) < 2) {
 57 |     echo $OUTPUT->header();
 58 |     echo get_string('upgradenoavailableupgrades', 'hvp');
 59 | } else if ($numcontents === 0) {
 60 |     echo $OUTPUT->header();
 61 |     echo get_string('upgradenothingtodo', 'hvp');
 62 | } else {
 63 |     $settings = array(
 64 |         'libraryInfo' => array(
 65 |             'message' => get_string('upgrademessage', 'hvp', $numcontents),
 66 |             'inProgress' => get_string('upgradeinprogress', 'hvp'),
 67 |             'error' => get_string('upgradeerror', 'hvp'),
 68 |             'errorData' => get_string('upgradeerrordata', 'hvp'),
 69 |             'errorScript' => get_string('upgradeerrorscript', 'hvp'),
 70 |             'errorContent' => get_string('upgradeerrorcontent', 'hvp'),
 71 |             'errorParamsBroken' => get_string('upgradeerrorparamsbroken', 'hvp'),
 72 |             'errorLibrary' => get_string('upgradeerrormissinglibrary', 'hvp'),
 73 |             'errorTooHighVersion' => get_string('upgradeerrortoohighversion', 'hvp'),
 74 |             'errorNotSupported' => get_string('upgradeerrornotsupported', 'hvp'),
 75 |             'done' => get_string('upgradedone', 'hvp', $numcontents) .
 76 |                       ' <a href="' . (new moodle_url('/mod/hvp/library_list.php'))->out(false) . '">' .
 77 |                       get_string('upgradereturn', 'hvp') . '</a>',
 78 |             'library' => array(
 79 |                 'name' => $library->name,
 80 |                 'version' => $library->major_version . '.' . $library->minor_version,
 81 |             ),
 82 |             'libraryBaseUrl' => (new moodle_url('/mod/hvp/ajax.php',
 83 |                                  array('action' => 'getlibrarydataforupgrade')))->out(false) . '&library=',
 84 |             'scriptBaseUrl' => (new moodle_url('/mod/hvp/library/js'))->out(false),
 85 |             'buster' => hvp_get_cache_buster(),
 86 |             'versions' => $upgrades,
 87 |             'contents' => $numcontents,
 88 |             'buttonLabel' => get_string('upgradebuttonlabel', 'hvp'),
 89 |             'infoUrl' => (new moodle_url('/mod/hvp/ajax.php', array('action' => 'libraryupgradeprogress',
 90 |                           'library_id' => $libraryid)))->out(false),
 91 |             'total' => $numcontents,
 92 |             'token' => \H5PCore::createToken('contentupgrade')
 93 |         )
 94 |     );
 95 | 
 96 |     // Add JavaScripts.
 97 |     $liburl = \mod_hvp\view_assets::getsiteroot() . '/mod/hvp/library/';
 98 |     hvp_admin_add_generic_css_and_js($PAGE, $liburl, $settings);
 99 |     $PAGE->requires->js(new moodle_url($liburl . 'js/h5p-version.js' . hvp_get_cache_buster()), true);
100 |     $PAGE->requires->js(new moodle_url($liburl . 'js/h5p-content-upgrade.js' . hvp_get_cache_buster()), true);
101 |     echo $OUTPUT->header();
102 |     echo '<div id="h5p-admin-container">' . get_string('enablejavascript', 'hvp') . '</div>';
103 | }
104 | 
105 | echo $OUTPUT->footer();
106 | 


--------------------------------------------------------------------------------
/grade.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/>.
 16 | /**
 17 |  * View all results for H5P Content
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | 
 24 | require_once(dirname(__FILE__) . '/../../config.php');
 25 | require_once("locallib.php");
 26 | 
 27 | global $DB, $PAGE, $USER, $COURSE;
 28 | 
 29 | $id = required_param('id', PARAM_INT);
 30 | $userid = optional_param('userid', 0, PARAM_INT);
 31 | 
 32 | if (! $cm = get_coursemodule_from_id('hvp', $id)) {
 33 |     print_error('invalidcoursemodule');
 34 | }
 35 | if (! $course = $DB->get_record('course', array('id' => $cm->course))) {
 36 |     print_error('coursemisconf');
 37 | }
 38 | require_course_login($course, false, $cm);
 39 | 
 40 | // Check permission.
 41 | $context = \context_module::instance($cm->id);
 42 | 
 43 | // Load H5P Content.
 44 | $hvp = $DB->get_record_sql(
 45 |         "SELECT h.id,
 46 |                 h.name AS title,
 47 |                 hl.machine_name,
 48 |                 hl.major_version,
 49 |                 hl.minor_version
 50 |            FROM {hvp} h
 51 |            JOIN {hvp_libraries} hl ON hl.id = h.main_library_id
 52 |           WHERE h.id = ?",
 53 |         array($cm->instance));
 54 | 
 55 | if ($hvp === false) {
 56 |     print_error('invalidhvp');
 57 | }
 58 | 
 59 | // Redirect to report if a specific user is chosen.
 60 | if ($userid) {
 61 |     redirect(new moodle_url('/mod/hvp/review.php',
 62 |         array(
 63 |             'id'     => $hvp->id,
 64 |             'course' => $course->id,
 65 |             'user'   => $userid
 66 |         ))
 67 |     );
 68 | }
 69 | hvp_require_view_results_permission((int)$USER->id, $context, $cm->id);
 70 | 
 71 | // Log content result view.
 72 | new \mod_hvp\event(
 73 |         'results', 'content',
 74 |         $hvp->id, $hvp->title,
 75 |         $hvp->machine_name, "{$hvp->major_version}.{$hvp->minor_version}"
 76 | );
 77 | 
 78 | // Set page properties.
 79 | $pageurl = new moodle_url('/mod/hvp/grade.php', array('id' => $hvp->id));
 80 | $PAGE->set_url($pageurl);
 81 | $title = "Results for {$hvp->title}";
 82 | $PAGE->set_title($title);
 83 | $PAGE->set_heading($course->fullname);
 84 | 
 85 | // List all results for specific content.
 86 | $dataviewid = 'h5p-results';
 87 | 
 88 | // Add required assets for data views.
 89 | $root = \mod_hvp\view_assets::getsiteroot();
 90 | $PAGE->requires->js(new moodle_url($root . '/mod/hvp/library/js/jquery.js'), true);
 91 | $PAGE->requires->js(new moodle_url($root . '/mod/hvp/library/js/h5p-utils.js'), true);
 92 | $PAGE->requires->js(new moodle_url($root . '/mod/hvp/library/js/h5p-data-view.js'), true);
 93 | $PAGE->requires->js(new moodle_url($root . '/mod/hvp/dataviews.js'), true);
 94 | $PAGE->requires->css(new moodle_url($root . '/mod/hvp/styles.css'));
 95 | 
 96 | // Add JavaScript settings to data views.
 97 | $settings = array(
 98 |     'dataViews' => array(
 99 |         "{$dataviewid}" => array(
100 |             'source' => "{$root}/mod/hvp/ajax.php?action=results&content_id={$hvp->id}",
101 |             'headers' => array(
102 |                 (object) array(
103 |                     'text' => get_string('user', 'hvp'),
104 |                     'sortable' => true
105 |                 ),
106 |                 (object) array(
107 |                     'text' => get_string('score', 'hvp'),
108 |                     'sortable' => true
109 |                 ),
110 |                 (object) array(
111 |                     'text' => get_string('maxscore', 'hvp'),
112 |                     'sortable' => true
113 |                 ),
114 |                 (object) array(
115 |                     'text' => get_string('finished', 'hvp'),
116 |                     'sortable' => true
117 |                 ),
118 |                 (object) array(
119 |                     'text' => get_string('dataviewreportlabel', 'hvp')
120 |                 )
121 |             ),
122 |             'filters' => array(true),
123 |             'order' => (object) array(
124 |                 'by' => 3,
125 |                 'dir' => 0
126 |             ),
127 |             'l10n' => array(
128 |                 'loading' => get_string('loadingdata', 'hvp'),
129 |                 'ajaxFailed' => get_string('ajaxfailed', 'hvp'),
130 |                 'noData' => get_string('nodata', 'hvp'),
131 |                 'currentPage' => get_string('currentpage', 'hvp'),
132 |                 'nextPage' => get_string('nextpage', 'hvp'),
133 |                 'previousPage' => get_string('previouspage', 'hvp'),
134 |                 'search' => get_string('search', 'hvp'),
135 |                 'empty' => get_string('empty', 'hvp')
136 |             )
137 |         )
138 |     )
139 | );
140 | $PAGE->requires->data_for_js('H5PIntegration', $settings, true);
141 | 
142 | // Print page HTML.
143 | echo $OUTPUT->header();
144 | echo '<div class="clearer"></div>';
145 | 
146 | // Print H5P Content.
147 | echo "<h2>{$title}</h2>";
148 | echo '<div id="h5p-results">' . get_string('javascriptloading', 'hvp') . '</div>';
149 | 
150 | echo $OUTPUT->footer();
151 | 


--------------------------------------------------------------------------------
/library_list.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/>.
 16 | /**
 17 |  * Responsible for displaying the library list page
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | 
 24 | require_once("../../config.php");
 25 | require_once($CFG->libdir.'/adminlib.php');
 26 | require_once("locallib.php");
 27 | 
 28 | // No guest autologin.
 29 | require_login(0, false);
 30 | 
 31 | $pageurl = new moodle_url('/mod/hvp/library_list.php');
 32 | $PAGE->set_url($pageurl);
 33 | 
 34 | // Inform moodle which menu entry currently is active!
 35 | admin_externalpage_setup('h5plibraries');
 36 | 
 37 | $PAGE->set_title("{$SITE->shortname}: " . get_string('libraries', 'hvp'));
 38 | 
 39 | // Create upload libraries form.
 40 | $uploadform = new \mod_hvp\upload_libraries_form();
 41 | if ($formdata = $uploadform->get_data()) {
 42 |     // Handle submitted valid form.
 43 |     $h5pstorage = \mod_hvp\framework::instance('storage');
 44 |     $h5pstorage->savePackage(null, null, true);
 45 | }
 46 | 
 47 | $core = \mod_hvp\framework::instance();
 48 | 
 49 | $hubon = $core->h5pF->getOption('hub_is_enabled', true);
 50 | if ($hubon) {
 51 |     // Create content type cache form.
 52 |     $ctcacheform = new \mod_hvp\content_type_cache_form();
 53 | 
 54 |     // On form submit.
 55 |     if ($ctcacheform->get_data()) {
 56 |         // Update cache and reload page.
 57 |         $core->updateContentTypeCache();
 58 |         redirect($pageurl);
 59 |     }
 60 | }
 61 | 
 62 | $numnotfiltered = $core->h5pF->getNumNotFiltered();
 63 | $libraries = $core->h5pF->loadLibraries();
 64 | 
 65 | // Add settings for each library.
 66 | $settings = array();
 67 | $i = 0;
 68 | foreach ($libraries as $versions) {
 69 |     foreach ($versions as $library) {
 70 |         $usage = $core->h5pF->getLibraryUsage($library->id, $numnotfiltered ? true : false);
 71 |         if ($library->runnable) {
 72 |             $upgrades = $core->getUpgrades($library, $versions);
 73 |             $upgradeurl = empty($upgrades) ? false : (new moodle_url('/mod/hvp/upgrade_content_page.php', array(
 74 |                 'library_id' => $library->id
 75 |             )))->out(false);
 76 | 
 77 |             $restricted = (isset($library->restricted) && $library->restricted == 1 ? true : false);
 78 |             $restrictedurl = (new moodle_url('/mod/hvp/ajax.php', array(
 79 |                 'action' => 'restrict_library',
 80 |                 'token' => \H5PCore::createToken('library_' . $library->id),
 81 |                 'restrict' => ($restricted ? 0 : 1),
 82 |                 'library_id' => $library->id
 83 |             )))->out(false);
 84 |         } else {
 85 |             $upgradeurl = null;
 86 |             $restricted = null;
 87 |             $restrictedurl = null;
 88 |         }
 89 | 
 90 |         $settings['libraryList']['listData'][] = array(
 91 |             'title' => $library->title . ' (' . \H5PCore::libraryVersion($library) . ')',
 92 |             'restricted' => $restricted,
 93 |             'restrictedUrl' => $restrictedurl,
 94 |             'numContent' => $core->h5pF->getNumContent($library->id),
 95 |             'numContentDependencies' => $usage['content'] === -1 ? '' : $usage['content'],
 96 |             'numLibraryDependencies' => $usage['libraries'],
 97 |             'upgradeUrl' => $upgradeurl,
 98 |             'detailsUrl' => null, // Not implemented in Moodle.
 99 |             'deleteUrl' => null // Not implemented in Moodle.
100 |         );
101 | 
102 |         $i++;
103 |     }
104 | }
105 | 
106 | // All translations are made server side.
107 | $settings['libraryList']['listHeaders'] = array(
108 |     get_string('librarylisttitle', 'hvp'),
109 |     get_string('librarylistrestricted', 'hvp'),
110 |     get_string('librarylistinstances', 'hvp'),
111 |     get_string('librarylistinstancedependencies', 'hvp'),
112 |     get_string('librarylistlibrarydependencies', 'hvp'),
113 |     get_string('librarylistactions', 'hvp')
114 | );
115 | 
116 | // Add js.
117 | $liburl = \mod_hvp\view_assets::getsiteroot() . '/mod/hvp/library/';
118 | 
119 | hvp_admin_add_generic_css_and_js($PAGE, $liburl, $settings);
120 | $PAGE->requires->js(new moodle_url($liburl . 'js/h5p-library-list.js' . hvp_get_cache_buster()), true);
121 | 
122 | // RENDER PAGE OUTPUT.
123 | 
124 | echo $OUTPUT->header();
125 | 
126 | // Print any messages.
127 | \mod_hvp\framework::printMessages('info', \mod_hvp\framework::messages('info'));
128 | \mod_hvp\framework::printMessages('error', \mod_hvp\framework::messages('error'));
129 | 
130 | // Page Header.
131 | echo '<h2>' . get_string('libraries', 'hvp') . '</h2>';
132 | 
133 | if ($hubon) {
134 |     // Content type cache form.
135 |     echo '<h3>' . get_string('contenttypecacheheader', 'hvp') . '</h3>';
136 |     $ctcacheform->display();
137 | }
138 | 
139 | // Upload Form.
140 | echo '<h3 class="h5p-admin-header">' . get_string('uploadlibraries', 'hvp') . '</h3>';
141 | $uploadform->display();
142 | 
143 | // Installed Libraries List.
144 | echo '<h3 class="h5p-admin-header">' . get_string('installedlibraries', 'hvp')  . '</h3>';
145 | echo '<div id="h5p-admin-container"></div>';
146 | 
147 | echo $OUTPUT->footer();
148 | 


--------------------------------------------------------------------------------
/db/access.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/>.
 16 | 
 17 | /**
 18 |  * Capability definitions for the hvp module.
 19 |  *
 20 |  * Available archetypes:
 21 |  *  manager
 22 |  *  coursecreator
 23 |  *  editingteacher
 24 |  *  teacher
 25 |  *  student
 26 |  *  guest
 27 |  *  user
 28 |  *  frontpage
 29 |  *
 30 |  * @package    mod_hvp
 31 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 32 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 33 |  */
 34 | 
 35 | defined('MOODLE_INTERNAL') || die();
 36 | 
 37 | $capabilities = array(
 38 | 
 39 |     'mod/hvp:view' => array(
 40 |         'captype' => 'read',
 41 |         'contextlevel' => CONTEXT_MODULE,
 42 |         'archetypes' => array(
 43 |             'manager' => CAP_ALLOW,
 44 |             'editingteacher' => CAP_ALLOW,
 45 |             'teacher' => CAP_ALLOW,
 46 |             'student' => CAP_ALLOW,
 47 |             'guest' => CAP_ALLOW
 48 |         )
 49 |     ),
 50 | 
 51 |     'mod/hvp:addinstance' => array(
 52 |         'riskbitmask' => RISK_SPAM | RISK_XSS,
 53 |         'captype' => 'write',
 54 |         'contextlevel' => CONTEXT_COURSE,
 55 |         'archetypes' => array(
 56 |             'editingteacher' => CAP_ALLOW,
 57 |             'manager' => CAP_ALLOW
 58 |         ),
 59 |         'clonepermissionsfrom' => 'moodle/course:manageactivities'
 60 |     ),
 61 | 
 62 |     'mod/hvp:manage' => array(
 63 |         'riskbitmask' => RISK_SPAM | RISK_XSS,
 64 |         'captype' => 'write',
 65 |         'contextlevel' => CONTEXT_MODULE,
 66 |         'archetypes' => array(
 67 |             'editingteacher' => CAP_ALLOW,
 68 |             'manager' => CAP_ALLOW
 69 |         ),
 70 |         'clonepermissionsfrom' => 'mod/hvp:addinstance'
 71 |     ),
 72 | 
 73 |     'mod/hvp:getexport' => array(
 74 |         'captype' => 'read',
 75 |         'contextlevel' => CONTEXT_MODULE,
 76 |         'archetypes' => array(
 77 |             'manager' => CAP_ALLOW,
 78 |             'editingteacher' => CAP_ALLOW,
 79 |             'teacher' => CAP_ALLOW
 80 |         )
 81 |     ),
 82 | 
 83 |     'mod/hvp:getembedcode' => array(
 84 |         'captype' => 'read',
 85 |         'contextlevel' => CONTEXT_MODULE,
 86 |         'archetypes' => array(
 87 |             'manager' => CAP_ALLOW,
 88 |             'editingteacher' => CAP_ALLOW,
 89 |             'teacher' => CAP_ALLOW
 90 |         )
 91 |     ),
 92 | 
 93 |     'mod/hvp:saveresults' => array(
 94 |         'riskbitmask' => RISK_SPAM,
 95 |         'captype' => 'write',
 96 |         'contextlevel' => CONTEXT_MODULE,
 97 |         'archetypes' => array(
 98 |             'student' => CAP_ALLOW
 99 |         )
100 |     ),
101 | 
102 |     'mod/hvp:savecontentuserdata' => array(
103 |         'captype' => 'write',
104 |         'contextlevel' => CONTEXT_MODULE,
105 |         'archetypes' => array(
106 |             'manager' => CAP_ALLOW,
107 |             'editingteacher' => CAP_ALLOW,
108 |             'teacher' => CAP_ALLOW,
109 |             'student' => CAP_ALLOW
110 |         )
111 |     ),
112 | 
113 |     'mod/hvp:viewresults' => array(
114 |         'captype' => 'write',
115 |         'contextlevel' => CONTEXT_MODULE,
116 |         'archetypes' => array(
117 |             'student' => CAP_ALLOW
118 |         )
119 |     ),
120 | 
121 |     'mod/hvp:viewallresults' => array(
122 |         'captype' => 'read',
123 |         'contextlevel' => CONTEXT_MODULE,
124 |         'archetypes' => array(
125 |             'manager' => CAP_ALLOW,
126 |             'editingteacher' => CAP_ALLOW,
127 |             'teacher' => CAP_ALLOW
128 |         )
129 |     ),
130 | 
131 |     'mod/hvp:restrictlibraries' => array(
132 |         'captype' => 'write',
133 |         'contextlevel' => CONTEXT_SYSTEM,
134 |         'archetypes' => array(
135 |           'manager' => CAP_ALLOW
136 |         )
137 |     ),
138 | 
139 |     'mod/hvp:userestrictedlibraries' => array(
140 |         'captype' => 'write',
141 |         'contextlevel' => CONTEXT_COURSE,
142 |         'archetypes' => array(
143 |             'manager' => CAP_ALLOW
144 |         )
145 |     ),
146 | 
147 |     'mod/hvp:updatelibraries' => array(
148 |         'captype' => 'write',
149 |         'contextlevel' => CONTEXT_SYSTEM,
150 |         'archetypes' => array(
151 |             'manager' => CAP_ALLOW
152 |         )
153 |     ),
154 | 
155 |     'mod/hvp:getcachedassets' => array(
156 |         'captype' => 'read',
157 |         'contextlevel' => CONTEXT_SYSTEM,
158 |         'archetypes' => array(
159 |             'manager' => CAP_ALLOW,
160 |             'editingteacher' => CAP_ALLOW,
161 |             'teacher' => CAP_ALLOW,
162 |             'student' => CAP_ALLOW,
163 |             'user' => CAP_ALLOW,
164 |             'guest' => CAP_ALLOW
165 |         )
166 |     ),
167 | 
168 |     'mod/hvp:installrecommendedh5plibraries' => array(
169 |         'captype' => 'write',
170 |         'contextlevel' => CONTEXT_COURSE,
171 |         'archetypes' => array(
172 |           'manager' => CAP_ALLOW
173 |         )
174 |     ),
175 | 
176 |     // Receive a confirmation message of own h5p submission.
177 |     'mod/hvp:emailconfirmsubmission' => array(
178 |         'captype' => 'read',
179 |         'contextlevel' => CONTEXT_MODULE,
180 |         'archetypes' => array()
181 |     ),
182 | 
183 |     // Receive a notification message of other peoples' h5p submissions.
184 |     'mod/hvp:emailnotifysubmission' => array(
185 |         'captype' => 'read',
186 |         'contextlevel' => CONTEXT_MODULE,
187 |         'archetypes' => array()
188 |     ),
189 | 
190 | );
191 | 


--------------------------------------------------------------------------------
/xapi-collector.js:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * Collect results from xAPI events
  3 |  */
  4 | (function($) {
  5 | 
  6 |     /**
  7 |      * Finds a H5P library instance in an array based on the content ID
  8 |      *
  9 |      * @param  {Array} instances
 10 |      * @param  {number} contentId
 11 |      * @returns {Object|undefined} Content instance
 12 |      */
 13 |     function findInstanceInArray(instances, contentId) {
 14 |         if (instances !== undefined && contentId !== undefined) {
 15 |             for (var i = 0; i < instances.length; i++) {
 16 |                 if (instances[i].contentId === contentId) {
 17 |                     return instances[i];
 18 |                 }
 19 |             }
 20 |         }
 21 |         return undefined;
 22 |     }
 23 | 
 24 |     /**
 25 |      * Finds the global instance from content id by looking through the DOM
 26 |      *
 27 |      * @param {number} [contentId] Content identifier
 28 |      * @returns {Object} Content instance
 29 |      */
 30 |     function getH5PInstance(contentId) {
 31 |         var iframes;
 32 |         var instance = null; // Returning null means no instance is found.
 33 | 
 34 |         // No content id given, search for instance.
 35 |         if (!contentId) {
 36 |             instance = H5P.instances[0];
 37 |             if (!instance) {
 38 |                 iframes = document.getElementsByClassName('h5p-iframe');
 39 |                 // Assume first iframe.
 40 |                 instance = iframes[0].contentWindow.H5P.instances[0];
 41 |             }
 42 |         } else {
 43 |             // Try this documents instances.
 44 |             instance = findInstanceInArray(H5P.instances, contentId);
 45 |             if (!instance) {
 46 |                 // Locate iframes.
 47 |                 iframes = document.getElementsByClassName('h5p-iframe');
 48 |                 for (var i = 0; i < iframes.length; i++) {
 49 |                     // Search through each iframe for content.
 50 |                     instance = findInstanceInArray(iframes[i].contentWindow.H5P.instances, contentId);
 51 |                     if (instance) {
 52 |                         break;
 53 |                     }
 54 |                 }
 55 |             }
 56 |         }
 57 | 
 58 |         return instance;
 59 |     }
 60 | 
 61 |     function getIframe(contentId) {
 62 |         let iFrames;
 63 | 
 64 |         // No content id given.
 65 |         if (!contentId) {
 66 |             iFrames = document.getElementsByClassName('h5p-iframe');
 67 |             // Assume first iframe.
 68 |             return iFrames[0];
 69 |         }
 70 | 
 71 |         // Locate iFrames.
 72 |         iFrames = document.getElementsByClassName('h5p-iframe');
 73 |         for (let i = 0; i < iFrames.length; i++) {
 74 |             // Search through each iframe for content.
 75 |             if (findInstanceInArray(iFrames[i].contentWindow.H5P.instances, contentId)) {
 76 |                 return iFrames[i];
 77 |             }
 78 |         }
 79 | 
 80 |         return null;
 81 |     }
 82 | 
 83 |     /**
 84 |      * Get xAPI data for content type and send off.
 85 |      *
 86 |      * @param {number} contentId Content id
 87 |      * @param {Object} event Original xAPI event
 88 |      */
 89 |     function storeXAPIData(contentId, event) {
 90 |         var xAPIData;
 91 |         var instance = getH5PInstance(contentId);
 92 | 
 93 |         // Use getXAPIData contract, needed to get children.
 94 |         if (instance && instance.getXAPIData) {
 95 |             xAPIData = instance.getXAPIData();
 96 |         } else {
 97 |             // Fallback to event data.
 98 |             xAPIData = {
 99 |                 statement: event.data.statement
100 |             };
101 |         }
102 | 
103 |         // Ship the xAPI result.
104 |         var data = {
105 |             contentId: contentId,
106 |             xAPIResult: JSON.stringify(xAPIData)
107 |         };
108 |         $.post(H5PIntegration.ajax.xAPIResult, data).done(function (data) {
109 |             if (data.error) {
110 |                 console.error('Storing xAPI results failed with error message:', data);
111 |             }
112 |         }).fail(function () {
113 |             if (H5P.offlineRequestQueue) {
114 |                 H5P.offlineRequestQueue.add(H5PIntegration.ajax.xAPIResult, data);
115 |                 return;
116 |             }
117 | 
118 |             // Let H5P iframe know that we want to queue the request for late transmission.
119 |             const iframe = getIframe(contentId);
120 |             if (!iframe) {
121 |                 return;
122 |             }
123 |             iframe.contentWindow.postMessage( {
124 |                 url: H5PIntegration.ajax.xAPIResult,
125 |                 data: data,
126 |                 context: 'h5p',
127 |                 action: 'queueRequest',
128 |             });
129 |         });
130 |     }
131 | 
132 |     $(document).ready(function() {
133 |         // No external dispatcher.
134 |         if (!(window.H5P && H5P.externalDispatcher)) {
135 |             console.error('External dispatcher not found');
136 |             return;
137 |         }
138 | 
139 |         // No ajax path.
140 |         if (!(window.H5PIntegration && H5PIntegration.ajax && H5PIntegration.ajax.xAPIResult)) {
141 |             console.error('No ajax path found');
142 |             return;
143 |         }
144 | 
145 |         // Get emitted xAPI data.
146 |         H5P.externalDispatcher.on('xAPI', function(event) {
147 |             // Skip malformed events.
148 |             var hasStatement = event && event.data && event.data.statement;
149 |             if (!hasStatement) {
150 |                 return;
151 |             }
152 | 
153 |             var statement = event.data.statement;
154 |             var validVerb = statement.verb && statement.verb.display && statement.verb.display['en-US'];
155 |             if (!validVerb) {
156 |                 return;
157 |             }
158 | 
159 |             var isCompleted = statement.verb.display['en-US'] === 'answered' ||
160 |                 statement.verb.display['en-US'] === 'completed';
161 |             var isChild = statement.context && statement.context.contextActivities &&
162 |                 statement.context.contextActivities.parent &&
163 |                 statement.context.contextActivities.parent[0] &&
164 |                 statement.context.contextActivities.parent[0].id;
165 | 
166 |             // Store only completed root events.
167 |             if (isCompleted && !isChild) {
168 |                 // Get xAPI data with children if possible.
169 |                 storeXAPIData(this.contentId, event);
170 |             }
171 |         });
172 |     });
173 | })(H5P.jQuery);
174 | 


--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
  1 | {
  2 |   "env": {
  3 |     "browser": true,
  4 |     "amd": true
  5 |   },
  6 |   "globals": {
  7 |     "M": true,
  8 |     "Y": true,
  9 |     "H5PIntegration": true,
 10 |     "H5PEditor": true,
 11 |     "H5P": true
 12 |   },
 13 |   "rules": {
 14 |     "comma-dangle": "off",
 15 |     "no-compare-neg-zero": "error",
 16 |     "no-cond-assign": "error",
 17 |     "no-console": ["error", {"allow": ["warn", "error"]}],
 18 |     "no-constant-condition": "error",
 19 |     "no-control-regex": "error",
 20 |     "no-debugger": "error",
 21 |     "no-dupe-args": "error",
 22 |     "no-dupe-keys": "error",
 23 |     "no-duplicate-case": "error",
 24 |     "no-empty": "warn",
 25 |     "no-empty-character-class": "error",
 26 |     "no-ex-assign": "error",
 27 |     "no-extra-boolean-cast": "error",
 28 |     "no-extra-parens": "off",
 29 |     "no-extra-semi": "error",
 30 |     "no-func-assign": "error",
 31 |     "no-inner-declarations": "error",
 32 |     "no-invalid-regexp": "error",
 33 |     "no-irregular-whitespace": "error",
 34 |     "no-obj-calls": "error",
 35 |     "no-prototype-builtins": "off",
 36 |     "no-regex-spaces": "error",
 37 |     "no-sparse-arrays": "error",
 38 |     "no-unexpected-multiline": "error",
 39 |     "no-unreachable": "warn",
 40 |     "no-unsafe-finally": "error",
 41 |     "no-unsafe-negation": "error",
 42 |     "use-isnan": "error",
 43 |     "valid-jsdoc": ["warn", { "requireReturn": false, "requireParamDescription": false, "requireReturnDescription": false }],
 44 |     "valid-typeof": "error",
 45 |     "array-callback-return": "warn",
 46 |     "block-scoped-var": "warn",
 47 |     "complexity": "warn",
 48 |     "consistent-return": "warn",
 49 |     "curly": "error",
 50 |     "dot-notation": "warn",
 51 |     "no-alert": "warn",
 52 |     "no-caller": "error",
 53 |     "no-case-declarations": "error",
 54 |     "no-div-regex": "error",
 55 |     "no-empty-pattern": "error",
 56 |     "no-empty-function": "warn",
 57 |     "no-eq-null": "error",
 58 |     "no-eval": "error",
 59 |     "no-extend-native": "error",
 60 |     "no-extra-bind": "warn",
 61 |     "no-fallthrough": "error",
 62 |     "no-floating-decimal": "warn",
 63 |     "no-global-assign": "warn",
 64 |     "no-implied-eval": "error",
 65 |     "no-invalid-this": "error",
 66 |     "no-iterator": "error",
 67 |     "no-labels": "error",
 68 |     "no-loop-func": "error",
 69 |     "no-multi-spaces": "warn",
 70 |     "no-multi-str": "error",
 71 |     "no-new-func": "error",
 72 |     "no-new-wrappers": "error",
 73 |     "no-octal": "error",
 74 |     "no-octal-escape": "error",
 75 |     "no-proto": "error",
 76 |     "no-redeclare": "warn",
 77 |     "no-return-assign": "error",
 78 |     "no-script-url": "error",
 79 |     "no-self-assign": "error",
 80 |     "no-self-compare": "error",
 81 |     "no-sequences": "warn",
 82 |     "no-throw-literal": "warn",
 83 |     "no-unmodified-loop-condition": "error",
 84 |     "no-unused-expressions": "error",
 85 |     "no-unused-labels": "error",
 86 |     "no-useless-call": "warn",
 87 |     "no-useless-escape": "warn",
 88 |     "no-with": "error",
 89 |     "wrap-iife": ["error", "any"],
 90 | 
 91 |     "no-delete-var": "error",
 92 |     "no-undef": "error",
 93 |     "no-undef-init": "error",
 94 |     "no-unused-vars": ["error", { "caughtErrors": "none" }],
 95 | 
 96 |     "array-bracket-spacing": "warn",
 97 |     "block-spacing": "warn",
 98 |     "brace-style": ["warn", "1tbs"],
 99 |     "camelcase": "warn",
100 |     "capitalized-comments": ["warn", "always", { "ignoreConsecutiveComments": true }],
101 |     "comma-spacing": ["warn", { "before": false, "after": true }],
102 |     "comma-style": ["warn", "last"],
103 |     "computed-property-spacing": "error",
104 |     "consistent-this": "off",
105 |     "eol-last": "off",
106 |     "func-call-spacing": ["warn", "never"],
107 |     "func-names": "off",
108 |     "func-style": "off",
109 |     "indent": ["off", 4, { "SwitchCase": 1 }],
110 |     "key-spacing": ["warn", { "beforeColon": false, "afterColon": true, "mode": minimum }],
111 |     "keyword-spacing": "warn",
112 |     "linebreak-style": ["error", "unix"],
113 |     "lines-around-comment": "off",
114 |     "max-len": ["error", 132],
115 |     "max-lines": "off",
116 |     "max-depth": "warn",
117 |     "max-nested-callbacks": ["warn", 5],
118 |     "max-params": "off",
119 |     "max-statements": "off",
120 |     "max-statements-per-line": ["warn", { max: 2 }],
121 |     "new-cap": ["warn", { "properties": false }],
122 |     "new-parens": "warn",
123 |     "newline-after-var": "off",
124 |     "newline-before-return": "off",
125 |     "newline-per-chained-call": "off",
126 |     "no-array-constructor": "off",
127 |     "no-bitwise": "error",
128 |     "no-continue": "off",
129 |     "no-inline-comments": "off",
130 |     "no-lonely-if": "off",
131 |     "no-mixed-operators": "off",
132 |     "no-mixed-spaces-and-tabs": "error",
133 |     "no-multiple-empty-lines": "warn",
134 |     "no-negated-condition": "off",
135 |     "no-nested-ternary": "warn",
136 |     "no-new-object": "off",
137 |     "no-plusplus": "off",
138 |     "no-tabs": "error",
139 |     "no-ternary": "off",
140 |     "no-trailing-spaces": "error",
141 |     "no-underscore-dangle": "off",
142 |     "no-unneeded-ternary": "off",
143 |     "no-whitespace-before-property": "warn",
144 |     "object-curly-newline": "off",
145 |     "object-curly-spacing": "warn",
146 |     "object-property-newline": "off",
147 |     "one-var": "off",
148 |     "one-var-declaration-per-line": ["warn", "initializations"],
149 |     "operator-assignment": "off",
150 |     "operator-linebreak": "off",
151 |     "padded-blocks": "off",
152 |     "quote-props": ["warn", "as-needed", {"unnecessary": false, "keywords": true, "numbers": true}],
153 |     "quotes": "off",
154 |     "require-jsdoc": "warn",
155 |     "semi": "error",
156 |     "semi-spacing": ["warn", {"before": false, "after": true}],
157 |     "sort-vars": "off",
158 |     "space-before-blocks": "warn",
159 |     "space-before-function-paren": ["warn", "never"],
160 |     "space-in-parens": "warn",
161 |     "space-infix-ops": "warn",
162 |     "space-unary-ops": "warn",
163 |     "spaced-comment": "warn",
164 |     "unicode-bom": "error",
165 |     "wrap-regex": "off",
166 | 
167 |     "no-restricted-properties": ["warn", {
168 |         "object": "M",
169 |         "property": "str",
170 |         "message": "Use AMD module 'core/str' or M.util.get_string()"
171 |     }],
172 | 
173 |   },
174 |   overrides: [
175 |     {
176 |       files: ["**/yui/src/**/*.js"],
177 | 
178 |       rules: {
179 |         "no-undef": "off",
180 |         "no-unused-vars": "off",
181 |         "no-unused-expressions": "off"
182 |       }
183 |     },
184 |     {
185 |       files: ["**/amd/src/*.js"],
186 |       rules: {
187 |         "no-unused-vars": "error",
188 |         "no-implicit-globals": "error"
189 |       }
190 |     }
191 |   ]
192 | }
193 | 


--------------------------------------------------------------------------------
/classes/editor_ajax.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/>.
 16 | 
 17 | /**
 18 |  * \mod_hvp\editor_ajax class
 19 |  *
 20 |  * @package    mod_hvp
 21 |  * @copyright  2016 Joubel AS
 22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 23 |  */
 24 | 
 25 | namespace mod_hvp;
 26 | 
 27 | defined('MOODLE_INTERNAL') || die();
 28 | 
 29 | require_once(__DIR__ . '/../autoloader.php');
 30 | 
 31 | /**
 32 |  * Moodle's implementation of the H5P Editor Ajax interface.
 33 |  * Makes it possible for the editor's core ajax functionality to communicate with the
 34 |  * database used by Moodle.
 35 |  *
 36 |  * @package    mod_hvp
 37 |  * @copyright  2016 Joubel AS
 38 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 39 |  */
 40 | class editor_ajax implements \H5PEditorAjaxInterface {
 41 | 
 42 |     /**
 43 |      * Gets latest library versions that exists locally
 44 |      *
 45 |      * @return array Latest version of all local libraries
 46 |      * @throws \dml_exception
 47 |      */
 48 |     // @codingStandardsIgnoreLine
 49 |     public function getLatestLibraryVersions() {
 50 |         global $DB;
 51 | 
 52 |         $maxmajorversionsql = "
 53 |             SELECT hl.machine_name, MAX(hl.major_version) AS major_version
 54 |             FROM {hvp_libraries} hl
 55 |             WHERE hl.runnable = 1
 56 |             GROUP BY hl.machine_name";
 57 | 
 58 |         $maxminorversionsql = "
 59 |             SELECT hl2.machine_name, hl2.major_version, MAX(hl2.minor_version) AS minor_version
 60 |             FROM ({$maxmajorversionsql}) hl1
 61 |             JOIN {hvp_libraries} hl2
 62 |             ON hl1.machine_name = hl2.machine_name
 63 |             AND hl1.major_version = hl2.major_version
 64 |             GROUP BY hl2.machine_name, hl2.major_version";
 65 | 
 66 |         return $DB->get_records_sql("
 67 |             SELECT hl4.id, hl4.machine_name, hl4.title, hl4.major_version,
 68 |                 hl4.minor_version, hl4.patch_version, hl4.has_icon, hl4.restricted
 69 |             FROM {hvp_libraries} hl4
 70 |             JOIN ({$maxminorversionsql}) hl3
 71 |             ON hl4.machine_name = hl3.machine_name
 72 |             AND hl4.major_version = hl3.major_version
 73 |             AND hl4.minor_version = hl3.minor_version"
 74 |         );
 75 |     }
 76 | 
 77 |     /**
 78 |      * Get locally stored Content Type Cache. If machine name is provided
 79 |      * it will only get the given content type from the cache
 80 |      *
 81 |      * @param null $machinename
 82 |      *
 83 |      * @return array|mixed|null|object Returns results from querying the database
 84 |      * @throws \dml_exception
 85 |      */
 86 |     // @codingStandardsIgnoreLine
 87 |     public function getContentTypeCache($machinename = null) {
 88 |         global $DB;
 89 | 
 90 |         if ($machinename) {
 91 |             return $DB->get_record_sql(
 92 |                 "SELECT id, is_recommended
 93 |                    FROM {hvp_libraries_hub_cache}
 94 |                   WHERE machine_name = ?",
 95 |                 array($machinename)
 96 |             );
 97 |         }
 98 | 
 99 |         return $DB->get_records("hvp_libraries_hub_cache");
100 |     }
101 | 
102 |     /**
103 |      * Gets recently used libraries for the current author
104 |      *
105 |      * @return array machine names. The first element in the array is the
106 |      * most recently used.
107 |      */
108 |     // @codingStandardsIgnoreLine
109 |     public function getAuthorsRecentlyUsedLibraries() {
110 |         global $DB;
111 |         global $USER;
112 |         $recentlyused = array();
113 | 
114 |         $results = $DB->get_records_sql(
115 |             "SELECT library_name, max(created_at) AS max_created_at
116 |             FROM {hvp_events}
117 |            WHERE type='content' AND sub_type = 'create' AND user_id = ?
118 |         GROUP BY library_name
119 |         ORDER BY max_created_at DESC", array($USER->id));
120 | 
121 |         foreach ($results as $row) {
122 |             $recentlyused[] = $row->library_name;
123 |         }
124 | 
125 |         return $recentlyused;
126 |     }
127 | 
128 |     /**
129 |      * Checks if the provided token is valid for this endpoint
130 |      *
131 |      * @param string $token The token that will be validated for.
132 |      *
133 |      * @return bool True if successful validation
134 |      */
135 |     // @codingStandardsIgnoreLine
136 |     public function validateEditorToken($token) {
137 |         return \H5PCore::validToken('editorajax', $token);
138 |     }
139 | 
140 |     /**
141 |      * Get translations for a language for a list of libraries
142 |      *
143 |      * @param array $libraries An array of libraries, in the form "<machineName> <majorVersion>.<minorVersion>
144 |      * @param string $language_code
145 |      *
146 |      * @return array
147 |      * @throws \dml_exception
148 |      */
149 |     public function getTranslations($libraries, $language_code) {
150 |         global $DB;
151 | 
152 |         $translations = array();
153 | 
154 |         foreach ($libraries as $library) {
155 |             $parsedLib = \H5PCore::libraryFromString($library);
156 | 
157 |             $sql         = "
158 |                     SELECT language_json
159 |                     FROM {hvp_libraries} lib
160 |                       LEFT JOIN {hvp_libraries_languages} lang
161 |                     ON lib.id = lang.library_id
162 |                     WHERE lib.machine_name = :machine_name AND
163 |                       lib.major_version = :major_version AND
164 |                       lib.minor_version = :minor_version AND
165 |                       lang.language_code = :language_code";
166 |             $translation = $DB->get_field_sql($sql, array(
167 |                 'machine_name'  => $parsedLib['machineName'],
168 |                 'major_version' => $parsedLib['majorVersion'],
169 |                 'minor_version' => $parsedLib['minorVersion'],
170 |                 'language_code' => $language_code,
171 |             ));
172 | 
173 |             if ($translation !== false) {
174 |                 $translations[$library] = $translation;
175 |             }
176 |         }
177 | 
178 |         return $translations;
179 |     }
180 | }
181 | 


--------------------------------------------------------------------------------
/settings.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/>.
 16 | /**
 17 |  * Administration settings definitions for the hvp module.
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | 
 24 | // Make sure we are called from an internal Moodle site.
 25 | defined('MOODLE_INTERNAL') || die();
 26 | 
 27 | require_once($CFG->dirroot . '/mod/hvp/lib.php');
 28 | 
 29 | global $PAGE;
 30 | 
 31 | // Make sure core is loaded.
 32 | $core = \mod_hvp\framework::instance('core');
 33 | 
 34 | // Redefine the H5P admin menu entry to be expandable.
 35 | $modltifolder = new admin_category('modhvpfolder', new lang_string('pluginname', 'mod_hvp'), $module->is_enabled() === false);
 36 | // Add the Settings admin menu entry.
 37 | $ADMIN->add('modsettings', $modltifolder);
 38 | $settings->visiblename = new lang_string('settings', 'mod_hvp');
 39 | // Add the Libraries admin menu entry.
 40 | $ADMIN->add('modhvpfolder', $settings);
 41 | $ADMIN->add('modhvpfolder', new admin_externalpage('h5plibraries',
 42 |     get_string('libraries', 'hvp'), new moodle_url('/mod/hvp/library_list.php')));
 43 | 
 44 | if ($ADMIN->fulltree) {
 45 |     // Settings is stored on the global $CFG object.
 46 | 
 47 |     // Content state.
 48 |     $settings->add(
 49 |             new admin_setting_configcheckbox('mod_hvp/enable_save_content_state',
 50 |                     get_string('enablesavecontentstate', 'hvp'),
 51 |                     get_string('enablesavecontentstate_help', 'hvp'), 0));
 52 |     $settings->add(
 53 |             new admin_setting_configtext('mod_hvp/content_state_frequency',
 54 |                     get_string('contentstatefrequency', 'hvp'),
 55 |                     get_string('contentstatefrequency_help', 'hvp'), 30, PARAM_INT));
 56 | 
 57 |     $PAGE->requires->js('/mod/hvp/library/js/jquery.js', true);
 58 |     $PAGE->requires->js('/mod/hvp/library/js/h5p-display-options.js', true);
 59 | 
 60 |     // Send usage statistics.
 61 |     $settings->add(
 62 |         new admin_setting_configcheckbox('mod_hvp/send_usage_statistics',
 63 |             get_string('sendusagestatistics', 'hvp'),
 64 |             get_string('sendusagestatistics_help', 'hvp',
 65 |                 'href="https://h5p.org/tracking-the-usage-of-h5p" target="_blank"'),
 66 |             1)
 67 |     );
 68 | 
 69 |     $choices = array(
 70 |         H5PDisplayOptionBehaviour::NEVER_SHOW => get_string('displayoptiondownloadnever', 'hvp'),
 71 |         H5PDisplayOptionBehaviour::ALWAYS_SHOW => get_string('displayoptiondownloadalways', 'hvp'),
 72 |         H5PDisplayOptionBehaviour::CONTROLLED_BY_PERMISSIONS => get_string('displayoptiondownloadpermission', 'hvp'),
 73 |         H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_ON => get_string('displayoptionauthoron', 'hvp'),
 74 |         H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_OFF => get_string('displayoptionauthoroff', 'hvp')
 75 |     );
 76 | 
 77 |     $embedchoices = array(
 78 |         H5PDisplayOptionBehaviour::NEVER_SHOW => get_string('displayoptionnevershow', 'hvp'),
 79 |         H5PDisplayOptionBehaviour::ALWAYS_SHOW => get_string('displayoptionalwaysshow', 'hvp'),
 80 |         H5PDisplayOptionBehaviour::CONTROLLED_BY_PERMISSIONS => get_string('displayoptionpermissionsembed', 'hvp'),
 81 |         H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_ON => get_string('displayoptionauthoron', 'hvp'),
 82 |         H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_OFF => get_string('displayoptionauthoroff', 'hvp')
 83 |     );
 84 | 
 85 |     // Display options for H5P frame.
 86 |     $settings->add(new admin_setting_heading('mod_hvp/display_options', get_string('displayoptions', 'hvp'), ''));
 87 |     $settings->add(new admin_setting_configcheckbox('mod_hvp/frame', get_string('enableframe', 'hvp'), '', 1));
 88 |     $settings->add(new admin_setting_configselect('mod_hvp/export', get_string('enabledownload', 'hvp'), '',
 89 |                                                   H5PDisplayOptionBehaviour::ALWAYS_SHOW, $choices));
 90 |     $settings->add(new admin_setting_configselect('mod_hvp/embed', get_string('enableembed', 'hvp'), '',
 91 |                                                   H5PDisplayOptionBehaviour::ALWAYS_SHOW, $embedchoices));
 92 |     $settings->add(new admin_setting_configcheckbox('mod_hvp/copyright', get_string('enablecopyright', 'hvp'), '', 1));
 93 |     $settings->add(new admin_setting_configcheckbox('mod_hvp/icon', get_string('enableabout', 'hvp'), '', 1));
 94 | 
 95 |     // Content Types header.
 96 |     $settings->add(new admin_setting_heading('mod_hvp/hub_settings', get_string('hubsettingsheader', 'hvp'), ''));
 97 | 
 98 |     // LRS.
 99 |     $settings->add(
100 |             new admin_setting_configcheckbox('mod_hvp/enable_lrs_content_types',
101 |                     get_string('enabledlrscontenttypes', 'hvp'),
102 |                     get_string('enabledlrscontenttypes_help', 'hvp'), 0));
103 | 
104 |     // Use H5P Hub.
105 |     $settings->add(
106 |         new admin_setting_configcheckbox(
107 |             'mod_hvp/hub_is_enabled',
108 |             get_string('enablehublabel', 'hvp'),
109 |             get_string('disablehubdescription', 'hvp'),
110 |             1
111 |         )
112 |     );
113 | 
114 |     // Load js for disable hub confirmation dialog functionality.
115 |     $PAGE->requires->js('/mod/hvp/library/js/jquery.js', true);
116 |     $PAGE->requires->js('/mod/hvp/library/js/h5p-event-dispatcher.js', true);
117 |     $PAGE->requires->js('/mod/hvp/library/js/h5p-confirmation-dialog.js', true);
118 |     $PAGE->requires->js('/mod/hvp/library/js/settings/h5p-disable-hub.js', true);
119 | 
120 |     // Skip applying css when page has already loaded, since Moodle does not.
121 |     // allow us to require the css at this point.
122 |     if ($PAGE->state !== 2) {
123 |         $PAGE->requires->css('/mod/hvp/library/styles/h5p-confirmation-dialog.css');
124 |         $PAGE->requires->css('/mod/hvp/library/styles/h5p.css');
125 |         $PAGE->requires->css('/mod/hvp/library/styles/h5p-core-button.css');
126 |     }
127 | 
128 |     // Find missing requirements.
129 |     $core = \mod_hvp\framework::instance('core');
130 |     $errors = $core->checkSetupErrorMessage()->errors;
131 | 
132 |     $PAGE->requires->data_for_js('H5PDisableHubData', array(
133 |         'selector' => '#id_s_mod_hvp_hub_is_enabled',
134 |         'overlaySelector' => '#adminsettings',
135 |         'header' => get_string('confirmdialogheader', 'hvp'),
136 |         'confirmLabel' => get_string('confirmlabel', 'hvp'),
137 |         'cancelLabel' => get_string('cancellabel', 'hvp'),
138 |         'confirmationDialogMsg' => get_string('disablehubconfirmationmsg', 'hvp'),
139 |         'errors' => $errors
140 |     ));
141 | }
142 | 
143 | // Prevent Moodle from adding settings block in standard location.
144 | $settings = null;
145 | 


--------------------------------------------------------------------------------
/review.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/>.
 16 | /**
 17 |  * View all results for H5P Content
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | 
 24 | require_once(dirname(__FILE__) . '/../../config.php');
 25 | require_once("locallib.php");
 26 | global $USER, $PAGE, $DB, $CFG, $OUTPUT, $COURSE;
 27 | 
 28 | $id     = required_param('id', PARAM_INT);
 29 | $userid = optional_param('user', (int) $USER->id, PARAM_INT);
 30 | 
 31 | if (!$cm = get_coursemodule_from_instance('hvp', $id)) {
 32 |     print_error('invalidcoursemodule');
 33 | }
 34 | if (!$course = $DB->get_record('course', ['id' => $cm->course])) {
 35 |     print_error('coursemisconf');
 36 | }
 37 | require_login($course, false, $cm);
 38 | 
 39 | // Check permission.
 40 | $context = \context_module::instance($cm->id);
 41 | hvp_require_view_results_permission($userid, $context, $cm->id);
 42 | 
 43 | // Load H5P Content.
 44 | $hvp = $DB->get_record_sql(
 45 |     "SELECT h.id,
 46 |                 h.name AS title,
 47 |                 hl.machine_name,
 48 |                 hl.major_version,
 49 |                 hl.minor_version
 50 |            FROM {hvp} h
 51 |            JOIN {hvp_libraries} hl ON hl.id = h.main_library_id
 52 |           WHERE h.id = ?",
 53 |     [$id]);
 54 | 
 55 | if ($hvp === false) {
 56 |     print_error('invalidhvp');
 57 | }
 58 | 
 59 | // Set page properties.
 60 | $pageurl = new moodle_url('/mod/hvp/review.php', [
 61 |     'id' => $hvp->id,
 62 | ]);
 63 | $basepath = \mod_hvp\view_assets::getsiteroot();
 64 | $PAGE->set_url($pageurl);
 65 | $PAGE->set_title($hvp->title);
 66 | $PAGE->set_heading($COURSE->fullname);
 67 | $PAGE->requires->css(new moodle_url($basepath . '/mod/hvp/xapi-custom-report.css'));
 68 | 
 69 | // We have to get grades from gradebook as well.
 70 | $xapiresults = $DB->get_records_sql("
 71 |     SELECT x.*, i.grademax
 72 |     FROM {hvp_xapi_results} x
 73 |     JOIN {grade_items} i ON i.iteminstance = x.content_id
 74 |     WHERE x.user_id = ?
 75 |     AND x.content_id = ?
 76 |     AND i.itemtype = 'mod'
 77 |     AND i.itemmodule = 'hvp'", [$userid, $id]
 78 | );
 79 | 
 80 | if (!$xapiresults) {
 81 |     echo $OUTPUT->header();
 82 |     echo "<h2>" . get_string('noanswersubmitted', 'hvp') . "</h2>";
 83 |     echo $OUTPUT->footer();
 84 |     return;
 85 | }
 86 | 
 87 | $totalrawscore       = null;
 88 | $totalmaxscore       = null;
 89 | $totalscaledscore    = null;
 90 | $scaledscoreperscore = null;
 91 | 
 92 | // Assemble our question tree.
 93 | $basequestion = null;
 94 | 
 95 | // Find base question.
 96 | foreach ($xapiresults as $question) {
 97 |     if ($question->parent_id === null) {
 98 |         // This is the root of our tree.
 99 |         $basequestion = $question;
100 | 
101 |         if (isset($question->raw_score) && isset($question->grademax) && isset($question->max_score)) {
102 |             $scaledscoreperscore   = $question->max_score ? ($question->grademax / $question->max_score) : 0;
103 |             $question->score_scale = round($scaledscoreperscore, 2);
104 |             $totalrawscore         = $question->raw_score;
105 |             $totalmaxscore         = $question->max_score;
106 |             if ($question->max_score && $question->raw_score === $question->max_score) {
107 |                 $totalscaledscore = round($question->grademax, 2);
108 |             } else {
109 |                 $totalscaledscore = round($question->score_scale * $question->raw_score, 2);
110 |             }
111 |         }
112 |         break;
113 |     }
114 | }
115 | 
116 | foreach ($xapiresults as $question) {
117 |     if ($question->parent_id === null) {
118 |         // Already processed.
119 |         continue;
120 |     } else if (isset($xapiresults[$question->parent_id])) {
121 |         // Add to parent.
122 |         $xapiresults[$question->parent_id]->children[] = $question;
123 |     }
124 | 
125 |     // Set scores.
126 |     if (!isset($question->raw_score)) {
127 |         $question->raw_score = 0;
128 |     }
129 |     if (isset($question->raw_score) && isset($question->grademax) && isset($question->max_score)) {
130 |         $question->scaled_score_per_score = $scaledscoreperscore;
131 |         $question->parent_max_score = $totalmaxscore;
132 |         $question->score_scale = round($question->raw_score * $scaledscoreperscore, 2);
133 |     }
134 | 
135 |     // Set score labels.
136 |     $question->score_label            = get_string('reportingscorelabel', 'hvp');
137 |     $question->scaled_score_label     = get_string('reportingscaledscorelabel', 'hvp');
138 |     $question->score_delimiter        = get_string('reportingscoredelimiter', 'hvp');
139 |     $question->scaled_score_delimiter = get_string('reportingscaledscoredelimiter', 'hvp');
140 |     $question->questions_remaining_label = get_string('reportingquestionsremaininglabel', 'hvp');
141 | }
142 | 
143 | // Initialize reporter.
144 | $reporter   = H5PReport::getInstance();
145 | $reporthtml = $reporter->generateReport($basequestion, null, count($xapiresults) <= 1);
146 | $styles     = $reporter->getStylesUsed();
147 | $scripts    = $reporter->getScriptsUsed();
148 | foreach ($styles as $style) {
149 |     $PAGE->requires->css(new moodle_url($basepath . '/mod/hvp/reporting/' . $style));
150 | }
151 | foreach ($scripts as $script) {
152 |     $PAGE->requires->js(new moodle_url($basepath . '/mod/hvp/reporting/' . $script));
153 | }
154 | 
155 | $PAGE->requires->js(new moodle_url($basepath . '/mod/hvp/library/js/jquery.js'), true);
156 | 
157 | // Send the enpoints necessary for dynamic grading to the view.
158 | $setsubcontentendpoint = "{$basepath}/mod/hvp/ajax.php?contextId={$context->instanceid}&token=" .
159 |     \H5PCore::createToken('result') . '&action=updatesubcontentscore';
160 | $getsubcontentendpoint = "{$basepath}/mod/hvp/ajax.php?contextId={$context->instanceid}&token=" .
161 |     \H5PCore::createToken('result') . '&action=getsubcontentscore';
162 | $datatosend = array(
163 |   'setSubContentEndpoint' => $setsubcontentendpoint,
164 |   'getSubContentEndpoint' => $getsubcontentendpoint,
165 | );
166 | $PAGE->requires->data_for_js('data_for_page', $datatosend, true);
167 | 
168 | $renderer = $PAGE->get_renderer('mod_hvp');
169 | 
170 | // Print title and report.
171 | $title = $hvp->title;
172 | 
173 | // Show user name if other then self.
174 | if ($userid !== (int) $USER->id) {
175 |     $userresult = $DB->get_record('user', ["id" => $userid], 'username');
176 |     if (isset($userresult) && isset($userresult->username)) {
177 |         $title .= ": {$userresult->username}";
178 |     }
179 | }
180 | 
181 | // Create title.
182 | $reviewcontext = [
183 |     'title'          => $title,
184 |     'report'         => $reporthtml,
185 |     'rawScore'       => $totalrawscore,
186 |     'maxScore'       => $totalmaxscore,
187 |     'scaledScore'    => round($totalscaledscore, 2),
188 |     'maxScaledScore' => round($basequestion->grademax, 2),
189 | ];
190 | 
191 | // Print page HTML.
192 | echo $OUTPUT->header();
193 | echo $renderer->render_from_template('hvp/review', $reviewcontext);
194 | echo $OUTPUT->footer();
195 | 


--------------------------------------------------------------------------------
/classes/user_grades.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/>.
 16 | 
 17 | /**
 18 |  * The mod_hvp user grades
 19 |  *
 20 |  * @package    mod_hvp
 21 |  * @copyright  2016 Joubel AS
 22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 23 |  */
 24 | namespace mod_hvp;
 25 | 
 26 | defined('MOODLE_INTERNAL') || die();
 27 | 
 28 | require(__DIR__ . '/../lib.php');
 29 | 
 30 | /**
 31 |  * Handles grade storage for users
 32 |  * @package mod_hvp
 33 |  */
 34 | class user_grades {
 35 | 
 36 |     public static function handle_ajax() {
 37 |         global $DB, $USER, $CFG;
 38 | 
 39 |         if (!\H5PCore::validToken('result', required_param('token', PARAM_RAW))) {
 40 |             \H5PCore::ajaxError(get_string('invalidtoken', 'hvp'));
 41 |             return;
 42 |         }
 43 | 
 44 |         $cm = get_coursemodule_from_id('hvp', required_param('contextId', PARAM_INT));
 45 |         if (!$cm) {
 46 |             \H5PCore::ajaxError('No such content');
 47 |             http_response_code(404);
 48 |             return;
 49 |         }
 50 | 
 51 |         // Content parameters.
 52 |         $score = required_param('score', PARAM_INT);
 53 |         $maxscore = required_param('maxScore', PARAM_INT);
 54 | 
 55 |         // Check permission.
 56 |         $context = \context_module::instance($cm->id);
 57 |         if (!has_capability('mod/hvp:saveresults', $context)) {
 58 |             \H5PCore::ajaxError(get_string('nopermissiontosaveresult', 'hvp'));
 59 |             http_response_code(403);
 60 |             return;
 61 |         }
 62 | 
 63 |         // Get hvp data from content.
 64 |         $hvp = $DB->get_record('hvp', array('id' => $cm->instance));
 65 |         if (!$hvp) {
 66 |             \H5PCore::ajaxError('No such content');
 67 |             http_response_code(404);
 68 |             return;
 69 |         }
 70 | 
 71 |         // Create grade object and set grades.
 72 |         $grade = (object) array(
 73 |             'userid' => $USER->id
 74 |         );
 75 | 
 76 |         // Set grade using Gradebook API.
 77 |         $hvp->cmidnumber = $cm->idnumber;
 78 |         $hvp->name = $cm->name;
 79 |         $hvp->rawgrade = $score;
 80 |         $hvp->rawgrademax = $maxscore;
 81 |         hvp_grade_item_update($hvp, $grade);
 82 | 
 83 |         // Get content info for log.
 84 |         $content = $DB->get_record_sql(
 85 |                 "SELECT c.name AS title, l.machine_name AS name, l.major_version, l.minor_version
 86 |                    FROM {hvp} c
 87 |                    JOIN {hvp_libraries} l ON l.id = c.main_library_id
 88 |                   WHERE c.id = ?",
 89 |                 array($hvp->id)
 90 |         );
 91 | 
 92 |         require_once($CFG->libdir.'/completionlib.php');
 93 | 
 94 |         // Load Course.
 95 |         $course = $DB->get_record('course', array('id' => $cm->course));
 96 |         $completion = new \completion_info( $course );
 97 | 
 98 |         if ( $completion->is_enabled( $cm) ) {
 99 |             $completion->update_state($cm, COMPLETION_COMPLETE);
100 |         }
101 | 
102 |         // Log results set event.
103 |         new \mod_hvp\event(
104 |                 'results', 'set',
105 |                 $hvp->id, $content->title,
106 |                 $content->name, $content->major_version . '.' . $content->minor_version
107 |         );
108 | 
109 |         // Trigger Moodle event for async notification messages.
110 |         $event = \mod_hvp\event\attempt_submitted::create([
111 |             'context' => $context,
112 |         ]);
113 |         $event->trigger();
114 | 
115 |         \H5PCore::ajaxSuccess();
116 |     }
117 | 
118 |     /**
119 |      *  Since the subcontent types do not have their own row in the table,
120 |      *  we use the hvp_results_table as a 'staging area' to set and get
121 |      *  dynamically graded scores.
122 |      */
123 |     public static function handle_dynamic_grading() {
124 |         global $DB;
125 | 
126 |         if (!\H5PCore::validToken('result', required_param('token', PARAM_RAW))) {
127 |             \H5PCore::ajaxError(get_string('invalidtoken', 'hvp'));
128 |             return;
129 |         }
130 | 
131 |         $cm = get_coursemodule_from_id('hvp', required_param('contextId', PARAM_INT));
132 |         if (!$cm) {
133 |             \H5PCore::ajaxError('No such content');
134 |             http_response_code(404);
135 |             return;
136 |         }
137 | 
138 |         // Content parameters.
139 |         $subcontentid = required_param('subcontent_id', PARAM_INT);
140 |         $score = required_param('score', PARAM_INT);
141 | 
142 |         // Update the answer's score.
143 |         $data = (object) [
144 |             'id' => $subcontentid,
145 |             'raw_score' => $score
146 |         ];
147 |         $DB->update_record('hvp_xapi_results', $data, false);
148 | 
149 |         // Load freshly updated record.
150 |         $answer = $DB->get_record('hvp_xapi_results', array('id' => $subcontentid));
151 | 
152 |         // Get the sum of all the OEQ scores with the same parent.
153 |         $totalgradablesscore = intval($DB->get_field_sql(
154 |             "SELECT SUM(raw_score)
155 |             FROM {hvp_xapi_results}
156 |             WHERE parent_id = ?
157 |             AND additionals = ?", array($answer->parent_id,
158 |             '{"extensions":{"https:\/\/h5p.org\/x-api\/h5p-machine-name":"H5P.FreeTextQuestion"}}')
159 |         ));
160 | 
161 |         // Get the original raw score from the main content type.
162 |         $baseanswer = $DB->get_record('hvp_xapi_results', array(
163 |             'id' => $answer->parent_id
164 |         ));
165 | 
166 |         // Get hvp data from content.
167 |         $hvp = $DB->get_record('hvp', array('id' => $cm->instance));
168 |         if (!$hvp) {
169 |             \H5PCore::ajaxError('No such content');
170 |             http_response_code(404);
171 |             return;
172 |         }
173 | 
174 |         // Set grade using Gradebook API.
175 |         $hvp->rawgrade = $baseanswer->raw_score + $totalgradablesscore;
176 |         $hvp->rawgrademax = $baseanswer->max_score;
177 |         hvp_grade_item_update($hvp, (object) array(
178 |             'userid' => $answer->user_id
179 |         ));
180 | 
181 |         // Get the num of ungraded OEQ answers.
182 |         $numungraded = intval($DB->get_field_sql(
183 |             "SELECT COUNT(*)
184 |             FROM {hvp_xapi_results}
185 |             WHERE parent_id = ?
186 |             AND raw_score IS NULL
187 |             AND additionals = ?", array($answer->parent_id,
188 |             '{"extensions":{"https:\/\/h5p.org\/x-api\/h5p-machine-name":"H5P.FreeTextQuestion"}}')
189 |         ));
190 | 
191 |         $response = [
192 |             'score' => $answer->raw_score,
193 |             'maxScore' => $answer->max_score,
194 |             'totalUngraded' => $numungraded,
195 |         ];
196 |         \H5PCore::ajaxSuccess($response);
197 |     }
198 | 
199 |     /**
200 |      * Fetch score/maxScore for ungraded item + number of ungraded items.
201 |      */
202 |     public static function return_subcontent_grade() {
203 |         global $DB;
204 | 
205 |         // Content parameters.
206 |         $subcontentid = required_param('subcontent_id', PARAM_INT);
207 |         $answer = $DB->get_record('hvp_xapi_results', array('id' => $subcontentid));
208 | 
209 |         // Get the num of ungraded OEQ answers.
210 |         $numungraded = intval($DB->get_field_sql(
211 |             "SELECT COUNT(*)
212 |             FROM {hvp_xapi_results}
213 |             WHERE parent_id = ?
214 |             AND raw_score IS NULL
215 |             AND additionals = ?", array($answer->parent_id,
216 |             '{"extensions":{"https:\/\/h5p.org\/x-api\/h5p-machine-name":"H5P.FreeTextQuestion"}}')
217 |         ));
218 | 
219 |         $response = [
220 |             'score' => $answer->raw_score,
221 |             'maxScore' => $answer->max_score,
222 |             'totalUngraded' => $numungraded,
223 |         ];
224 |         \H5PCore::ajaxSuccess($response);
225 |     }
226 | }
227 | 


--------------------------------------------------------------------------------
/classes/content_user_data.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/>.
 16 | 
 17 | /**
 18 |  * The mod_hvp content user data.
 19 |  *
 20 |  * @package    mod_hvp
 21 |  * @since      Moodle 2.7
 22 |  * @copyright  2016 Joubel AS
 23 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 24 |  */
 25 | 
 26 | namespace mod_hvp;
 27 | 
 28 | defined('MOODLE_INTERNAL') || die();
 29 | 
 30 | /**
 31 |  * Class content_user_data handles user data and corresponding db operations.
 32 |  *
 33 |  * @package mod_hvp
 34 |  * @copyright   2018 Joubel AS <contact@joubel.com>
 35 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 36 |  */
 37 | class content_user_data {
 38 | 
 39 |     /**
 40 |      * Retrieves ajax parameters for content and update or delete
 41 |      * user data depending on params.
 42 |      *
 43 |      * @throws \coding_exception
 44 |      * @throws \dml_exception
 45 |      */
 46 |     public static function handle_ajax() {
 47 |         // Query String Parameters.
 48 |         $contentid = required_param('content_id', PARAM_INT);
 49 |         $dataid = required_param('data_type', PARAM_RAW);
 50 |         $subcontentid = required_param('sub_content_id', PARAM_INT);
 51 | 
 52 |         // Form Data.
 53 |         $data = optional_param('data', null, PARAM_RAW);
 54 |         $preload = optional_param('preload', null, PARAM_INT);
 55 |         $invalidate = optional_param('invalidate', null, PARAM_INT);
 56 | 
 57 |         if ($contentid === null || $dataid === null || $subcontentid === null) {
 58 |             // Missing parameters.
 59 |             \H5PCore::ajaxError(get_string('missingparameters', 'hvp'));
 60 |             return;
 61 |         }
 62 | 
 63 |         // Saving data.
 64 |         if ($data !== null && $preload !== null && $invalidate !== null) {
 65 |             self::store_data($contentid, $subcontentid, $dataid, $data, $preload, $invalidate);
 66 |         } else {
 67 |             self::fetch_existing_data($contentid, $subcontentid, $dataid);
 68 |         }
 69 |     }
 70 | 
 71 | 
 72 |     /**
 73 |      * Stores content user data
 74 |      *
 75 |      * @param $contentid
 76 |      * @param $subcontentid
 77 |      * @param $dataid
 78 |      * @param $data
 79 |      * @param $preload
 80 |      * @param $invalidate
 81 |      *
 82 |      * @throws \coding_exception
 83 |      * @throws \dml_exception
 84 |      */
 85 |     private static function store_data($contentid, $subcontentid, $dataid, $data, $preload, $invalidate) {
 86 |         // Validate token.
 87 |         if (!\H5PCore::validToken('contentuserdata', required_param('token', PARAM_RAW))) {
 88 |             \H5PCore::ajaxError(get_string('invalidtoken', 'hvp'));
 89 |             return;
 90 |         }
 91 | 
 92 |         if ($contentid === 0) {
 93 |             $context = \context::instance_by_id(required_param('contextId', PARAM_RAW));
 94 |         } else {
 95 |             // Load course module for content to get context.
 96 |             $cm = get_coursemodule_from_instance('hvp', $contentid);
 97 |             if (!$cm) {
 98 |                 \H5PCore::ajaxError('No such content');
 99 |                 http_response_code(404);
100 |                 return;
101 |             }
102 |             $context = \context_module::instance($cm->id);
103 |         }
104 | 
105 |         // Check permissions.
106 |         if (!has_capability('mod/hvp:savecontentuserdata', $context)) {
107 |             \H5PCore::ajaxError(get_string('nopermissiontosavecontentuserdata', 'hvp'));
108 |             http_response_code(403);
109 |             return;
110 |         }
111 | 
112 |         if ($data === '0') {
113 |             // Delete user data.
114 |             self::delete_user_data($contentid, $subcontentid, $dataid);
115 |         } else {
116 |             // Save user data.
117 |             self::save_user_data($contentid, $subcontentid, $dataid, $preload, $invalidate, $data);
118 |         }
119 |         \H5PCore::ajaxSuccess();
120 |     }
121 | 
122 |     /**
123 |      * Return existing content user data
124 |      *
125 |      * @param $contentid
126 |      * @param $subcontentid
127 |      * @param $dataid
128 |      *
129 |      * @throws \dml_exception
130 |      */
131 |     private static function fetch_existing_data($contentid, $subcontentid, $dataid) {
132 |         // Fetch user data.
133 |         $userdata = self::get_user_data($contentid, $subcontentid, $dataid);
134 |         \H5PCore::ajaxSuccess($userdata ? $userdata->data : null);
135 |     }
136 | 
137 |     /**
138 |      * Get user data for content.
139 |      *
140 |      * @param $contentid
141 |      * @param $subcontentid
142 |      * @param $dataid
143 |      *
144 |      * @return mixed
145 |      * @throws \dml_exception
146 |      */
147 |     public static function get_user_data($contentid, $subcontentid, $dataid) {
148 |         global $DB, $USER;
149 | 
150 |         $result = $DB->get_record('hvp_content_user_data', array(
151 |                 'user_id' => $USER->id,
152 |                 'hvp_id' => $contentid,
153 |                 'sub_content_id' => $subcontentid,
154 |                 'data_id' => $dataid
155 |             )
156 |         );
157 | 
158 |         return $result;
159 |     }
160 | 
161 |     /**
162 |      * Save user data for specific content in database.
163 |      *
164 |      * @param $contentid
165 |      * @param $subcontentid
166 |      * @param $dataid
167 |      * @param $preload
168 |      * @param $invalidate
169 |      * @param $data
170 |      *
171 |      * @throws \dml_exception
172 |      */
173 |     public static function save_user_data($contentid, $subcontentid, $dataid, $preload, $invalidate, $data) {
174 |         global $DB, $USER;
175 | 
176 |         // Determine if we should update or insert.
177 |         $update = self::get_user_data($contentid, $subcontentid, $dataid);
178 | 
179 |         // Wash values to ensure 0 or 1.
180 |         $preload = ($preload === '0' || $preload === 0) ? 0 : 1;
181 |         $invalidate = ($invalidate === '0' || $invalidate === 0) ? 0 : 1;
182 | 
183 |         // New data to be inserted.
184 |         $newdata = (object)array(
185 |             'user_id' => $USER->id,
186 |             'hvp_id' => $contentid,
187 |             'sub_content_id' => $subcontentid,
188 |             'data_id' => $dataid,
189 |             'data' => $data,
190 |             'preloaded' => $preload,
191 |             'delete_on_content_change' => $invalidate
192 |         );
193 | 
194 |         // Does not exist.
195 |         if ($update === false) {
196 |             // Insert new data.
197 |             $DB->insert_record('hvp_content_user_data', $newdata);
198 |         } else {
199 |             // Get old data id.
200 |             $newdata->id = $update->id;
201 | 
202 |             // Update old data.
203 |             $DB->update_record('hvp_content_user_data', $newdata);
204 |         }
205 |     }
206 | 
207 |     /**
208 |      * Delete user data with specific content from database
209 |      *
210 |      * @param $contentid
211 |      * @param $subcontentid
212 |      * @param $dataid
213 |      *
214 |      * @throws \dml_exception
215 |      */
216 |     public static function delete_user_data($contentid, $subcontentid, $dataid) {
217 |         global $DB, $USER;
218 | 
219 |         $DB->delete_records('hvp_content_user_data', array(
220 |             'user_id' => $USER->id,
221 |             'hvp_id' => $contentid,
222 |             'sub_content_id' => $subcontentid,
223 |             'data_id' => $dataid
224 |         ));
225 |     }
226 | 
227 |     /**
228 |      * Load user data for specific content
229 |      *
230 |      * @param $contentid
231 |      *
232 |      * @return array User data for specific content if found, else null
233 |      * @throws \dml_exception
234 |      */
235 |     public static function load_pre_loaded_user_data($contentid) {
236 |         global $DB, $USER;
237 | 
238 |         $preloadeduserdata = array(
239 |             'state' => '{}'
240 |         );
241 | 
242 |         $results = $DB->get_records('hvp_content_user_data', array(
243 |             'user_id' => $USER->id,
244 |             'hvp_id' => $contentid,
245 |             'sub_content_id' => 0,
246 |             'preloaded' => 1
247 |         ));
248 | 
249 |         // Get data for data ids.
250 |         foreach ($results as $contentuserdata) {
251 |             $preloadeduserdata[$contentuserdata->data_id] = $contentuserdata->data;
252 |         }
253 | 
254 |         return $preloadeduserdata;
255 |     }
256 | }
257 | 


--------------------------------------------------------------------------------
/backup/moodle2/backup_hvp_stepslib.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/>.
 16 | 
 17 | /**
 18 |  * Defines backup structure steps for both hvp content and hvp libraries.
 19 |  *
 20 |  * @package     mod_hvp
 21 |  * @category    backup
 22 |  * @copyright   2016 Joubel AS <contact@joubel.com>
 23 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 24 |  */
 25 | 
 26 | defined('MOODLE_INTERNAL') || die();
 27 | 
 28 | /**
 29 |  * Define the complete hvp structure for backup, with file and id annotations
 30 |  *
 31 |  * @copyright   2018 Joubel AS <contact@joubel.com>
 32 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 33 |  */
 34 | class backup_hvp_activity_structure_step extends backup_activity_structure_step {
 35 | 
 36 |     /**
 37 |      * Defines backup element's structure
 38 |      *
 39 |      * @return backup_nested_element
 40 |      * @throws base_element_struct_exception
 41 |      * @throws base_step_exception
 42 |      */
 43 |     protected function define_structure() {
 44 | 
 45 |         // To know if we are including user info.
 46 |         $userinfo = $this->get_setting_value('userinfo');
 47 | 
 48 |         // Define each element separated.
 49 |         $hvp = new backup_nested_element('hvp', array('id'), array(
 50 |             'name',
 51 |             'machine_name',
 52 |             'major_version',
 53 |             'minor_version',
 54 |             'intro',
 55 |             'introformat',
 56 |             'json_content',
 57 |             'embed_type',
 58 |             'disable',
 59 |             'content_type',
 60 |             'source',
 61 |             'year_from',
 62 |             'year_to',
 63 |             'license_version',
 64 |             'changes',
 65 |             'license_extras',
 66 |             'author_comments',
 67 |             'slug',
 68 |             'timecreated',
 69 |             'timemodified',
 70 |             'authors',
 71 |             'license',
 72 |             'completionpass'
 73 |         ));
 74 | 
 75 |         // User data.
 76 |         $entries = new backup_nested_element('content_user_data');
 77 |         $contentuserdata = new backup_nested_element('entry', array(
 78 |             'user_id', // Annotated.
 79 |             'sub_content_id'
 80 |             ), array(
 81 |             'data_id',
 82 |             'data',
 83 |             'preloaded',
 84 |             'delete_on_content_change',
 85 |         ));
 86 | 
 87 |         // Build the tree.
 88 | 
 89 |         $hvp->add_child($entries);
 90 |         $entries->add_child($contentuserdata);
 91 | 
 92 |         // Define sources.
 93 | 
 94 |         // Uses library name and version instead of main_library_id.
 95 |         $hvp->set_source_sql('
 96 |           SELECT h.id,
 97 |                  hl.machine_name,
 98 |                  hl.major_version,
 99 |                  hl.minor_version,
100 |                  h.name,
101 |                  h.intro,
102 |                  h.introformat,
103 |                  h.json_content,
104 |                  h.embed_type,
105 |                  h.disable,
106 |                  h.content_type,
107 |                  h.slug,
108 |                  h.timecreated,
109 |                  h.timemodified,
110 |                  h.authors,
111 |                  h.source,
112 |                  h.year_from,
113 |                  h.year_to,
114 |                  h.license_version,
115 |                  h.changes,
116 |                  h.license_extras,
117 |                  h.author_comments,
118 |                  h.license,
119 |                  h.completionpass
120 |           FROM {hvp} h
121 |               JOIN {hvp_libraries} hl ON hl.id = h.main_library_id
122 |               WHERE h.id = ?', array(backup::VAR_ACTIVITYID));
123 | 
124 |         // All the rest of elements only happen if we are including user info.
125 |         if ($userinfo) {
126 |             $contentuserdata->set_source_table('hvp_content_user_data', array('hvp_id' => backup::VAR_PARENTID));
127 |         }
128 | 
129 |         // Define id annotations.
130 |         $contentuserdata->annotate_ids('user', 'user_id');
131 |         // In an ideal world we would use the main_library_id and annotate that
132 |         // but since we cannot know the required dependencies of the content
133 |         // without parsing json_content and crawling the libraries_libraries
134 |         // (library dependencies) table it's much easier to just include all
135 |         // installed libraries.
136 | 
137 |         // Define file annotations.
138 |         $hvp->annotate_files('mod_hvp', 'intro', null, null);
139 |         $hvp->annotate_files('mod_hvp', 'content', null, null);
140 | 
141 |         // Return the root element (hvp), wrapped into standard activity structure.
142 |         return $this->prepare_activity_structure($hvp);
143 |     }
144 | }
145 | 
146 | /**
147 |  * Backup h5p libraries.
148 |  *
149 |  * Structure step in charge of constructing the hvp_libraries.xml file for
150 |  * all the H5P libraries.
151 |  *
152 |  * @copyright   2018 Joubel AS <contact@joubel.com>
153 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
154 |  */
155 | class backup_hvp_libraries_structure_step extends backup_structure_step {
156 | 
157 |     /**
158 |      * Determines if backup step should be executed
159 |      *
160 |      * @return bool
161 |      * @throws backup_step_exception
162 |      */
163 |     protected function execute_condition() {
164 |         $fullpath = $this->task->get_taskbasepath();
165 |         if (empty($fullpath)) {
166 |             throw new backup_step_exception('backup_structure_step_undefined_fullpath');
167 |         }
168 | 
169 |         // Modify filename to use a globally shared file for all libraries.
170 |         $this->filename = "../{$this->filename}";
171 | 
172 |         // Append the filename to the full path.
173 |         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
174 | 
175 |         // Determine if already generated.
176 |         return !file_exists($fullpath);
177 |     }
178 | 
179 |     /**
180 |      * Defines the structure to be executed by this backup step
181 |      *
182 |      * @return backup_nested_element
183 |      * @throws base_element_struct_exception
184 |      * @throws dml_exception
185 |      */
186 |     protected function define_structure() {
187 |         // Libraries.
188 |         $libraries = new backup_nested_element('hvp_libraries');
189 |         $library = new backup_nested_element('library', array('id'), array(
190 |             'title',
191 |             'machine_name',
192 |             'major_version',
193 |             'minor_version',
194 |             'patch_version',
195 |             'runnable',
196 |             'fullscreen',
197 |             'embed_types',
198 |             'preloaded_js',
199 |             'preloaded_css',
200 |             'drop_library_css',
201 |             'semantics',
202 |             'restricted',
203 |             'tutorial_url',
204 |             'add_to',
205 |             'metadata'
206 |         ));
207 | 
208 |         // Library translations.
209 |         $translations = new backup_nested_element('translations');
210 |         $translation = new backup_nested_element('translation', array(
211 |             'language_code'
212 |         ), array(
213 |             'language_json'
214 |         ));
215 | 
216 |         // Library dependencies.
217 |         $dependencies = new backup_nested_element('dependencies');
218 |         $dependency = new backup_nested_element('dependency', array(
219 |             'required_library_id'
220 |         ), array(
221 |             'dependency_type'
222 |         ));
223 | 
224 |         // Build the tree.
225 |         $libraries->add_child($library);
226 | 
227 |         $library->add_child($translations);
228 |         $translations->add_child($translation);
229 | 
230 |         $library->add_child($dependencies);
231 |         $dependencies->add_child($dependency);
232 | 
233 |         // Define sources.
234 | 
235 |         $library->set_source_table('hvp_libraries', array());
236 | 
237 |         $translation->set_source_table('hvp_libraries_languages', array('library_id' => backup::VAR_PARENTID));
238 | 
239 |         $dependency->set_source_table('hvp_libraries_libraries', array('library_id' => backup::VAR_PARENTID));
240 | 
241 |         // Define file annotations.
242 |         $context = \context_system::instance();
243 |         $library->annotate_files('mod_hvp', 'libraries', null, $context->id);
244 | 
245 |         // Return root element.
246 |         return $libraries;
247 |     }
248 | }
249 | 


--------------------------------------------------------------------------------
/ajax.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/>.
 16 | /**
 17 |  * Responsible for handling AJAX requests related to H5P.
 18 |  *
 19 |  * @package    mod_hvp
 20 |  * @copyright  2016 Joubel AS <contact@joubel.com>
 21 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 22 |  */
 23 | 
 24 | define('AJAX_SCRIPT', true);
 25 | require(__DIR__ . '/../../config.php');
 26 | require_once($CFG->libdir . '/filelib.php');
 27 | require_once("locallib.php");
 28 | 
 29 | require_login();
 30 | 
 31 | $action = required_param('action', PARAM_ALPHA);
 32 | switch($action) {
 33 | 
 34 |     /*
 35 |      * Handle user data reporting
 36 |      *
 37 |      * Type: HTTP POST
 38 |      *
 39 |      * Parameters:
 40 |      *  - content_id
 41 |      *  - data_type
 42 |      *  - sub_content_id
 43 |      */
 44 |     case 'contentsuserdata':
 45 |         \mod_hvp\content_user_data::handle_ajax();
 46 |         break;
 47 | 
 48 |     /*
 49 |      * Handle restricting H5P libraries
 50 |      *
 51 |      * Type: HTTP GET
 52 |      *
 53 |      * Parameters:
 54 |      *  - library_id
 55 |      *  - restrict (0 or 1)
 56 |      *  - token
 57 |      */
 58 |     case 'restrictlibrary':
 59 | 
 60 |         // Check permissions.
 61 |         $context = \context_system::instance();
 62 |         if (!has_capability('mod/hvp:restrictlibraries', $context)) {
 63 |             \H5PCore::ajaxError(get_string('nopermissiontorestrict', 'hvp'));
 64 |             http_response_code(403);
 65 |             break;
 66 |         }
 67 | 
 68 |         $libraryid = required_param('library_id', PARAM_INT);
 69 |         $restrict = required_param('restrict', PARAM_INT);
 70 | 
 71 |         if (!\H5PCore::validToken('library_' . $libraryid, required_param('token', PARAM_RAW))) {
 72 |             \H5PCore::ajaxError(get_string('invalidtoken', 'hvp'));
 73 |             exit;
 74 |         }
 75 | 
 76 |         hvp_restrict_library($libraryid, $restrict);
 77 |         header('Cache-Control: no-cache');
 78 |         header('Content-Type: application/json');
 79 |         echo json_encode(array(
 80 |             'url' => (new moodle_url('/mod/hvp/ajax.php', array(
 81 |                 'action' => 'restrict_library',
 82 |                 'token' => \H5PCore::createToken('library_' . $libraryid),
 83 |                 'restrict' => ($restrict === '1' ? 0 : 1),
 84 |                 'library_id' => $libraryid
 85 |             )))->out(false)));
 86 |         break;
 87 | 
 88 |     /*
 89 |      * Collecting data needed by H5P content upgrade
 90 |      *
 91 |      * Type: HTTP GET
 92 |      *
 93 |      * Parameters:
 94 |      *  - library (Format: /<machine-name>/<major-version>/<minor-version>)
 95 |      */
 96 |     case 'getlibrarydataforupgrade':
 97 | 
 98 |         // Check permissions.
 99 |         $context = \context_system::instance();
100 |         if (!has_capability('mod/hvp:updatelibraries', $context)) {
101 |             \H5PCore::ajaxError(get_string('nopermissiontoupgrade', 'hvp'));
102 |             http_response_code(403);
103 |             break;
104 |         }
105 | 
106 |         $library = required_param('library', PARAM_TEXT);
107 |         $library = explode('/', substr($library, 1));
108 | 
109 |         if (count($library) !== 3) {
110 |             http_response_code(422);
111 |             return;
112 |         }
113 | 
114 |         $library = hvp_get_library_upgrade_info($library[0], $library[1], $library[2]);
115 | 
116 |         header('Cache-Control: no-cache');
117 |         header('Content-Type: application/json');
118 |         print json_encode($library);
119 | 
120 |         break;
121 | 
122 |     /*
123 |      * Saving upgraded content, and returning next batch to process
124 |      *
125 |      * Type: HTTP POST
126 |      *
127 |      * Parameters:
128 |      *  - library_id
129 |      */
130 |     case 'libraryupgradeprogress':
131 |         // Check upgrade permissions.
132 |         $context = \context_system::instance();
133 |         if (!has_capability('mod/hvp:updatelibraries', $context)) {
134 |             \H5PCore::ajaxError(get_string('nopermissiontoupgrade', 'hvp'));
135 |             http_response_code(403);
136 |             break;
137 |         }
138 | 
139 |         // Because of a confirmed bug in PHP, filter_input(INPUT_SERVER, ...)
140 |         // will return null on some versions of FCGI/PHP (5.4 and probably
141 |         // older versions as well), ref. https://bugs.php.net/bug.php?id=49184.
142 |         if ($_SERVER['REQUEST_METHOD'] === 'POST') {
143 |             $libraryid = required_param('library_id', PARAM_INT);
144 |             $out = hvp_content_upgrade_progress($libraryid);
145 |             header('Cache-Control: no-cache');
146 |             header('Content-Type: application/json');
147 |             print json_encode($out);
148 |         } else {
149 |             // Only allow POST.
150 |             http_response_code(405);
151 |         }
152 |         break;
153 | 
154 |     /*
155 |      * Handle set finished / storing grades
156 |      *
157 |      * Type: HTTP GET
158 |      *
159 |      * Parameters:
160 |      *  - contentId
161 |      *  - score
162 |      *  - maxScore
163 |      */
164 |     case 'setfinished':
165 |         \mod_hvp\user_grades::handle_ajax();
166 |         break;
167 | 
168 |     /*
169 |      * Saves a dynamically graded grade to the gradebook
170 |      *
171 |      * Type: HTTP POST
172 |      *
173 |      * Parameters:
174 |      *  - subcontent_id
175 |      *  - score
176 |      */
177 |     case 'updatesubcontentscore':
178 |         \mod_hvp\user_grades::handle_dynamic_grading();
179 |         break;
180 | 
181 |     /*
182 |      * Returns a grade
183 |      *
184 |      * Type: HTTP GET
185 |      *
186 |      * Parameters:
187 |      *  - subcontent_id
188 |      */
189 |     case 'getsubcontentscore':
190 |         \mod_hvp\user_grades::return_subcontent_grade();
191 |         break;
192 | 
193 |     /*
194 |      * Provide data for results view
195 |      *
196 |      * Type: HTTP GET
197 |      *
198 |      * Parameters:
199 |      *  int content_id
200 |      *  int offset
201 |      *  int limit
202 |      *  int sortBy
203 |      *  int sortDir
204 |      *  string[] filters
205 |      */
206 |     case 'results':
207 |         $results = new \mod_hvp\results();
208 |         $results->print_results();
209 |         break;
210 | 
211 |     /*
212 |      * Load list of libraries or details for library.
213 |      *
214 |      * Parameters:
215 |      *  string machineName
216 |      *  int majorVersion
217 |      *  int minorVersion
218 |      */
219 |     case 'libraries':
220 |         if (!\mod_hvp\framework::has_editor_access('nopermissiontoviewcontenttypes')) {
221 |             break;
222 |         }
223 | 
224 |         // Get parameters.
225 |         $name = optional_param('machineName', '', PARAM_TEXT);
226 |         $major = optional_param('majorVersion', 0, PARAM_INT);
227 |         $minor = optional_param('minorVersion', 0, PARAM_INT);
228 |         $editor = \mod_hvp\framework::instance('editor');
229 |         $language = optional_param('default-language', null, PARAM_RAW);
230 | 
231 |         if (!empty($name)) {
232 |             $editor->ajax->action(H5PEditorEndpoints::SINGLE_LIBRARY, $name,
233 |                 $major, $minor, \mod_hvp\framework::get_language(), '', '', $language);
234 | 
235 |             new \mod_hvp\event(
236 |                     'library', null,
237 |                     null, null,
238 |                     $name, $major . '.' . $minor
239 |             );
240 |         } else {
241 |             $editor->ajax->action(H5PEditorEndpoints::LIBRARIES);
242 |         }
243 | 
244 |         break;
245 | 
246 |     /*
247 |      * Load content type cache list to display available libraries in hub
248 |      */
249 |     case 'contenttypecache':
250 |         if (!\mod_hvp\framework::has_editor_access('nopermissiontoviewcontenttypes')) {
251 |             break;
252 |         }
253 | 
254 |         $editor = \mod_hvp\framework::instance('editor');
255 |         $editor->ajax->action(H5PEditorEndpoints::CONTENT_TYPE_CACHE);
256 |         break;
257 | 
258 |     /*
259 |      * Handle file upload through the editor.
260 |      *
261 |      * Parameters:
262 |      *  int contentId
263 |      *  int contextId
264 |      */
265 |     case 'files':
266 |         $token = required_param('token', PARAM_RAW);
267 |         $contentid = required_param('contentId', PARAM_INT);
268 |         if (!\mod_hvp\framework::has_editor_access('nopermissiontouploadfiles')) {
269 |             break;
270 |         }
271 | 
272 |         $editor = \mod_hvp\framework::instance('editor');
273 |         $editor->ajax->action(H5PEditorEndpoints::FILES, $token, $contentid);
274 |         break;
275 | 
276 |     /*
277 |      * Handle file upload through the editor.
278 |      *
279 |      * Parameters:
280 |      *  raw token
281 |      *  raw contentTypeUrl
282 |      */
283 |     case 'libraryinstall':
284 |         $token = required_param('token', PARAM_RAW);
285 |         $machinename = required_param('id', PARAM_TEXT);
286 |         $editor = \mod_hvp\framework::instance('editor');
287 |         $editor->ajax->action(H5PEditorEndpoints::LIBRARY_INSTALL, $token, $machinename);
288 |         break;
289 | 
290 |     /*
291 |      * Install libraries from h5p and retrieve content json
292 |      *
293 |      * Parameters:
294 |      *  file h5p
295 |      */
296 |     case 'libraryupload':
297 |         $token = required_param('token', PARAM_RAW);
298 |         if (!\mod_hvp\framework::has_editor_access('nopermissiontouploadcontent')) {
299 |             break;
300 |         }
301 | 
302 |         $editor = \mod_hvp\framework::instance('editor');
303 |         $uploadpath = $_FILES['h5p']['tmp_name'];
304 |         $contentid = optional_param('contentId', 0, PARAM_INT);
305 |         $editor->ajax->action(H5PEditorEndpoints::LIBRARY_UPLOAD, $token, $uploadpath, $contentid);
306 |         break;
307 | 
308 |     /*
309 |      * Record xAPI result from view
310 |      */
311 |     case 'xapiresult':
312 |         \mod_hvp\xapi_result::handle_ajax();
313 |         break;
314 | 
315 |     case 'translations':
316 |         if (!\mod_hvp\framework::has_editor_access('nopermissiontogettranslations')) {
317 |             break;
318 |         }
319 |         $language = required_param('language', PARAM_RAW);
320 |         $editor = \mod_hvp\framework::instance('editor');
321 |         $editor->ajax->action(H5PEditorEndpoints::TRANSLATIONS, $language);
322 |         break;
323 | 
324 |     /*
325 |      * Handle filtering of parameters through AJAX.
326 |      */
327 |     case 'filter':
328 |         $token = required_param('token', PARAM_RAW);
329 |         $libraryparameters = required_param('libraryParameters', PARAM_RAW);
330 | 
331 |         if (!\mod_hvp\framework::has_editor_access('nopermissiontouploadfiles')) {
332 |             break;
333 |         }
334 | 
335 |         $editor = \mod_hvp\framework::instance('editor');
336 |         $editor->ajax->action(H5PEditorEndpoints::FILTER, $token, $libraryparameters);
337 |         break;
338 | 
339 |     /*
340 |      * Throw error if AJAX isnt handeled
341 |      */
342 |     default:
343 |         throw new coding_exception('Unhandled AJAX');
344 |         break;
345 | }
346 | 


--------------------------------------------------------------------------------
/classes/view_assets.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/>.
 16 | 
 17 | /**
 18 |  * The mod_hvp view assets convenience class for viewing and embedding H5Ps
 19 |  *
 20 |  * @package    mod_hvp
 21 |  * @copyright  2017 Joubel
 22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 23 |  */
 24 | 
 25 | namespace mod_hvp;
 26 | 
 27 | use moodle_url;
 28 | 
 29 | defined('MOODLE_INTERNAL') || die();
 30 | 
 31 | /**
 32 |  * Handles finding and attaching assets for view
 33 |  * @package mod_hvp
 34 |  */
 35 | class view_assets {
 36 | 
 37 |     private $cm;
 38 |     private $course;
 39 |     private $core;
 40 |     private $content;
 41 |     private $jsrequires;
 42 |     private $cssrequires;
 43 | 
 44 |     protected $settings;
 45 |     protected $embedtype;
 46 |     protected $files;
 47 | 
 48 |     public function __construct($cm, $course, $options = []) {
 49 |         $this->cm          = $cm;
 50 |         $this->course      = $course;
 51 |         $this->core        = framework::instance();
 52 |         $this->content     = $this->core->loadContent($cm->instance);
 53 |         $this->settings    = hvp_get_core_assets(\context_module::instance($cm->id));
 54 |         $this->jsrequires  = [];
 55 |         $this->cssrequires = [];
 56 | 
 57 |         $context        = \context_module::instance($this->cm->id);
 58 |         $displayoptions = $this->core->getDisplayOptionsForView($this->content['disable'], $context->instanceid);
 59 |         if (isset($options['disabledownload']) && $options['disabledownload']) {
 60 |             $displayoptions[\H5PCore::DISPLAY_OPTION_DOWNLOAD] = false;
 61 |         }
 62 |         if (isset($options['disablefullscreen']) && $options['disablefullscreen']) {
 63 |             $this->settings['fullscreenDisabled'] = true;
 64 |         }
 65 | 
 66 |         // Add JavaScript settings for this content.
 67 |         $cid                                  = 'cid-' . $this->content['id'];
 68 |         $root = self::getsiteroot();
 69 |         $this->settings['contents'][ $cid ]   = array(
 70 |             'library'         => \H5PCore::libraryToString($this->content['library']),
 71 |             'jsonContent'     => $this->getfilteredparameters(),
 72 |             'fullScreen'      => $this->content['library']['fullscreen'],
 73 |             'exportUrl'       => $this->getexportsettings($displayoptions[ \H5PCore::DISPLAY_OPTION_DOWNLOAD ]),
 74 |             'embedCode'       => $this->getembedcode($displayoptions[ \H5PCore::DISPLAY_OPTION_EMBED ]),
 75 |             'resizeCode'      => $this->getresizecode($displayoptions[ \H5PCore::DISPLAY_OPTION_EMBED ]),
 76 |             'title'           => $this->content['title'],
 77 |             'displayOptions'  => $displayoptions,
 78 |             'url'             => "{$root}/mod/hvp/view.php?id={$this->cm->id}",
 79 |             'contentUrl'      => "{$root}/pluginfile.php/{$context->id}/mod_hvp/content/{$this->content['id']}",
 80 |             'metadata'        => $this->content['metadata'],
 81 |             'contentUserData' => array(
 82 |                 0 => content_user_data::load_pre_loaded_user_data($this->content['id'])
 83 |             )
 84 |         );
 85 | 
 86 |         $this->embedtype = isset($options->forceembedtype) ? $options->forceembedtype : \H5PCore::determineEmbedType(
 87 |             $this->content['embedType'], $this->content['library']['embedTypes']
 88 |         );
 89 | 
 90 |         $this->files = $this->getdependencyfiles();
 91 |         $this->generateassets();
 92 |     }
 93 | 
 94 |     /**
 95 |      * Filtered and potentially altered parameters
 96 |      *
 97 |      * @return Object|string
 98 |      */
 99 |     private function getfilteredparameters() {
100 |         global $PAGE;
101 | 
102 |         $safeparameters = $this->core->filterParameters($this->content);
103 |         $decodedparams  = json_decode($safeparameters);
104 |         $hvpoutput      = $PAGE->get_renderer('mod_hvp');
105 |         $hvpoutput->hvp_alter_filtered_parameters(
106 |             $decodedparams,
107 |             $this->content['library']['name'],
108 |             $this->content['library']['majorVersion'],
109 |             $this->content['library']['minorVersion']
110 |         );
111 |         $safeparameters = json_encode($decodedparams);
112 | 
113 |         return $safeparameters;
114 |     }
115 | 
116 |     /**
117 |      * Export path for settings
118 |      *
119 |      * @param $downloadenabled
120 |      *
121 |      * @return string
122 |      */
123 |     private function getexportsettings($downloadenabled) {
124 |         global $CFG;
125 | 
126 |         if ( ! $downloadenabled || (isset($CFG->mod_hvp_export) && $CFG->mod_hvp_export === false)) {
127 |             return '';
128 |         }
129 | 
130 |         $modulecontext = \context_module::instance($this->cm->id);
131 |         $slug          = $this->content['slug'] ? $this->content['slug'] . '-' : '';
132 |         $url           = \moodle_url::make_pluginfile_url($modulecontext->id,
133 |             'mod_hvp',
134 |             'exports',
135 |             '',
136 |             '',
137 |             "{$slug}{$this->content['id']}.h5p"
138 |         );
139 | 
140 |         return $url->out();
141 |     }
142 | 
143 |     /**
144 |      * Embed code for settings
145 |      *
146 |      * @param $embedenabled
147 |      *
148 |      * @return string
149 |      */
150 |     private function getembedcode($embedenabled) {
151 |         if ( ! $embedenabled) {
152 |             return '';
153 |         }
154 | 
155 |         $root = self::getsiteroot();
156 |         $embedurl = new \moodle_url("{$root}/mod/hvp/embed.php?id={$this->cm->id}");
157 | 
158 |         return "<iframe src=\"{$embedurl->out()}\" width=\":w\" height=\":h\" frameborder=\"0\" " .
159 |                "allowfullscreen=\"allowfullscreen\"></iframe>";
160 |     }
161 | 
162 |     /**
163 |      * Resizing script for settings
164 |      *
165 |      * @param $embedenabled
166 |      *
167 |      * @return string
168 |      */
169 |     private function getresizecode($embedenabled) {
170 |         if ( ! $embedenabled) {
171 |             return '';
172 |         }
173 | 
174 |         $resizeurl = new \moodle_url(self::getsiteroot() . '/mod/hvp/library/js/h5p-resizer.js');
175 | 
176 |         return "<script src=\"{$resizeurl->out()}\" charset=\"UTF-8\"></script>";
177 |     }
178 | 
179 |     /**
180 |      * Finds library dependencies of view
181 |      *
182 |      * @return array Files that the view has dependencies to
183 |      */
184 |     private function getdependencyfiles() {
185 |         global $PAGE;
186 | 
187 |         $preloadeddeps = $this->core->loadContentDependencies($this->content['id'], 'preloaded');
188 |         $files         = $this->core->getDependenciesFiles($preloadeddeps);
189 | 
190 |         // Add additional asset files if required.
191 |         $hvpoutput = $PAGE->get_renderer('mod_hvp');
192 |         $hvpoutput->hvp_alter_scripts($files['scripts'], $preloadeddeps, $this->embedtype);
193 |         $hvpoutput->hvp_alter_styles($files['styles'], $preloadeddeps, $this->embedtype);
194 | 
195 |         return $files;
196 |     }
197 | 
198 |     /**
199 |      * Generates assets depending on embed type
200 |      */
201 |     private function generateassets() {
202 |         if ($this->embedtype === 'div') {
203 |             $context = \context_system::instance();
204 |             $hvppath = "/pluginfile.php/{$context->id}/mod_hvp";
205 | 
206 |             // Schedule JavaScripts for loading through Moodle.
207 |             foreach ($this->files['scripts'] as $script) {
208 |                 $url = $script->path . $script->version;
209 | 
210 |                 // Add URL prefix if not external.
211 |                 $isexternal = strpos($script->path, '://');
212 |                 if ($isexternal === false) {
213 |                     $url = $hvppath . $url;
214 |                 }
215 |                 $this->settings['loadedJs'][] = $url;
216 |                 $this->jsrequires[]           = new \moodle_url($isexternal ? $url : self::getsiteroot() . $url);
217 |             }
218 | 
219 |             // Schedule stylesheets for loading through Moodle.
220 |             foreach ($this->files['styles'] as $style) {
221 |                 $url = $style->path . $style->version;
222 | 
223 |                 // Add URL prefix if not external.
224 |                 $isexternal = strpos($style->path, '://');
225 |                 if ($isexternal === false) {
226 |                     $url = $hvppath . $url;
227 |                 }
228 |                 $this->settings['loadedCss'][] = $url;
229 |                 $this->cssrequires[]           = new \moodle_url($isexternal ? $url : self::getsiteroot() . $url);
230 |             }
231 |         } else {
232 |             // JavaScripts and stylesheets will be loaded through h5p.js.
233 |             $cid                                           = 'cid-' . $this->content['id'];
234 |             $this->settings['contents'][ $cid ]['scripts'] = $this->core->getAssetsUrls($this->files['scripts']);
235 |             $this->settings['contents'][ $cid ]['styles']  = $this->core->getAssetsUrls($this->files['styles']);
236 |         }
237 |     }
238 | 
239 |     public function getcontent() {
240 |         return $this->content;
241 |     }
242 | 
243 |     /**
244 |      * Logs viewed to all handlers
245 |      */
246 |     public function logviewed() {
247 |         $this->logh5pviewedevent();
248 |         $this->logcompletioncriteriaviewed();
249 |         $this->triggermoduleviewedevent();
250 |     }
251 | 
252 |     /**
253 |      * Logs content viewed to H5P core
254 |      */
255 |     public function logh5pviewedevent() {
256 |         new event(
257 |             'content', null,
258 |             $this->content['id'], $this->content['title'],
259 |             $this->content['library']['name'],
260 |             $this->content['library']['majorVersion'] . '.' . $this->content['library']['minorVersion']
261 |         );
262 |     }
263 | 
264 |     /**
265 |      * Logs activity viewed to completion criterias
266 |      */
267 |     public function logcompletioncriteriaviewed() {
268 |         $completion = new \completion_info($this->course);
269 |         $completion->set_module_viewed($this->cm);
270 |     }
271 | 
272 |     /**
273 |      * Allows observers to act on viewed event
274 |      */
275 |     public function triggermoduleviewedevent() {
276 |         $event = event\course_module_viewed::create(array(
277 |             'objectid' => $this->cm->instance,
278 |             'context'  => \context_module::instance($this->cm->id)
279 |         ));
280 |         $event->add_record_snapshot('course_modules', $this->cm);
281 |         $event->trigger();
282 |     }
283 | 
284 | 
285 |     /**
286 |      * Adds js assets to current page
287 |      */
288 |     public function addassetstopage() {
289 |         global $PAGE;
290 | 
291 |         foreach ($this->jsrequires as $script) {
292 |             $PAGE->requires->js($script, true);
293 |         }
294 | 
295 |         foreach ($this->cssrequires as $css) {
296 |             $PAGE->requires->css($css);
297 |         }
298 | 
299 |         // Print JavaScript settings to page.
300 |         $PAGE->requires->data_for_js('H5PIntegration', $this->settings, true);
301 | 
302 |         // Add xAPI collector script.
303 |         $PAGE->requires->js(new \moodle_url(self::getsiteroot() . '/mod/hvp/xapi-collector.js'), true);
304 |     }
305 | 
306 |     /**
307 |      * Outputs h5p view
308 |      */
309 |     public function outputview() {
310 |         if ($this->embedtype === 'div') {
311 |             echo "<div class=\"h5p-content\" data-content-id=\"{$this->content['id']}\"></div>";
312 |         } else {
313 |             echo "<div class=\"h5p-iframe-wrapper\">" .
314 |                  "<iframe id=\"h5p-iframe-{$this->content['id']}\"" .
315 |                  " class=\"h5p-iframe\"" .
316 |                  " data-content-id=\"{$this->content['id']}\"" .
317 |                  " style=\"height:1px\"" .
318 |                  " src=\"about:blank\"" .
319 |                  " frameBorder=\"0\"" .
320 |                  " scrolling=\"no\">" .
321 |                  "</iframe>" .
322 |                  "</div>";
323 |         }
324 |     }
325 | 
326 |     /**
327 |      * Checks if content is valid, prints an error if not
328 |      */
329 |     public function validatecontent() {
330 |         if ($this->content === null) {
331 |             print_error('invalidhvp');
332 |         }
333 |     }
334 | 
335 |     /**
336 |      * Gets the site root absolute address
337 |      *
338 |      * @return string Root address for the site
339 |      */
340 |     public static function getsiteroot() {
341 |         global $CFG;
342 |         // In Moodle 3.4 version wwwroot is always the same as httpswwwroot.
343 |         if ($CFG->version < 2017111300) {
344 |             return $CFG->httpswwwroot;
345 |         }
346 | 
347 |         return $CFG->wwwroot;
348 |     }
349 | }
350 | 


--------------------------------------------------------------------------------
/backup/moodle2/restore_hvp_stepslib.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/>.
 16 | 
 17 | /**
 18 |  * Restore structure step for both hvp content and hvp libraries
 19 |  *
 20 |  * @package     mod_hvp
 21 |  * @category    backup
 22 |  * @copyright   2016 Joubel AS <contact@joubel.com>
 23 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 24 |  */
 25 | 
 26 | defined('MOODLE_INTERNAL') || die();
 27 | 
 28 | /**
 29 |  * Structure step to restore one H5P activity
 30 |  *
 31 |  * @copyright   2018 Joubel AS <contact@joubel.com>
 32 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 33 |  */
 34 | class restore_hvp_activity_structure_step extends restore_activity_structure_step {
 35 | 
 36 |     /**
 37 |      * Defines restore element's structure
 38 |      *
 39 |      * @return array
 40 |      * @throws base_step_exception
 41 |      */
 42 |     protected function define_structure() {
 43 |         $paths = array();
 44 |         $userinfo = $this->get_setting_value('userinfo');
 45 | 
 46 |         // Restore activities.
 47 |         $paths[] = new restore_path_element('hvp', '/activity/hvp');
 48 | 
 49 |         if ($userinfo) {
 50 |             // Restore content state.
 51 |             $paths[] = new restore_path_element('content_user_data', '/activity/hvp/content_user_data/entry');
 52 |         }
 53 | 
 54 |         // Return the paths wrapped into standard activity structure.
 55 |         return $this->prepare_activity_structure($paths);
 56 |     }
 57 | 
 58 |     /**
 59 |      * Process H5P, inserting the record into the database.
 60 |      *
 61 |      * @param $data
 62 |      *
 63 |      * @throws base_step_exception
 64 |      * @throws dml_exception
 65 |      */
 66 |     protected function process_hvp($data) {
 67 |         global $DB;
 68 | 
 69 |         $data = (object) $data;
 70 |         $data->course = $this->get_courseid();
 71 |         $data->main_library_id = \restore_hvp_libraries_structure_step::get_library_id($data);
 72 | 
 73 |         $data->timecreated = $this->apply_date_offset($data->timecreated);
 74 |         $data->timemodified = $this->apply_date_offset($data->timemodified);
 75 | 
 76 |         // Insert the hvp record.
 77 |         $newitemid = $DB->insert_record('hvp', $data);
 78 |         // Immediately after inserting "activity" record, call this.
 79 |         $this->apply_activity_instance($newitemid);
 80 |     }
 81 | 
 82 |     /**
 83 |      * Process and inserts content user data.
 84 |      *
 85 |      * @param $data
 86 |      *
 87 |      * @throws dml_exception
 88 |      */
 89 |     protected function process_content_user_data($data) {
 90 |         global $DB;
 91 | 
 92 |         $data = (object) $data;
 93 |         $data->user_id = $this->get_mappingid('user', $data->user_id);
 94 |         $data->hvp_id = $this->get_new_parentid('hvp');
 95 | 
 96 |         $DB->insert_record('hvp_content_user_data', $data);
 97 |     }
 98 | 
 99 |     /**
100 |      * Additional work that needs to be done after steps executions.
101 |      */
102 |     protected function after_execute() {
103 |         // Add files for intro field.
104 |         $this->add_related_files('mod_hvp', 'intro', null);
105 | 
106 |         // Add hvp related files.
107 |         $this->add_related_files('mod_hvp', 'content', 'hvp');
108 |     }
109 | }
110 | 
111 | /**
112 |  * Structure step to restore H5P libraries
113 |  *
114 |  * @copyright   2018 Joubel AS <contact@joubel.com>
115 |  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
116 |  */
117 | class restore_hvp_libraries_structure_step extends restore_activity_structure_step {
118 | 
119 |     /**
120 |      * Determines if library should be restored.
121 |      *
122 |      * @return bool
123 |      * @throws backup_step_exception
124 |      */
125 |     protected function execute_condition() {
126 |         static $librariesrestored;
127 | 
128 |         // Prevent this step from running more than once
129 |         // since all hvp_libraries.xml files are the same.
130 |         if (!empty($librariesrestored)) {
131 |             return false;
132 |         }
133 |         $librariesrestored = true;
134 | 
135 |         // Get full path to activity backup location.
136 |         $fullpath = $this->task->get_taskbasepath();
137 |         if (empty($fullpath)) {
138 |             throw new backup_step_exception('backup_structure_step_undefined_fullpath');
139 |         }
140 |         $fullpath = rtrim($fullpath, '/');
141 | 
142 |         // Check for the activity's local hvp_libraries.xml file.
143 |         if (file_exists("{$fullpath}/{$this->filename}")) {
144 |             // Use that.
145 |             return true;
146 |         }
147 | 
148 |         // Look for a global hvp_libraries.xml file.
149 |         if (file_exists("{$fullpath}/../{$this->filename}")) {
150 |             // Use it.
151 |             $this->filename = "../{$this->filename}";
152 |             return true;
153 |         }
154 | 
155 |         // Not able to find a hvp_libraries.xml, skip restore and let the admin
156 |         // be responsible for providing the approperiate libraries.
157 |         // (Could also be using Import which doesn't need libraries).
158 |         return false;
159 |     }
160 | 
161 |     /**
162 |      * Defines how library should be restored.
163 |      *
164 |      * @return array
165 |      */
166 |     protected function define_structure() {
167 |         $paths = array();
168 | 
169 |         // Restore libraries first.
170 |         $paths[] = new restore_path_element('hvp_library', '/hvp_libraries/library');
171 | 
172 |         // Add translations.
173 |         $paths[] = new restore_path_element('hvp_library_translation', '/hvp_libraries/library/translations/translation');
174 | 
175 |         // ... and dependencies.
176 |         $paths[] = new restore_path_element('hvp_library_dependency', '/hvp_libraries/library/dependencies/dependency');
177 | 
178 |         // Return the paths wrapped into standard activity structure.
179 |         return $this->prepare_activity_structure($paths);
180 |     }
181 | 
182 |     /**
183 |      * Process and insert library record.
184 |      *
185 |      * @param $data
186 |      *
187 |      * @throws dml_exception
188 |      * @throws restore_step_exception
189 |      */
190 |     protected function process_hvp_library($data) {
191 |         global $DB;
192 | 
193 |         $data = (object)$data;
194 |         $oldid = $data->id;
195 |         unset($data->id);
196 | 
197 |         $libraryid = self::get_library_id($data);
198 |         if (!$libraryid) {
199 |             // There is no updating of libraries. If an older patch version exists
200 |             // on the site that one will be used instead of the new one in the backup.
201 |             // This is due to the default behavior when files are restored in Moodle.
202 | 
203 |             // Restore library.
204 |             $libraryid = $DB->insert_record('hvp_libraries', $data);
205 | 
206 |             // Update libraries cache.
207 |             self::get_library_id($data, $libraryid);
208 |         }
209 | 
210 |         // Keep track of libraries for translations and dependencies.
211 |         $this->set_mapping('hvp_library', $oldid, $libraryid);
212 | 
213 |         // Update any dependencies that require this library.
214 |         $this->update_missing_dependencies($oldid, $libraryid);
215 |     }
216 | 
217 |     /**
218 |      * Process and inserts translations for library.
219 |      *
220 |      * @param $data
221 |      *
222 |      * @throws dml_exception
223 |      */
224 |     protected function process_hvp_library_translation($data) {
225 |         global $DB;
226 | 
227 |         $data = (object) $data;
228 |         $data->library_id = $this->get_new_parentid('hvp_library');
229 | 
230 |         // Check that translations doesn't exists.
231 |         $translation = $DB->get_record_sql(
232 |             'SELECT id
233 |                FROM {hvp_libraries_languages}
234 |               WHERE library_id = ?
235 |                 AND language_code = ?',
236 |               array($data->library_id,
237 |                     $data->language_code)
238 |         );
239 | 
240 |         if (empty($translation)) {
241 |             // Only restore translations if library has been restored.
242 |             $DB->insert_record('hvp_libraries_languages', $data);
243 |         }
244 |     }
245 | 
246 |     /**
247 |      * Process and inserts library dependencies.
248 |      *
249 |      * @param $data
250 |      *
251 |      * @throws dml_exception
252 |      */
253 |     protected function process_hvp_library_dependency($data) {
254 |         global $DB;
255 | 
256 |         $data             = (object) $data;
257 |         $data->library_id = $this->get_new_parentid('hvp_library');
258 | 
259 |         $newlibraryid = $this->get_mappingid('hvp_library', $data->required_library_id);
260 |         if ($newlibraryid) {
261 |             $data->required_library_id = $newlibraryid;
262 | 
263 |             // Check that the dependency doesn't exists.
264 |             $dependency = $DB->get_record_sql(
265 |                 'SELECT id
266 |                  FROM {hvp_libraries_libraries}
267 |                 WHERE library_id = ?
268 |                   AND required_library_id = ?',
269 |                 [
270 |                     $data->library_id,
271 |                     $data->required_library_id,
272 |                 ]
273 |             );
274 |             if (empty($dependency)) {
275 |                 $DB->insert_record('hvp_libraries_libraries', $data);
276 |             }
277 |         } else {
278 |             // The required dependency hasn't been restored yet. We need to add this dependency later.
279 |             $this->update_missing_dependencies($data->required_library_id, null, $data);
280 |         }
281 |     }
282 | 
283 |     /**
284 |      * Additional work that is executed after library restoration steps.
285 |      *
286 |      * @throws dml_exception
287 |      */
288 |     protected function after_execute() {
289 |         // Add files for libraries.
290 |         $context = \context_system::instance();
291 |         $this->add_related_files('mod_hvp', 'libraries', null, $context->id);
292 |     }
293 | 
294 |     /**
295 |      * Cache to reduce queries.
296 |      *
297 |      * @param $library
298 |      * @param null $set
299 |      *
300 |      * @return mixed
301 |      * @throws dml_exception
302 |      */
303 |     public static function get_library_id(&$library, $set = null) {
304 |         static $keytoid;
305 |         global $DB;
306 | 
307 |         $key = $library->machine_name . ' ' . $library->major_version . '.' . $library->minor_version;
308 |         if (is_null($keytoid)) {
309 |             $keytoid = array();
310 |         }
311 |         if ($set !== null) {
312 |             $keytoid[$key] = $set;
313 |         } else if (!isset($keytoid[$key])) {
314 |             $lib = $DB->get_record_sql(
315 |                 'SELECT id
316 |                    FROM {hvp_libraries}
317 |                   WHERE machine_name = ?
318 |                     AND major_version = ?
319 |                     AND minor_version = ?',
320 |                   array($library->machine_name,
321 |                         $library->major_version,
322 |                         $library->minor_version)
323 |             );
324 | 
325 |             // Non existing = false.
326 |             $keytoid[$key] = (empty($lib) ? false : $lib->id);
327 |         }
328 | 
329 |         return $keytoid[$key];
330 |     }
331 | 
332 |     /**
333 |      * Keep track of missing dependencies since libraries aren't inserted
334 |      * in any special order
335 |      *
336 |      * @param $oldid
337 |      * @param $newid
338 |      * @param null $setmissing
339 |      *
340 |      * @throws dml_exception
341 |      */
342 |     private function update_missing_dependencies($oldid, $newid, $setmissing = null) {
343 |         static $missingdeps;
344 |         global $DB;
345 | 
346 |         if (is_null($missingdeps)) {
347 |             $missingdeps = array();
348 |         }
349 | 
350 |         if ($setmissing !== null) {
351 |             $missingdeps[$oldid][] = $setmissing;
352 |         } else if (isset($missingdeps[$oldid])) {
353 |             foreach ($missingdeps[$oldid] as $missingdep) {
354 |                 $missingdep->required_library_id = $newid;
355 | 
356 |                 // Check that the dependency doesn't exists.
357 |                 $dependency = $DB->get_record_sql(
358 |                     'SELECT id
359 |                        FROM {hvp_libraries_libraries}
360 |                       WHERE library_id = ?
361 |                         AND required_library_id = ?',
362 |                       array($missingdep->library_id,
363 |                             $missingdep->required_library_id)
364 |                 );
365 |                 if (empty($dependency)) {
366 |                     $DB->insert_record('hvp_libraries_libraries', $missingdep);
367 |                 }
368 |             }
369 |             unset($missingdeps[$oldid]);
370 |         }
371 |     }
372 | }
373 | 


--------------------------------------------------------------------------------