+ {{> core/toggle }}
+
+
diff --git a/admin/tests/behat/browse_users.feature b/admin/tests/behat/browse_users.feature
index 0c6a8e309d7d8..b06f508de9dac 100644
--- a/admin/tests/behat/browse_users.feature
+++ b/admin/tests/behat/browse_users.feature
@@ -18,7 +18,7 @@ Feature: An administrator can browse user accounts
When I navigate to "Users > Accounts > Browse list of users" in site administration
# Name field always present, email field is default for showidentity.
Then the following should exist in the "reportbuilder-table" table:
- | First name / Last name | Email address |
+ | First name | Email address |
| User One | one@example.com |
| User Two | two@example.com |
# Should not see other identity fields or non-default name fields.
@@ -34,7 +34,7 @@ Feature: An administrator can browse user accounts
| alternativefullnameformat | firstnamephonetic lastname |
When I navigate to "Users > Accounts > Browse list of users" in site administration
Then the following should exist in the "reportbuilder-table" table:
- | First name - phonetic / Last name | Email address |
+ | First name - phonetic | Email address |
| Yewzer One | one@example.com |
| Yoozare Two | two@example.com |
@@ -43,7 +43,7 @@ Feature: An administrator can browse user accounts
| showuseridentity | department,profile_field_frog |
When I navigate to "Users > Accounts > Browse list of users" in site administration
Then the following should exist in the "reportbuilder-table" table:
- | First name / Last name | Favourite frog | Department |
+ | First name | Favourite frog | Department |
| User One | Kermit | Attack |
| User Two | Tree | Defence |
And I should not see "Email address" in the "table" "css_element"
@@ -103,7 +103,7 @@ Feature: An administrator can browse user accounts
| user3 | User | Three | three@example.com | Glass |
And I navigate to "Users > Accounts > Browse list of users" in site administration
Then the following should exist in the "reportbuilder-table" table:
- | First name / Last name | Email address |
+ | First name | Email address |
| User One | one@example.com |
| User Two | two@example.com |
| User Three | three@example.com |
@@ -137,7 +137,7 @@ Feature: An administrator can browse user accounts
| user2 | C1 | student |
And I navigate to "Users > Accounts > Browse list of users" in site administration
Then the following should exist in the "reportbuilder-table" table:
- | First name / Last name | Email address |
+ | First name | Email address |
| User One | one@example.com |
| User Two | two@example.com |
And I click on "Filters" "button"
@@ -166,7 +166,7 @@ Feature: An administrator can browse user accounts
| user1 | coursecreator | system | |
And I navigate to "Users > Accounts > Browse list of users" in site administration
Then the following should exist in the "reportbuilder-table" table:
- | First name / Last name | Email address |
+ | First name | Email address |
| User One | one@example.com |
| User Two | two@example.com |
| User Three | three@example.com |
diff --git a/admin/tests/behat/manage_blocks.feature b/admin/tests/behat/manage_blocks.feature
index 548a2993188c1..b337229454bda 100644
--- a/admin/tests/behat/manage_blocks.feature
+++ b/admin/tests/behat/manage_blocks.feature
@@ -8,26 +8,14 @@ Feature: An administrator can manage Block plugins
Scenario: An administrator can control the enabled state of block plugins using JavaScript
Given I am logged in as "admin"
And I navigate to "Plugins > Blocks > Manage blocks" in site administration
- When I click on "Disable Latest badges" "link"
- Then I should see "Latest badges disabled."
- And "Disable Latest badges" "link" should not exist
- But "Enable Latest badges" "link" should exist
- When I click on "Enable Latest badges" "link"
- Then I should see "Latest badges enabled."
- And "Enable Latest badges" "link" should not exist
- But "Disable Latest badges" "link" should exist
-
- Scenario: An administrator can control the enabled state of block plugins without JavaScript
- Given I am logged in as "admin"
- And I navigate to "Plugins > Blocks > Manage blocks" in site administration
- When I click on "Disable Latest badges" "link"
- Then I should see "Latest badges disabled."
- And "Disable Latest badges" "link" should not exist
- But "Enable Latest badges" "link" should exist
- When I click on "Enable Latest badges" "link"
- Then I should see "Latest badges enabled."
- And "Enable Latest badges" "link" should not exist
- But "Disable Latest badges" "link" should exist
+ When I toggle the "Disable Latest badges" admin switch "off"
+ And I should see "Latest badges disabled."
+ And I reload the page
+ Then I should see "Enable Latest badges"
+ And I toggle the "Enable Latest badges" admin switch "on"
+ And I should see "Latest badges enabled."
+ And I reload the page
+ Then I should see "Disable Latest badges"
@javascript
Scenario: An administrator can control the protected state of block plugins using JavaScript
diff --git a/admin/tests/behat/manage_media.feature b/admin/tests/behat/manage_media.feature
index 27ef3fd3b76de..71ea37a7f0d86 100644
--- a/admin/tests/behat/manage_media.feature
+++ b/admin/tests/behat/manage_media.feature
@@ -6,25 +6,14 @@ Feature: An administrator can manage Media plugins
@javascript
Scenario: An administrator can control the enabled state of media plugins using JavaScript
+ The state change should be reflected in the UI and persist across page reloads
Given I am logged in as "admin"
And I navigate to "Plugins > Media players > Manage media players" in site administration
- When I click on "Disable YouTube" "link"
- Then I should see "YouTube disabled."
- And "Disable YouTube" "link" should not exist
- But "Enable YouTube" "link" should exist
- When I click on "Enable YouTube" "link"
- Then I should see "YouTube enabled."
- And "Enable YouTube" "link" should not exist
- But "Disable YouTube" "link" should exist
-
- Scenario: An administrator can control the enabled state of media plugins without JavaScript
- Given I am logged in as "admin"
- And I navigate to "Plugins > Media players > Manage media players" in site administration
- When I click on "Disable YouTube" "link"
- Then I should see "YouTube disabled."
- And "Disable YouTube" "link" should not exist
- But "Enable YouTube" "link" should exist
- When I click on "Enable YouTube" "link"
- Then I should see "YouTube enabled."
- And "Enable YouTube" "link" should not exist
- But "Disable YouTube" "link" should exist
+ When I toggle the "Disable YouTube" admin switch "off"
+ And I should see "YouTube disabled."
+ And I reload the page
+ Then I should see "Enable YouTube"
+ And I toggle the "Enable YouTube" admin switch "on"
+ And I should see "YouTube enabled."
+ And I reload the page
+ Then I should see "Disable YouTube"
diff --git a/admin/tool/admin_presets/amd/build/admin_presets_list.min.js b/admin/tool/admin_presets/amd/build/admin_presets_list.min.js
new file mode 100644
index 0000000000000..2697debff79a1
--- /dev/null
+++ b/admin/tool/admin_presets/amd/build/admin_presets_list.min.js
@@ -0,0 +1,3 @@
+define("tool_admin_presets/admin_presets_list",["exports","core/event_dispatcher","core/notification","core/prefetch","core/str","core/pending","core_reportbuilder/local/events","core_reportbuilder/local/selectors","core/toast","tool_admin_presets/repository"],(function(_exports,_event_dispatcher,_notification,_prefetch,_str,_pending,reportEvents,reportSelectors,_toast,_repository){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors);_exports.init=()=>{(0,_prefetch.prefetchStrings)("core",["delete"]),(0,_prefetch.prefetchStrings)("tool_admin_presets",["deleteshow","deletepreset","eventpresetdeleted","deletepreviouslyapplied"]),document.addEventListener("click",(event=>{const presetDelete=event.target.closest('[data-action="admin-preset-delete"]');if(presetDelete){event.preventDefault();const triggerElement=presetDelete.closest(".dropdown").querySelector(".dropdown-toggle"),stringid=presetDelete.dataset.presetRollback?"deletepreviouslyapplied":"deletepreset";_notification.default.saveCancelPromise((0,_str.getString)("deleteshow","tool_admin_presets"),(0,_str.getString)(stringid,"tool_admin_presets",presetDelete.dataset.presetName),(0,_str.getString)("delete","core"),{triggerElement:triggerElement}).then((()=>{const pendingPromise=new _pending.default("tool/admin_presets:deletepreset"),reportElement=event.target.closest(reportSelectors.regions.report);return(0,_repository.deletePreset)(presetDelete.dataset.presetId).then((()=>(0,_toast.add)((0,_str.getString)("eventpresetdeleted","tool_admin_presets")))).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preservePagination:!0},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)})).catch((()=>{}))}}))}}));
+
+//# sourceMappingURL=admin_presets_list.min.js.map
\ No newline at end of file
diff --git a/admin/tool/admin_presets/amd/build/admin_presets_list.min.js.map b/admin/tool/admin_presets/amd/build/admin_presets_list.min.js.map
new file mode 100644
index 0000000000000..eab530fc24f08
--- /dev/null
+++ b/admin/tool/admin_presets/amd/build/admin_presets_list.min.js.map
@@ -0,0 +1 @@
+{"version":3,"file":"admin_presets_list.min.js","sources":["../src/admin_presets_list.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see This preset has been previously applied. Deleting a preset removes it from your site completely. You will not be able to revert your settings to how they were before applying this preset.'; $string['deletepresettitle'] = 'Delete {$a} preset?'; $string['deleteshow'] = 'Delete site admin preset'; +$string['editadminpresetname'] = 'Edit admin preset name'; $string['eventpresetdeleted'] = 'Preset deleted'; $string['eventpresetdownloaded'] = 'Preset downloaded'; $string['eventpresetexported'] = 'Preset created'; diff --git a/admin/tool/admin_presets/lib.php b/admin/tool/admin_presets/lib.php new file mode 100644 index 0000000000000..439d81073434b --- /dev/null +++ b/admin/tool/admin_presets/lib.php @@ -0,0 +1,63 @@ +. + +/** + * Admin presets callbacks + * + * @package tool_admin_presets + * @copyright 2024 David Carrillo
-
+
{{< placeholder width="100%" height="250" class="" text="Image" >}}
diff --git a/admin/tool/componentlibrary/content/bootstrap/utilities/stretched-link.md b/admin/tool/componentlibrary/content/bootstrap/utilities/stretched-link.md
index db714cd7687ec..436318101cb20 100644
--- a/admin/tool/componentlibrary/content/bootstrap/utilities/stretched-link.md
+++ b/admin/tool/componentlibrary/content/bootstrap/utilities/stretched-link.md
@@ -38,7 +38,7 @@ Media objects do not have `position: relative` by default, so we need to add the
Columns are `position: relative` by default, so clickable columns only require the `.stretched-link` class on a link. However, stretching a link over an entire `.row` requires `.position-static` on the column and `.position-relative` on the row.
{{< example >}}
-
+
{{< placeholder width="100%" height="200" class="w-100" text=" " title="Generic placeholder image" >}}
diff --git a/admin/tool/componentlibrary/hugo/site/layouts/_default/docs.html b/admin/tool/componentlibrary/hugo/site/layouts/_default/docs.html
index 93c3b7c993897..27a96ef96b8d2 100644
--- a/admin/tool/componentlibrary/hugo/site/layouts/_default/docs.html
+++ b/admin/tool/componentlibrary/hugo/site/layouts/_default/docs.html
@@ -1,7 +1,7 @@
{{ partial "skippy" . }}
-
+
diff --git a/admin/tool/componentlibrary/hugo/site/layouts/shortcodes/moodleicons.html b/admin/tool/componentlibrary/hugo/site/layouts/shortcodes/moodleicons.html
index 6f89fb4dbbcbd..bb0012391f915 100644
--- a/admin/tool/componentlibrary/hugo/site/layouts/shortcodes/moodleicons.html
+++ b/admin/tool/componentlibrary/hugo/site/layouts/shortcodes/moodleicons.html
@@ -6,7 +6,7 @@
{{ range $.Site.Data.fontawesomeicons }}
{{ .name }}
-
+
diff --git a/admin/tool/dataprivacy/tests/behat/dataexport.feature b/admin/tool/dataprivacy/tests/behat/dataexport.feature
index 0efed8fed2502..d879654127787 100644
--- a/admin/tool/dataprivacy/tests/behat/dataexport.feature
+++ b/admin/tool/dataprivacy/tests/behat/dataexport.feature
@@ -185,7 +185,7 @@ Feature: Data export from the privacy API
And I reload the page
And I should see "Download ready" in the "Victim User 1" "table_row"
And I open the action menu in "Victim User 1" "table_row"
- And following "Download" should download between "1" and "170000" bytes
+ And following "Download" should download between "1" and "172000" bytes
And the following config values are set as admin:
| privacyrequestexpiry | 1 | tool_dataprivacy |
And I wait "1" seconds
diff --git a/admin/tool/generator/classes/local/testscenario/runner.php b/admin/tool/generator/classes/local/testscenario/runner.php
index ea9d04562594e..8122cf5cadc5f 100644
--- a/admin/tool/generator/classes/local/testscenario/runner.php
+++ b/admin/tool/generator/classes/local/testscenario/runner.php
@@ -16,12 +16,15 @@
namespace tool_generator\local\testscenario;
+use behat_admin;
use behat_data_generators;
+use behat_base;
use Behat\Gherkin\Parser;
use Behat\Gherkin\Lexer;
use Behat\Gherkin\Keywords\ArrayKeywords;
use ReflectionClass;
use ReflectionMethod;
+use stdClass;
/**
* Class to process a scenario generator file.
@@ -72,6 +75,7 @@ public function include_behat_libraries() {
require_once($CFG->libdir . '/behat/classes/behat_command.php');
require_once($CFG->libdir . '/behat/behat_base.php');
require_once("{$CFG->libdir}/tests/behat/behat_data_generators.php");
+ require_once("{$CFG->dirroot}/admin/tests/behat/behat_admin.php");
return true;
}
@@ -81,6 +85,15 @@ public function include_behat_libraries() {
private function load_generator() {
$this->generator = new behat_data_generators();
$this->validsteps = $this->scan_generator($this->generator);
+
+ // Set config values is not inside the general behat generators.
+ $extra = $this->scan_method(
+ new ReflectionMethod(behat_admin::class, 'the_following_config_values_are_set_as_admin'),
+ new behat_admin(),
+ );
+ if ($extra) {
+ $this->validsteps[$extra->given] = $extra;
+ }
}
/**
@@ -93,14 +106,32 @@ private function scan_generator(behat_data_generators $generator): array {
$class = new ReflectionClass($generator);
$methods = $class->getMethods(ReflectionMethod::IS_PUBLIC);
foreach ($methods as $method) {
- $given = $this->get_method_given($method);
- if ($given) {
- $result[$given] = $method->getName();
+ $scan = $this->scan_method($method, $generator);
+ if ($scan) {
+ $result[$scan->given] = $scan;
}
}
return $result;
}
+ /**
+ * Scan a method to get the given expression tag.
+ * @param ReflectionMethod $method the method to scan.
+ * @param behat_base $behatclass the behat class instance to use.
+ * @return stdClass|null the method data (given, name, class).
+ */
+ private function scan_method(ReflectionMethod $method, behat_base $behatclass): ?stdClass {
+ $given = $this->get_method_given($method);
+ if (!$given) {
+ return null;
+ }
+ return (object)[
+ 'given' => $given,
+ 'name' => $method->getName(),
+ 'generator' => $behatclass,
+ ];
+ }
+
/**
* Get the given expression tag of a method.
*
@@ -146,7 +177,7 @@ public function parse_feature(string $content): parsedfeature {
$result->add_scenario($scenario->getNodeType(), $scenario->getTitle());
$steps = $scenario->getSteps();
foreach ($steps as $step) {
- $result->add_step(new steprunner($this->generator, $this->validsteps, $step));
+ $result->add_step(new steprunner(null, $this->validsteps, $step));
}
}
}
diff --git a/admin/tool/generator/classes/local/testscenario/steprunner.php b/admin/tool/generator/classes/local/testscenario/steprunner.php
index e315640aad5ac..17b7834c276a6 100644
--- a/admin/tool/generator/classes/local/testscenario/steprunner.php
+++ b/admin/tool/generator/classes/local/testscenario/steprunner.php
@@ -16,7 +16,7 @@
namespace tool_generator\local\testscenario;
-use behat_data_generators;
+use behat_base;
use Behat\Gherkin\Node\StepNode;
/**
@@ -27,8 +27,8 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class steprunner {
- /** @var behat_data_generators the behat data generator instance. */
- private behat_data_generators $generator;
+ /** @var behat_base|null the behat step class instance. */
+ private ?behat_base $generator = null;
/** @var array the valid steps indexed by given expression tag. */
private array $validsteps;
@@ -53,12 +53,14 @@ class steprunner {
/**
* Constructor.
- * @param behat_data_generators $generator the behat data generator instance.
+ * @param behat_base|null $unused This does nothing, do not use it.
* @param array $validsteps the valid steps indexed by given expression tag.
* @param StepNode $stepnode the step node to process.
*/
- public function __construct(behat_data_generators $generator, array $validsteps, StepNode $stepnode) {
- $this->generator = $generator;
+ public function __construct($unused, array $validsteps, StepNode $stepnode) {
+ if ($unused !== null) {
+ debugging('Deprecated argument passed to ' . __FUNCTION__, DEBUG_DEVELOPER);
+ }
$this->validsteps = $validsteps;
$this->stepnode = $stepnode;
$this->init();
@@ -73,12 +75,13 @@ public function __construct(behat_data_generators $generator, array $validsteps,
private function init() {
$matches = [];
$linetext = $this->stepnode->getText();
- foreach ($this->validsteps as $pattern => $method) {
- if (!$this->match_given($pattern, $linetext, $matches)) {
+ foreach ($this->validsteps as $method) {
+ if (!$this->match_given($method->given, $linetext, $matches)) {
continue;
}
- $this->method = $method;
- $this->params = $this->build_method_params($method, $matches);
+ $this->method = $method->name;
+ $this->params = $this->build_method_params($method->name, $matches, $method->generator);
+ $this->generator = $method->generator;
$this->isvalid = true;
return;
}
@@ -89,10 +92,11 @@ private function init() {
* Build the method parameters.
* @param string $methodname the method name.
* @param array $matches the matches.
+ * @param behat_base $generator the method class.
* @return array the method parameters.
*/
- private function build_method_params($methodname, $matches) {
- $method = new \ReflectionMethod($this->generator, $methodname);
+ private function build_method_params(string $methodname, array $matches, behat_base $generator) {
+ $method = new \ReflectionMethod($generator, $methodname);
$params = [];
foreach ($method->getParameters() as $param) {
$paramname = $param->getName();
diff --git a/admin/tool/generator/tests/behat/testscenario.feature b/admin/tool/generator/tests/behat/testscenario.feature
index 41f641df82b86..1a03a8bf065f5 100644
--- a/admin/tool/generator/tests/behat/testscenario.feature
+++ b/admin/tool/generator/tests/behat/testscenario.feature
@@ -21,6 +21,11 @@ Feature: Create testing scenarios using generators
And I should see "Student Test3"
And I should see "Student Test4"
And I should see "Student Test5"
+ And I set the field "Participants tertiary navigation" to "Enrolment methods"
+ And I click on "Edit" "link" in the "Manual enrolments" "table_row"
+ And the field "Send course welcome message" matches value "No"
+ And I navigate to "Plugins > Enrolments > Manual enrolments" in site administration
+ And the field "Send course welcome message" matches value "No"
@javascript
Scenario: Prevent creating a testing scenario with no steps to execute
diff --git a/admin/tool/generator/tests/fixtures/testscenario/scenario.feature b/admin/tool/generator/tests/fixtures/testscenario/scenario.feature
index d228631ca0f2b..8993270dc694a 100644
--- a/admin/tool/generator/tests/fixtures/testscenario/scenario.feature
+++ b/admin/tool/generator/tests/fixtures/testscenario/scenario.feature
@@ -1,6 +1,8 @@
Feature: Prepare scenario for testing
Scenario: Create course content
- Given the following "course" exists:
+ Given the following config values are set as admin:
+ | sendcoursewelcomemessage | 0 | enrol_manual |
+ And the following "course" exists:
| fullname | Course test |
| shortname | C1 |
| category | 0 |
diff --git a/admin/tool/generator/tests/local/testscenario/runner_test.php b/admin/tool/generator/tests/local/testscenario/runner_test.php
index 835abeb61b1b3..42e2471cae81a 100644
--- a/admin/tool/generator/tests/local/testscenario/runner_test.php
+++ b/admin/tool/generator/tests/local/testscenario/runner_test.php
@@ -46,7 +46,7 @@ public function test_parse_and_execute_feature(): void {
$feature = $runner->parse_feature($contents);
$this->assertEquals(2, count($feature->get_scenarios()));
- $this->assertEquals(6, count($feature->get_all_steps()));
+ $this->assertEquals(7, count($feature->get_all_steps()));
$this->assertTrue($feature->is_valid());
$result = $runner->execute($feature);
diff --git a/admin/tool/generator/tests/local/testscenario/steprunner_test.php b/admin/tool/generator/tests/local/testscenario/steprunner_test.php
index d66f5b1259464..2abe7a6de3b92 100644
--- a/admin/tool/generator/tests/local/testscenario/steprunner_test.php
+++ b/admin/tool/generator/tests/local/testscenario/steprunner_test.php
@@ -58,6 +58,31 @@ private function get_step(string $step): StepNode {
return $steps[0];
}
+ /**
+ * Get the list of valid behat steps for the tests.
+ * @return array the valid steps details.
+ */
+ private function get_valid_steps(): array {
+ $generator = new behat_data_generators();
+ return [
+ '/^the following "(?P(?:[^"]|\\")*)" exist:$/' => (object) [
+ 'name' => 'the_following_entities_exist',
+ 'given' => '/^the following "(?P(?:[^"]|\\")*)" exist:$/',
+ 'generator' => $generator,
+ ],
+ ':count :entitytype exist with the following data:' => (object) [
+ 'name' => 'the_following_repeated_entities_exist',
+ 'given' => ':count :entitytype exist with the following data:',
+ 'generator' => $generator,
+ ],
+ 'the following :entitytype exists:' => (object) [
+ 'name' => 'the_following_entity_exists',
+ 'given' => 'the following :entitytype exists:',
+ 'generator' => $generator,
+ ],
+ ];
+ }
+
/**
* Test for parse_feature.
* @covers ::is_valid
@@ -66,15 +91,9 @@ private function get_step(string $step): StepNode {
* @dataProvider execute_steps_provider
*/
public function test_is_valid(string $step, bool $expected): void {
- $generator = new behat_data_generators();
- $validsteps = [
- '/^the following "(?P(?:[^"]|\\")*)" exist:$/' => 'the_following_entities_exist',
- ':count :entitytype exist with the following data:' => 'the_following_repeated_entities_exist',
- 'the following :entitytype exists:' => 'the_following_entity_exists',
- ];
-
+ $validsteps = $this->get_valid_steps();
$step = $this->get_step($step);
- $steprunner = new steprunner($generator, $validsteps, $step);
+ $steprunner = new steprunner(null, $validsteps, $step);
$this->assertEquals($expected, $steprunner->is_valid());
}
@@ -92,15 +111,10 @@ public function test_execute(string $step, bool $expected): void {
$this->resetAfterTest();
- $generator = new behat_data_generators();
- $validsteps = [
- '/^the following "(?P(?:[^"]|\\")*)" exist:$/' => 'the_following_entities_exist',
- ':count :entitytype exist with the following data:' => 'the_following_repeated_entities_exist',
- 'the following :entitytype exists:' => 'the_following_entity_exists',
- ];
+ $validsteps = $this->get_valid_steps();
$step = $this->get_step($step);
- $steprunner = new steprunner($generator, $validsteps, $step);
+ $steprunner = new steprunner(null, $validsteps, $step);
$this->assertFalse($steprunner->is_executed());
@@ -163,18 +177,13 @@ public function test_execute_duplicated(): void {
$this->resetAfterTest();
- $generator = new behat_data_generators();
- $validsteps = [
- '/^the following "(?P(?:[^"]|\\")*)" exist:$/' => 'the_following_entities_exist',
- ':count :entitytype exist with the following data:' => 'the_following_repeated_entities_exist',
- 'the following :entitytype exists:' => 'the_following_entity_exists',
- ];
+ $validsteps = $this->get_valid_steps();
$step = $this->get_step('Given the following "course" exists:
| fullname | Course test |
| shortname | C1 |
| category | 0 |');
- $steprunner = new steprunner($generator, $validsteps, $step);
+ $steprunner = new steprunner(null, $validsteps, $step);
$this->assertFalse($steprunner->is_executed());
@@ -191,7 +200,7 @@ public function test_execute_duplicated(): void {
);
// Execute the same course creation.
- $steprunner = new steprunner($generator, $validsteps, $step);
+ $steprunner = new steprunner(null, $validsteps, $step);
$this->assertFalse($steprunner->is_executed());
$result = $steprunner->execute();
$this->assertFalse($result);
@@ -205,19 +214,14 @@ public function test_execute_duplicated(): void {
* @covers ::get_arguments_string
*/
public function test_get_step_content(): void {
- $generator = new behat_data_generators();
- $validsteps = [
- '/^the following "(?P(?:[^"]|\\")*)" exist:$/' => 'the_following_entities_exist',
- ':count :entitytype exist with the following data:' => 'the_following_repeated_entities_exist',
- 'the following :entitytype exists:' => 'the_following_entity_exists',
- ];
-
$step = $this->get_step('Given the following "course" exists:
- | fullname | Course test |
- | shortname | C1 |
- | category | 0 |
- | numsections | 3 |');
- $steprunner = new steprunner($generator, $validsteps, $step);
+ | fullname | Course test |
+ | shortname | C1 |
+ | category | 0 |
+ | numsections | 3 |');
+
+ $validsteps = $this->get_valid_steps();
+ $steprunner = new steprunner(null, $validsteps, $step);
$this->assertEquals(
'the following "course" exists:',
diff --git a/admin/tool/log/tests/behat/logstore_store_visibility_change.feature b/admin/tool/log/tests/behat/logstore_store_visibility_change.feature
index 79e5ebfe53a4f..39641c02e3d72 100644
--- a/admin/tool/log/tests/behat/logstore_store_visibility_change.feature
+++ b/admin/tool/log/tests/behat/logstore_store_visibility_change.feature
@@ -14,6 +14,6 @@ Feature: In a report, admin can see logstore visibility changes
And I click on "Enable" "icon" in the "External database log" "table_row"
And I navigate to "Reports > Config changes" in site administration
Then the following should exist in the "reportbuilder-table" table:
- | User | Plugin | Setting | New value | Original value |
+ | First name | Plugin | Setting | New value | Original value |
| Admin User | logstore_standard | tool_logstore_visibility | 0 | 1 |
| Admin User | logstore_database | tool_logstore_visibility | 1 | 0 |
diff --git a/availability/condition/grade/tests/behat/availability_grade.feature b/availability/condition/grade/tests/behat/availability_grade.feature
index c8f195fa172be..027cd2d0afa00 100644
--- a/availability/condition/grade/tests/behat/availability_grade.feature
+++ b/availability/condition/grade/tests/behat/availability_grade.feature
@@ -89,7 +89,9 @@ Feature: availability_grade
# Give the assignment 40%.
And I follow "View all submissions"
# Pick the grade link in the row that has s@example.com in it.
+ And I change window size to "large"
And I click on "Grade" "link" in the "s@example.com" "table_row"
+ And I change window size to "medium"
And I set the field "Grade out of 100" to "40"
And I click on "Save changes" "button"
And I click on "Edit settings" "link"
diff --git a/backup/moodle2/backup_activity_task.class.php b/backup/moodle2/backup_activity_task.class.php
index f0df9d0ab2e6f..fb115d66c17a0 100644
--- a/backup/moodle2/backup_activity_task.class.php
+++ b/backup/moodle2/backup_activity_task.class.php
@@ -38,6 +38,9 @@ abstract class backup_activity_task extends backup_task {
protected $moduleid;
protected $sectionid;
+
+ /** @var stdClass the section object */
+ protected $section;
protected $modulename;
protected $activityid;
protected $contextid;
@@ -50,6 +53,7 @@ abstract class backup_activity_task extends backup_task {
* @param backup_plan|null $plan the backup plan instance this task is part of
*/
public function __construct($name, $moduleid, $plan = null) {
+ global $DB;
// Check moduleid exists
if (!$coursemodule = get_coursemodule_from_id(false, $moduleid)) {
@@ -65,6 +69,7 @@ public function __construct($name, $moduleid, $plan = null) {
$this->modulename = $coursemodule->modname;
$this->activityid = $coursemodule->instance;
$this->contextid = context_module::instance($this->moduleid)->id;
+ $this->section = $DB->get_record('course_sections', ['id' => $this->sectionid]);
parent::__construct($name, $plan);
}
@@ -90,6 +95,16 @@ public function get_modulename() {
return $this->modulename;
}
+ /**
+ * Return if the activity is inside a subsection.
+ *
+ * @return bool
+ */
+ public function is_in_subsection(): bool {
+ return !empty($this->section->component);
+ }
+
+
/**
* @return int the id of the activity instance (id in the activity's instances table)
*/
@@ -123,12 +138,12 @@ public function build() {
}
// Add some extra settings that related processors are going to need
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODID, base_setting::IS_INTEGER, $this->moduleid));
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid()));
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid));
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODNAME, base_setting::IS_FILENAME, $this->modulename));
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_ACTIVITYID, base_setting::IS_INTEGER, $this->activityid));
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $this->contextid));
+ $this->add_section_setting(backup::VAR_MODID, base_setting::IS_INTEGER, $this->moduleid);
+ $this->add_section_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid());
+ $this->add_section_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid);
+ $this->add_section_setting(backup::VAR_MODNAME, base_setting::IS_FILENAME, $this->modulename);
+ $this->add_section_setting(backup::VAR_ACTIVITYID, base_setting::IS_INTEGER, $this->activityid);
+ $this->add_section_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $this->contextid);
// Create the activity directory
$this->add_step(new create_taskbasepath_directory('create_activity_directory'));
@@ -269,58 +284,111 @@ protected function define_settings() {
$settingprefix = $this->modulename . '_' . $this->moduleid . '_';
// All these are common settings to be shared by all activities.
+ $activityincluded = $this->add_activity_included_setting($settingprefix);
+
+ if (question_module_uses_questions($this->modulename)) {
+ $questionbank = $this->plan->get_setting('questionbank');
+ $questionbank->add_dependency($activityincluded);
+ }
+
+ $this->add_activity_userinfo_setting($settingprefix, $activityincluded);
+
+ // End of common activity settings, let's add the particular ones.
+ $this->define_my_settings();
+ }
+
+ /**
+ * Add a setting to the task. This method is used to add a setting to the task
+ *
+ * @param int|string $identifier the identifier of the setting
+ * @param string $type the type of the setting
+ * @param string|int $value the value of the setting
+ * @return section_backup_setting the setting added
+ */
+ protected function add_section_setting(int|string $identifier, string $type, string|int $value): activity_backup_setting {
+ if ($this->is_in_subsection()) {
+ $setting = new backup_subactivity_generic_setting($identifier, $type, $value);
+ } else {
+ $setting = new backup_activity_generic_setting($identifier, $type, $value);
+ }
+ $this->add_setting($setting);
+ return $setting;
+ }
+ /**
+ * Add the section include setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @return activity_backup_setting the setting added
+ */
+ protected function add_activity_included_setting(string $settingprefix): activity_backup_setting {
// Define activity_include (to decide if the whole task must be really executed)
// Dependent of:
// - activities root setting.
- // - section_included setting (if exists).
+ // - sectionincluded setting (if exists).
$settingname = $settingprefix . 'included';
- $activityincluded = new backup_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+ if ($this->is_in_subsection()) {
+ $activityincluded = new backup_subactivity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+ } else {
+ $activityincluded = new backup_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+ }
$activityincluded->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
- $this->modulename, array('class' => 'iconlarge icon-post ml-1')));
+ $this->modulename, array('class' => 'ml-1')));
$this->add_setting($activityincluded);
+
// Look for "activities" root setting.
$activities = $this->plan->get_setting('activities');
$activities->add_dependency($activityincluded);
- if (question_module_uses_questions($this->modulename)) {
- $questionbank = $this->plan->get_setting('questionbank');
- $questionbank->add_dependency($activityincluded);
- }
-
// Look for "sectionincluded" section setting (if exists).
$settingname = 'section_' . $this->sectionid . '_included';
if ($this->plan->setting_exists($settingname)) {
$sectionincluded = $this->plan->get_setting($settingname);
$sectionincluded->add_dependency($activityincluded);
}
+ return $activityincluded;
+ }
- // Define activityuserinfo. Dependent of:
+ /**
+ * Add the section userinfo setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @param activity_backup_setting $includefield the setting to depend on
+ * @return activity_backup_setting the setting added
+ */
+ protected function add_activity_userinfo_setting(
+ string $settingprefix,
+ activity_backup_setting $includefield
+ ): activity_backup_setting {
+ // Define activity_userinfo. Dependent of:
// - users root setting.
// - sectionuserinfo setting (if exists).
- // - activityincluded setting.
+ // - includefield setting.
$settingname = $settingprefix . 'userinfo';
- $activityuserinfo = new backup_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+ if ($this->is_in_subsection()) {
+ $activityuserinfo = new backup_subactivity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+ } else {
+ $activityuserinfo = new backup_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+ }
+
$activityuserinfo->get_ui()->set_label('-');
$activityuserinfo->get_ui()->set_visually_hidden_label(
get_string('includeuserinfo_instance', 'core_backup', $this->name)
);
$this->add_setting($activityuserinfo);
-
// Look for "users" root setting.
$users = $this->plan->get_setting('users');
$users->add_dependency($activityuserinfo);
+
// Look for "sectionuserinfo" section setting (if exists).
$settingname = 'section_' . $this->sectionid . '_userinfo';
if ($this->plan->setting_exists($settingname)) {
$sectionuserinfo = $this->plan->get_setting($settingname);
$sectionuserinfo->add_dependency($activityuserinfo);
}
- // Look for "activityincluded" setting.
- $activityincluded->add_dependency($activityuserinfo);
- // End of common activity settings, let's add the particular ones.
- $this->define_my_settings();
+ $includefield->add_dependency($activityuserinfo);
+ return $activityuserinfo;
}
/**
diff --git a/backup/moodle2/backup_plan_builder.class.php b/backup/moodle2/backup_plan_builder.class.php
index 49244870e4e5c..508635997d885 100644
--- a/backup/moodle2/backup_plan_builder.class.php
+++ b/backup/moodle2/backup_plan_builder.class.php
@@ -133,6 +133,9 @@ protected static function build_activity_plan($controller, $id) {
try {
$plan->add_task(backup_factory::get_backup_activity_task($controller->get_format(), $id));
+ // Some activities may have delegated section integrations.
+ self::build_delegated_section_plan($controller, $id);
+
// For the given activity, add as many block tasks as necessary
$blockids = backup_plan_dbops::get_blockids_from_moduleid($id);
foreach ($blockids as $blockid) {
@@ -150,6 +153,44 @@ protected static function build_activity_plan($controller, $id) {
}
}
+ /**
+ * Build a course module delegated section backup plan.
+ * @param backup_controller $controller
+ * @param int $cmid the parent course module id.
+ */
+ protected static function build_delegated_section_plan($controller, $cmid) {
+ global $CFG, $DB;
+
+ // Check moduleid exists.
+ if (!$coursemodule = get_coursemodule_from_id(false, $cmid)) {
+ $controller->log(get_string('error_course_module_not_found', 'backup', $cmid), backup::LOG_WARNING);
+ }
+ $classname = 'mod_' . $coursemodule->modname . '\courseformat\sectiondelegate';
+ if (!class_exists($classname)) {
+ return;
+ }
+ $sectionid = null;
+ try {
+ $sectionid = $classname::delegated_section_id($coursemodule);
+ } catch (dml_exception $error) {
+ $controller->log(get_string('error_delegate_section_not_found', 'backup', $cmid), backup::LOG_WARNING);
+ return;
+ }
+
+ $plan = $controller->get_plan();
+ $sectiontask = backup_factory::get_backup_section_task($controller->get_format(), $sectionid);
+ $sectiontask->set_delegated_cm($cmid);
+ $plan->add_task($sectiontask);
+
+ // For the given section, add as many activity tasks as necessary.
+ $coursemodules = backup_plan_dbops::get_modules_from_sectionid($sectionid);
+ foreach ($coursemodules as $coursemodule) {
+ if (plugin_supports('mod', $coursemodule->modname, FEATURE_BACKUP_MOODLE2)) {
+ self::build_activity_plan($controller, $coursemodule->id);
+ }
+ }
+ }
+
/**
* Build one 1-section backup
*/
@@ -185,8 +226,13 @@ protected static function build_course_plan($controller, $id) {
// For the given course, add as many section tasks as necessary
$sections = backup_plan_dbops::get_sections_from_courseid($id);
- foreach ($sections as $section) {
- self::build_section_plan($controller, $section);
+ foreach ($sections as $sectionid) {
+ // Delegated sections are not course responsability.
+ $sectiondata = backup_plan_dbops::get_section_from_id($sectionid);
+ if (!empty($sectiondata->component)) {
+ continue;
+ }
+ self::build_section_plan($controller, $sectionid);
}
// For the given course, add as many block tasks as necessary
diff --git a/backup/moodle2/backup_section_task.class.php b/backup/moodle2/backup_section_task.class.php
index cdd76c85a2f30..f676fba88dce5 100644
--- a/backup/moodle2/backup_section_task.class.php
+++ b/backup/moodle2/backup_section_task.class.php
@@ -37,6 +37,16 @@ class backup_section_task extends backup_task {
protected $sectionid;
+ /**
+ * @var stdClass $section The database section object.
+ */
+ protected stdClass $section;
+
+ /**
+ * @var int|null $delegatedcmid the course module that is delegating this section (if any)
+ */
+ protected ?int $delegatedcmid = null;
+
/**
* Constructor - instantiates one object of this class
*/
@@ -48,11 +58,45 @@ public function __construct($name, $sectionid, $plan = null) {
throw new backup_task_exception('section_task_section_not_found', $sectionid);
}
+ $this->section = $section;
$this->sectionid = $sectionid;
parent::__construct($name, $plan);
}
+ /**
+ * Set the course module that is delegating this section.
+ *
+ * Delegated section can belong to any kind of plugin. However, when a delegated
+ * section belongs to a course module, the UI will present all settings according.
+ *
+ * @param int $cmid the course module id that is delegating this section
+ */
+ public function set_delegated_cm(int $cmid) {
+ $this->delegatedcmid = $cmid;
+ }
+
+ /**
+ * Get the course module that is delegating this section.
+ *
+ * @return int|null the course module id that is delegating this section
+ */
+ public function get_delegated_cm(): ?int {
+ return $this->delegatedcmid;
+ }
+
+ /**
+ * Get the delegate activity modname (if any).
+ *
+ * @return string|null the modname of the delegated activity
+ */
+ public function get_modname(): ?string {
+ if (empty($this->section->component)) {
+ return null;
+ }
+ return core_component::normalize_component($this->section->component)[1];
+ }
+
public function get_sectionid() {
return $this->sectionid;
}
@@ -72,11 +116,11 @@ public function build() {
// Set the backup::VAR_CONTEXTID setting to course context as far as next steps require that
$coursectxid = context_course::instance($this->get_courseid())->id;
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $coursectxid));
+ $this->add_section_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $coursectxid);
// Add some extra settings that related processors are going to need
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid));
- $this->add_setting(new backup_activity_generic_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid()));
+ $this->add_section_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid);
+ $this->add_section_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid());
// Create the section directory
$this->add_step(new create_taskbasepath_directory('create_section_directory'));
@@ -145,32 +189,105 @@ protected function define_settings() {
// All the settings related to this activity will include this prefix.
$settingprefix = 'section_' . $this->sectionid . '_';
- // All these are common settings to be shared by all sections.
+ $incudefield = $this->add_section_included_setting($settingprefix);
+ $this->add_section_userinfo_setting($settingprefix, $incudefield);
+ }
- $section = $DB->get_record('course_sections', array('id' => $this->sectionid), '*', MUST_EXIST);
- $course = $DB->get_record('course', array('id' => $section->course), '*', MUST_EXIST);
+ /**
+ * Add a setting to the task. This method is used to add a setting to the task
+ *
+ * @param int|string $identifier the identifier of the setting
+ * @param string $type the type of the setting
+ * @param string|int $value the value of the setting
+ * @return section_backup_setting the setting added
+ */
+ protected function add_section_setting(int|string $identifier, string $type, string|int $value): section_backup_setting {
+ if ($this->get_delegated_cm()) {
+ $setting = new backup_subsection_generic_setting($identifier, $type, $value);
+ } else {
+ $setting = new backup_section_generic_setting($identifier, $type, $value);
+ }
+ $this->add_setting($setting);
+ return $setting;
+ }
+
+ /**
+ * Add the section included setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @return section_backup_setting the setting added
+ */
+ protected function add_section_included_setting(string $settingprefix): section_backup_setting {
+ global $DB;
+ $course = $DB->get_record('course', ['id' => $this->section->course], '*', MUST_EXIST);
// Define sectionincluded (to decide if the whole task must be really executed).
$settingname = $settingprefix . 'included';
- $sectionincluded = new backup_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
- $sectionincluded->get_ui()->set_label(get_section_name($course, $section));
+
+ $delegatedcmid = $this->get_delegated_cm();
+ if ($delegatedcmid) {
+ $sectionincluded = new backup_subsection_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+ // Subsections depends on the parent activity included setting.
+ $settingname = $this->get_modname() . '_' . $delegatedcmid . '_included';
+ if ($this->plan->setting_exists($settingname)) {
+ $cmincluded = $this->plan->get_setting($settingname);
+ $cmincluded->add_dependency(
+ $sectionincluded,
+ );
+ }
+ $sectionincluded->get_ui()->set_label(get_string('subsectioncontent', 'backup'));
+ } else {
+ $sectionincluded = new backup_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+ $sectionincluded->get_ui()->set_label(get_section_name($course, $this->section));
+ }
+
$this->add_setting($sectionincluded);
+ return $sectionincluded;
+ }
+
+ /**
+ * Add the section userinfo setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @param section_backup_setting $includefield the setting to depend on
+ * @return section_backup_setting the setting added
+ */
+ protected function add_section_userinfo_setting(
+ string $settingprefix,
+ section_backup_setting $includefield
+ ): section_backup_setting {
// Define sectionuserinfo. Dependent of:
// - users root setting.
- // - sectionincluded setting.
+ // - section_included setting.
$settingname = $settingprefix . 'userinfo';
- $sectionuserinfo = new backup_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+
+ $delegatedcmid = $this->get_delegated_cm();
+ if ($delegatedcmid) {
+ $sectionuserinfo = new backup_subsection_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+ // Subsections depends on the parent activity included setting.
+ $settingname = $this->get_modname() . '_' . $delegatedcmid . '_userinfo';
+ if ($this->plan->setting_exists($settingname)) {
+ $cmincluded = $this->plan->get_setting($settingname);
+ $cmincluded->add_dependency(
+ $sectionuserinfo,
+ );
+ }
+ } else {
+ $sectionuserinfo = new backup_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
+ }
+
$sectionuserinfo->get_ui()->set_label(get_string('includeuserinfo', 'backup'));
$sectionuserinfo->get_ui()->set_visually_hidden_label(
- get_string('section_prefix', 'core_backup', $section->name ?: $section->section)
+ get_string('section_prefix', 'core_backup', $this->section->name ?: $this->section->section)
);
$this->add_setting($sectionuserinfo);
-
// Look for "users" root setting.
$users = $this->plan->get_setting('users');
$users->add_dependency($sectionuserinfo);
// Look for "section_included" section setting.
- $sectionincluded->add_dependency($sectionuserinfo);
+ $includefield->add_dependency($sectionuserinfo);
+
+ return $sectionuserinfo;
}
}
diff --git a/backup/moodle2/backup_settingslib.php b/backup/moodle2/backup_settingslib.php
index 6767d01f05712..770c3813ce596 100644
--- a/backup/moodle2/backup_settingslib.php
+++ b/backup/moodle2/backup_settingslib.php
@@ -185,6 +185,45 @@ class backup_section_included_setting extends section_backup_setting {}
*/
class backup_section_userinfo_setting extends section_backup_setting {}
+/**
+ * Subsection base class (section delegated to a course module).
+ */
+class subsection_backup_setting extends section_backup_setting {
+ /**
+ * Class constructor.
+ *
+ * @param string $name Name of the setting
+ * @param string $vtype Type of the setting, for example base_setting::IS_TEXT
+ * @param mixed $value Value of the setting
+ * @param bool $visibility Is the setting visible in the UI, for example base_setting::VISIBLE
+ * @param int $status Status of the setting with regards to the locking, for example base_setting::NOT_LOCKED
+ */
+ public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
+ parent::__construct($name, $vtype, $value, $visibility, $status);
+ $this->level = self::SUBSECTION_LEVEL;
+ }
+}
+
+/**
+ * generic section setting to pass various settings between tasks and steps
+ */
+class backup_subsection_generic_setting extends subsection_backup_setting {
+}
+
+/**
+ * Setting to define if one section is included or no. Activities _included
+ * settings depend of them if available
+ */
+class backup_subsection_included_setting extends subsection_backup_setting {
+}
+
+/**
+ * section backup setting to control if section will include
+ * user information or no, depends of @backup_users_setting
+ */
+class backup_subsection_userinfo_setting extends subsection_backup_setting {
+}
+
// Activity backup settings
@@ -206,6 +245,46 @@ class backup_activity_included_setting extends activity_backup_setting {}
*/
class backup_activity_userinfo_setting extends activity_backup_setting {}
+/**
+ * Subactivity base class (activity inside a delegated section).
+ */
+class subactivity_backup_setting extends activity_backup_setting {
+ /**
+ * Class constructor.
+ *
+ * @param string $name Name of the setting
+ * @param string $vtype Type of the setting, for example base_setting::IS_TEXT
+ * @param mixed $value Value of the setting
+ * @param bool $visibility Is the setting visible in the UI, for example base_setting::VISIBLE
+ * @param int $status Status of the setting with regards to the locking, for example base_setting::NOT_LOCKED
+ */
+ public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
+ parent::__construct($name, $vtype, $value, $visibility, $status);
+ $this->level = self::SUBACTIVITY_LEVEL;
+ }
+}
+
+/**
+ * Generic subactivity (activity inside a delegated section) setting to pass various settings between tasks and steps
+ */
+class backup_subactivity_generic_setting extends subactivity_backup_setting {
+}
+
+/**
+ * Subactivity (activity inside a delegated section) backup setting to control if activity will
+ * be included or no, depends of @backup_activities_setting and
+ * optionally parent section included setting
+ */
+class backup_subactivity_included_setting extends subactivity_backup_setting {
+}
+
+/**
+ * Subactivity (activity inside a delegated section) backup setting to control if activity will include
+ * user information or no, depends of @backup_users_setting
+ */
+class backup_subactivity_userinfo_setting extends subactivity_backup_setting {
+}
+
/**
* Root setting to control if backup will include content bank content or no
*/
diff --git a/backup/moodle2/backup_stepslib.php b/backup/moodle2/backup_stepslib.php
index e5496e408743b..e1c6db33da3b9 100644
--- a/backup/moodle2/backup_stepslib.php
+++ b/backup/moodle2/backup_stepslib.php
@@ -119,6 +119,20 @@ protected function prepare_activity_structure($activitystructure) {
// Return the root element (activity)
return $activity;
}
+
+ /**
+ * Set a delegate section itemid mapping.
+ *
+ * @param string $pluginname the name of the plugin that is delegating the section.
+ * @param int $itemid the itemid of the section being delegated.
+ */
+ protected function set_delegated_section_mapping(string $pluginname, int $itemid) {
+ backup_structure_dbops::insert_backup_ids_record(
+ $this->get_backupid(),
+ "course_section::$pluginname::$itemid",
+ $this->task->get_moduleid()
+ );
+ }
}
/**
@@ -2122,14 +2136,19 @@ protected function define_structure() {
$activities = new backup_nested_element('activities');
- $activity = new backup_nested_element('activity', null, array(
- 'moduleid', 'sectionid', 'modulename', 'title',
- 'directory'));
+ $activity = new backup_nested_element(
+ 'activity',
+ null,
+ ['moduleid', 'sectionid', 'modulename', 'title', 'directory', 'insubsection']
+ );
$sections = new backup_nested_element('sections');
- $section = new backup_nested_element('section', null, array(
- 'sectionid', 'title', 'directory'));
+ $section = new backup_nested_element(
+ 'section',
+ null,
+ ['sectionid', 'title', 'directory', 'parentcmid', 'modname']
+ );
$course = new backup_nested_element('course', null, array(
'courseid', 'title', 'directory'));
diff --git a/backup/moodle2/restore_activity_task.class.php b/backup/moodle2/restore_activity_task.class.php
index 12f6006f1147f..497396554fe34 100644
--- a/backup/moodle2/restore_activity_task.class.php
+++ b/backup/moodle2/restore_activity_task.class.php
@@ -100,6 +100,15 @@ public function get_moduleid() {
return $this->moduleid;
}
+ /**
+ * Return if the activity is inside a subsection.
+ *
+ * @return bool
+ */
+ public function is_in_subsection(): bool {
+ return !empty($this->info->insubsection);
+ }
+
/**
* Returns the old course module id (cmid of activity which will be restored)
*
@@ -288,42 +297,79 @@ public static function define_restore_log_rules() {
* Define the common setting that any restore activity will have
*/
protected function define_settings() {
-
// All the settings related to this activity will include this prefix
$settingprefix = $this->info->modulename . '_' . $this->info->moduleid . '_';
// All these are common settings to be shared by all activities
+ $activityincluded = $this->add_activity_included_setting($settingprefix);
+ $this->add_activity_userinfo_setting($settingprefix, $activityincluded);
+
+ // End of common activity settings, let's add the particular ones.
+ $this->define_my_settings();
+ }
- // Define activity_include (to decide if the whole task must be really executed)
+ /**
+ * Add the activity included setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @return activity_backup_setting the setting added
+ */
+ protected function add_activity_included_setting(string $settingprefix): activity_backup_setting {
+ // Define activity_included (to decide if the whole task must be really executed)
// Dependent of:
- // - activities root setting
- // - section_included setting (if exists)
+ // - activities root setting.
+ // - sectionincluded setting (if exists).
$settingname = $settingprefix . 'included';
- $activity_included = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
- $activity_included->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
- $this->modulename, array('class' => 'iconlarge icon-post ml-1')));
- $this->add_setting($activity_included);
- // Look for "activities" root setting
+
+ if ($this->is_in_subsection()) {
+ $activityincluded = new restore_subactivity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+ } else {
+ $activityincluded = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
+ }
+
+ $activityincluded->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
+ $this->modulename, ['class' => 'ml-1']));
+ $this->add_setting($activityincluded);
+ // Look for "activities" root setting.
$activities = $this->plan->get_setting('activities');
- $activities->add_dependency($activity_included);
- // Look for "section_included" section setting (if exists)
+ $activities->add_dependency($activityincluded);
+ // Look for "sectionincluded" section setting (if exists).
$settingname = 'section_' . $this->info->sectionid . '_included';
if ($this->plan->setting_exists($settingname)) {
- $section_included = $this->plan->get_setting($settingname);
- $section_included->add_dependency($activity_included);
+ $sectionincluded = $this->plan->get_setting($settingname);
+ $sectionincluded->add_dependency($activityincluded);
}
- // Define activity_userinfo. Dependent of:
- // - users root setting
- // - section_userinfo setting (if exists)
- // - activity_included setting.
+ return $activityincluded;
+ }
+
+ /**
+ * Add the activity userinfo setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @param activity_backup_setting $includefield the activity included setting
+ * @return activity_backup_setting the setting added
+ */
+ protected function add_activity_userinfo_setting(
+ string $settingprefix,
+ activity_backup_setting $includefield
+ ): activity_backup_setting {
+ // Define activityuserinfo. Dependent of:
+ // - users root setting.
+ // - sectionuserinfo setting (if exists).
+ // - activity included setting.
$settingname = $settingprefix . 'userinfo';
$defaultvalue = false;
if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
$defaultvalue = true;
}
- $activity_userinfo = new restore_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+ if ($this->is_in_subsection()) {
+ $activityuserinfo = new restore_subactivity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+ } else {
+ $activityuserinfo = new restore_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+ }
+
if (!$defaultvalue) {
// This is a bit hacky, but if there is no user data to restore, then
// we replace the standard check-box with a select menu with the
@@ -333,30 +379,34 @@ protected function define_settings() {
// It would probably be better design to have a special UI class
// setting_ui_checkbox_or_no, rather than this hack, but I am not
// going to do that today.
- $activity_userinfo->set_ui(new backup_setting_ui_select($activity_userinfo, '-',
- array(0 => get_string('no'))));
+ $activityuserinfo->set_ui(
+ new backup_setting_ui_select(
+ $activityuserinfo,
+ '-',
+ [0 => get_string('no')]
+ )
+ );
} else {
- $activity_userinfo->get_ui()->set_label('-');
+ $activityuserinfo->get_ui()->set_label('-');
}
- $this->add_setting($activity_userinfo);
+ $this->add_setting($activityuserinfo);
- // Look for "users" root setting
+ // Look for "users" root setting.
$users = $this->plan->get_setting('users');
- $users->add_dependency($activity_userinfo);
+ $users->add_dependency($activityuserinfo);
- // Look for "section_userinfo" section setting (if exists)
+ // Look for "sectionuserinfo" section setting (if exists).
$settingname = 'section_' . $this->info->sectionid . '_userinfo';
if ($this->plan->setting_exists($settingname)) {
- $section_userinfo = $this->plan->get_setting($settingname);
- $section_userinfo->add_dependency($activity_userinfo);
+ $sectionuserinfo = $this->plan->get_setting($settingname);
+ $sectionuserinfo->add_dependency($activityuserinfo);
}
- // Look for "activity_included" setting.
- $activity_included->add_dependency($activity_userinfo);
+ // Look for "activity included" setting.
+ $includefield->add_dependency($activityuserinfo);
- // End of common activity settings, let's add the particular ones.
- $this->define_my_settings();
+ return $activityuserinfo;
}
/**
diff --git a/backup/moodle2/restore_plan_builder.class.php b/backup/moodle2/restore_plan_builder.class.php
index 9246dc41c5a15..b5cb20d6d5e32 100644
--- a/backup/moodle2/restore_plan_builder.class.php
+++ b/backup/moodle2/restore_plan_builder.class.php
@@ -144,6 +144,9 @@ protected static function build_activity_plan($controller, $activityid) {
$plan->add_task($task);
$controller->get_progress()->progress();
+ // Some activities may have delegated section integrations.
+ self::build_delegated_section_plan($controller, $infoactivity->moduleid);
+
// For the given activity path, add as many block tasks as necessary
// TODO: Add blocks, we need to introspect xml here
$blocks = backup_general_helper::get_blocks_from_path($task->get_taskbasepath());
@@ -161,6 +164,30 @@ protected static function build_activity_plan($controller, $activityid) {
}
+ /**
+ * Build a course module delegated section backup plan.
+ * @param restore_controller $controller
+ * @param int $cmid the parent course module id.
+ */
+ protected static function build_delegated_section_plan($controller, $cmid) {
+ $info = $controller->get_info();
+
+ // Find if some section depends on that course module.
+ $delegatedsectionid = null;
+ foreach ($info->sections as $sectionid => $section) {
+ // Delegated sections are not course responsability.
+ if (isset($section->parentcmid) && $section->parentcmid == $cmid) {
+ $delegatedsectionid = $sectionid;
+ break;
+ }
+ }
+
+ if (!$delegatedsectionid) {
+ return;
+ }
+ self::build_section_plan($controller, $delegatedsectionid);
+ }
+
/**
* Restore one 1-section backup
*/
@@ -215,6 +242,10 @@ protected static function build_course_plan($controller, $courseid) {
// For the given course, add as many section tasks as necessary
foreach ($info->sections as $sectionid => $section) {
+ // Delegated sections are not course responsability.
+ if (isset($section->parentcmid) && !empty($section->parentcmid)) {
+ continue;
+ }
self::build_section_plan($controller, $sectionid);
}
}
diff --git a/backup/moodle2/restore_section_task.class.php b/backup/moodle2/restore_section_task.class.php
index 2913836a7b870..a9eb5730d3c83 100644
--- a/backup/moodle2/restore_section_task.class.php
+++ b/backup/moodle2/restore_section_task.class.php
@@ -56,6 +56,30 @@ public function get_taskbasepath() {
return $this->get_basepath() . '/sections/section_' . $this->info->sectionid;
}
+ /**
+ * Get the course module that is delegating this section.
+ *
+ * @return int|null the course module id that is delegating this section
+ */
+ public function get_delegated_cm(): ?int {
+ if (!isset($this->info->parentcmid) || empty($this->info->parentcmid)) {
+ return null;
+ }
+ return intval($this->info->parentcmid);
+ }
+
+ /**
+ * Get the delegated activity modname if any.
+ *
+ * @return string|null the modname of the delegated activity
+ */
+ public function get_modname(): ?string {
+ if (!isset($this->info->modname) || empty($this->info->modname)) {
+ return null;
+ }
+ return $this->info->modname;
+ }
+
public function set_sectionid($sectionid) {
$this->sectionid = $sectionid;
}
@@ -150,36 +174,95 @@ public static function define_decode_rules() {
* Define the common setting that any restore section will have
*/
protected function define_settings() {
-
// All the settings related to this activity will include this prefix
$settingprefix = 'section_' . $this->info->sectionid . '_';
- // All these are common settings to be shared by all sections
+ // All these are common settings to be shared by all sections.
+ $sectionincluded = $this->add_section_included_setting($settingprefix);
+ $this->add_section_userinfo_setting($settingprefix, $sectionincluded);
+ }
- // Define section_included (to decide if the whole task must be really executed)
+ /**
+ * Add the section included setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @return section_backup_setting the setting added
+ */
+ protected function add_section_included_setting(string $settingprefix): section_backup_setting {
+ global $DB;
+ // Define sectionincluded (to decide if the whole task must be really executed).
$settingname = $settingprefix . 'included';
- $section_included = new restore_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
- if (is_number($this->info->title)) {
- $label = get_string('includesection', 'backup', $this->info->title);
- } elseif (empty($this->info->title)) { // Don't throw error if title is empty, gracefully continue restore.
- $this->log('Section title missing in backup for section id '.$this->info->sectionid, backup::LOG_WARNING, $this->name);
- $label = get_string('unnamedsection', 'backup');
+
+ $delegatedcmid = $this->get_delegated_cm();
+ if ($delegatedcmid) {
+ $sectionincluded = new restore_subsection_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+ // Subsections depends on the parent activity included setting.
+ $settingname = $this->get_modname() . '_' . $delegatedcmid . '_included';
+ if ($this->plan->setting_exists($settingname)) {
+ $cmincluded = $this->plan->get_setting($settingname);
+ $cmincluded->add_dependency(
+ $sectionincluded,
+ );
+ }
+ $label = get_string('subsectioncontent', 'backup');
} else {
- $label = $this->info->title;
+ $sectionincluded = new restore_section_included_setting($settingname, base_setting::IS_BOOLEAN, true);
+
+ if (is_number($this->info->title)) {
+ $label = get_string('includesection', 'backup', $this->info->title);
+ } else if (empty($this->info->title)) { // Don't throw error if title is empty, gracefully continue restore.
+ $this->log(
+ 'Section title missing in backup for section id ' . $this->info->sectionid,
+ backup::LOG_WARNING,
+ $this->name
+ );
+ $label = get_string('unnamedsection', 'backup');
+ } else {
+ $label = $this->info->title;
+ }
}
- $section_included->get_ui()->set_label($label);
- $this->add_setting($section_included);
- // Define section_userinfo. Dependent of:
- // - users root setting
- // - section_included setting.
+ $sectionincluded->get_ui()->set_label($label);
+ $this->add_setting($sectionincluded);
+
+ return $sectionincluded;
+ }
+
+ /**
+ * Add the section userinfo setting to the task.
+ *
+ * @param string $settingprefix the identifier of the setting
+ * @param section_backup_setting $includefield the section included setting
+ * @return section_backup_setting the setting added
+ */
+ protected function add_section_userinfo_setting(
+ string $settingprefix,
+ section_backup_setting $includefield
+ ): section_backup_setting {
+ // Define sectionuserinfo. Dependent of:
+ // - users root setting.
+ // - sectionincluded setting.
$settingname = $settingprefix . 'userinfo';
$defaultvalue = false;
if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
$defaultvalue = true;
}
- $section_userinfo = new restore_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+ $delegatedcmid = $this->get_delegated_cm();
+ if ($delegatedcmid) {
+ $sectionuserinfo = new restore_subsection_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+ // Subsections depends on the parent activity included setting.
+ $settingname = $this->get_modname() . '_' . $delegatedcmid . '_userinfo';
+ if ($this->plan->setting_exists($settingname)) {
+ $cmincluded = $this->plan->get_setting($settingname);
+ $cmincluded->add_dependency(
+ $sectionuserinfo,
+ );
+ }
+ } else {
+ $sectionuserinfo = new restore_section_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
+ }
+
if (!$defaultvalue) {
// This is a bit hacky, but if there is no user data to restore, then
// we replace the standard check-box with a select menu with the
@@ -189,19 +272,23 @@ protected function define_settings() {
// It would probably be better design to have a special UI class
// setting_ui_checkbox_or_no, rather than this hack, but I am not
// going to do that today.
- $section_userinfo->set_ui(new backup_setting_ui_select($section_userinfo, get_string('includeuserinfo','backup'),
- array(0 => get_string('no'))));
+ $sectionuserinfo->set_ui(
+ new backup_setting_ui_select($sectionuserinfo,
+ get_string('includeuserinfo', 'backup'), [0 => get_string('no')])
+ );
} else {
- $section_userinfo->get_ui()->set_label(get_string('includeuserinfo','backup'));
+ $sectionuserinfo->get_ui()->set_label(get_string('includeuserinfo', 'backup'));
}
- $this->add_setting($section_userinfo);
+ $this->add_setting($sectionuserinfo);
// Look for "users" root setting.
$users = $this->plan->get_setting('users');
- $users->add_dependency($section_userinfo);
+ $users->add_dependency($sectionuserinfo);
+
+ // Look for "section included" section setting.
+ $includefield->add_dependency($sectionuserinfo);
- // Look for "section_included" section setting.
- $section_included->add_dependency($section_userinfo);
+ return $sectionuserinfo;
}
}
diff --git a/backup/moodle2/restore_settingslib.php b/backup/moodle2/restore_settingslib.php
index cce77a98dece4..f62a7e433c7af 100644
--- a/backup/moodle2/restore_settingslib.php
+++ b/backup/moodle2/restore_settingslib.php
@@ -222,6 +222,39 @@ class restore_section_included_setting extends restore_section_generic_setting {
*/
class restore_section_userinfo_setting extends restore_section_generic_setting {}
+/**
+ * Subsection base class (delegated section).
+ */
+class restore_subsection_generic_setting extends restore_section_generic_setting {
+ /**
+ * Class constructor.
+ *
+ * @param string $name Name of the setting
+ * @param string $vtype Type of the setting, for example base_setting::IS_TEXT
+ * @param mixed $value Value of the setting
+ * @param bool $visibility Is the setting visible in the UI, for example base_setting::VISIBLE
+ * @param int $status Status of the setting with regards to the locking, for example base_setting::NOT_LOCKED
+ */
+ public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
+ parent::__construct($name, $vtype, $value, $visibility, $status);
+ $this->level = self::SUBSECTION_LEVEL;
+ }
+}
+
+/**
+ * Setting to define if one subsection is included or no.
+ *
+ * Activities _included settings depend of them if available.
+ */
+class restore_subsection_included_setting extends restore_subsection_generic_setting {
+}
+
+/**
+ * Subsection backup setting to control if section will include
+ * user information or no, depends of @restore_users_setting.
+ */
+class restore_subsection_userinfo_setting extends restore_subsection_generic_setting {
+}
// Activity backup settings
@@ -243,6 +276,41 @@ class restore_activity_included_setting extends restore_activity_generic_setting
*/
class restore_activity_userinfo_setting extends restore_activity_generic_setting {}
+/**
+ * Generic subactivity setting to pass various settings between tasks and steps
+ */
+class restore_subactivity_generic_setting extends restore_activity_generic_setting {
+ /**
+ * Class constructor.
+ *
+ * @param string $name Name of the setting
+ * @param string $vtype Type of the setting, for example base_setting::IS_TEXT
+ * @param mixed $value Value of the setting
+ * @param bool $visibility Is the setting visible in the UI, for example base_setting::VISIBLE
+ * @param int $status Status of the setting with regards to the locking, for example base_setting::NOT_LOCKED
+ */
+ public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
+ parent::__construct($name, $vtype, $value, $visibility, $status);
+ $this->level = self::SUBACTIVITY_LEVEL;
+ }
+}
+
+/**
+ * Subactivity backup setting to control if activity will be included or no.
+ *
+ * Depends of restore_activities_setting and optionally parent section included setting.
+ */
+class restore_subactivity_included_setting extends restore_subactivity_generic_setting {
+}
+
+/**
+ * Subactivity backup setting to control if activity will include user information.
+ *
+ * Depends of restore_users_setting.
+ */
+class restore_subactivity_userinfo_setting extends restore_subactivity_generic_setting {
+}
+
/**
* root setting to control if restore will create content bank content or no
*/
diff --git a/backup/moodle2/restore_stepslib.php b/backup/moodle2/restore_stepslib.php
index 22015c8200539..98cac314e7335 100644
--- a/backup/moodle2/restore_stepslib.php
+++ b/backup/moodle2/restore_stepslib.php
@@ -1612,8 +1612,28 @@ public function process_section($data) {
$section->course = $this->get_courseid();
$section->section = $data->number;
$section->timemodified = $data->timemodified ?? 0;
+ $section->component = null;
+ $section->itemid = null;
+
+ $secrec = $DB->get_record(
+ 'course_sections',
+ ['course' => $this->get_courseid(), 'section' => $data->number, 'component' => null]
+ );
+ $createsection = empty($secrec);
+
+ // Delegated sections are always restored as new sections.
+ if (!empty($data->component)) {
+ $section->itemid = $this->get_delegated_section_mapping($data->component, $data->itemid);
+ // If the delegate component does not set the mapping id, the section must be converted
+ // into a regular section. Otherwise, it won't be accessible.
+ $createsection = $createsection || $section->itemid !== null;
+ $section->component = ($section->itemid !== null) ? $data->component : null;
+ // The section number will be always the last of the course, no matter the case.
+ $section->section = $this->get_last_section_number($this->get_courseid()) + 1;
+
+ }
// Section doesn't exist, create it with all the info from backup
- if (!$secrec = $DB->get_record('course_sections', ['course' => $this->get_courseid(), 'section' => $data->number])) {
+ if ($createsection) {
$section->name = $data->name;
$section->summary = $data->summary;
$section->summaryformat = $data->summaryformat;
@@ -1629,8 +1649,10 @@ public function process_section($data) {
$data, true);
}
}
- $section->component = $data->component ?? null;
- $section->itemid = $data->itemid ?? null;
+
+ // Delegated sections should be always after the normal sections.
+ $this->displace_delegated_sections_after($section->section);
+
$newitemid = $DB->insert_record('course_sections', $section);
$section->id = $newitemid;
@@ -1802,6 +1824,57 @@ protected function after_execute() {
// Add section related files, with 'course_section' itemid to match
$this->add_related_files('course', 'section', 'course_section');
}
+
+ /**
+ * Create a delegate section mapping.
+ *
+ * @param string $component the component name (frankenstyle)
+ * @param int $oldsectionid The old section id.
+ * @return int|null The new section id or null if not found.
+ */
+ protected function get_delegated_section_mapping($component, $oldsectionid): ?int {
+ $result = $this->get_mappingid("course_section::$component", $oldsectionid, null);
+ return $result;
+ }
+
+ /**
+ * Displace delegated sections after the given section number.
+ *
+ * @param int $sectionnum The section number.
+ */
+ protected function displace_delegated_sections_after(int $sectionnum): void {
+ global $DB;
+
+ $sectionstomove = $DB->get_records_select(
+ 'course_sections',
+ 'course = ? AND component IS NOT NULL',
+ [$this->get_courseid()],
+ 'section DESC', 'id, section'
+ );
+ foreach ($sectionstomove as $section) {
+ $sectionnum++;
+ $section->section = $sectionnum;
+ $DB->update_record('course_sections', $section);
+ }
+ }
+
+ /**
+ * Get the last section number in the course.
+ *
+ * @param int $courseid The course id.
+ * @param bool $includedelegated If true, include delegated sections in the count.
+ * @return int The last section number.
+ */
+ protected function get_last_section_number(int $courseid, bool $includedelegated = false): int {
+ global $DB;
+
+ $delegtadefilter = $includedelegated ? '' : ' AND component IS NULL';
+
+ return (int) $DB->get_field_sql(
+ 'SELECT max(section) from {course_sections} WHERE course = ?' . $delegtadefilter,
+ [$courseid]
+ );
+ }
}
/**
@@ -4905,6 +4978,17 @@ protected function apply_activity_instance($newitemid) {
$oldid = $this->task->get_old_activityid();
$this->set_mapping($modulename, $oldid, $newitemid, true);
}
+
+ /**
+ * Create a delegate section mapping.
+ *
+ * @param string $component The component name (frankenstyle)
+ * @param int $olditemid The old section id.
+ * @param int $newitemid The new section id.
+ */
+ protected function set_delegated_section_mapping($component, $olditemid, $newitemid) {
+ $this->set_mapping("course_section::$component", $olditemid, $newitemid);
+ }
}
/**
diff --git a/backup/moodle2/tests/restore_stepslib_date_test.php b/backup/moodle2/tests/restore_stepslib_date_test.php
index 1505a3fdcd557..2655f3686f366 100644
--- a/backup/moodle2/tests/restore_stepslib_date_test.php
+++ b/backup/moodle2/tests/restore_stepslib_date_test.php
@@ -320,7 +320,8 @@ public function test_usercompletion_date_restore(): void {
/**
* Checking that the user completion of an activity relating to the view field does not change
* when doing a course restore.
- * @covers ::backup_and_restore
+ * @covers \backup_userscompletion_structure_step
+ * @covers \restore_userscompletion_structure_step
*/
public function test_usercompletion_view_restore(): void {
global $DB;
diff --git a/backup/moodle2/tests/restore_stepslib_test.php b/backup/moodle2/tests/restore_stepslib_test.php
index 6a8eb5e162fa9..d5a2685823c5f 100644
--- a/backup/moodle2/tests/restore_stepslib_test.php
+++ b/backup/moodle2/tests/restore_stepslib_test.php
@@ -103,7 +103,7 @@ protected function restore_replacing_content(string $backupid): int {
}
/**
- * Test for the section structure step included elements.
+ * Test for delegate section behaviour.
*
* @covers \restore_section_structure_step::process_section
*/
@@ -114,7 +114,7 @@ public function test_restore_section_structure_step(): void {
$this->setAdminUser();
$course = $this->getDataGenerator()->create_course(['numsections' => 2, 'format' => 'topics']);
- // Section 2 has an existing delegate class.
+ // Section 2 has an existing delegate class for component that is not an activity.
course_update_section(
$course,
$DB->get_record('course_sections', ['course' => $course->id, 'section' => 2]),
@@ -130,16 +130,18 @@ public function test_restore_section_structure_step(): void {
$originalsections = get_fast_modinfo($course->id)->get_section_info_all();
$restoredsections = get_fast_modinfo($newcourseid)->get_section_info_all();
- $this->assertEquals(count($originalsections), count($restoredsections));
+ // Delegated sections depends on the plugin to be backuped and restored.
+ // In this case, the plugin is not backuped and restored, so the section is not restored.
+ $this->assertEquals(3, count($originalsections));
+ $this->assertEquals(2, count($restoredsections));
$validatefields = ['name', 'summary', 'summaryformat', 'visible', 'component', 'itemid'];
$this->assertEquals($originalsections[1]->name, $restoredsections[1]->name);
foreach ($validatefields as $field) {
+ $this->assertEquals($originalsections[0]->$field, $restoredsections[0]->$field);
$this->assertEquals($originalsections[1]->$field, $restoredsections[1]->$field);
- $this->assertEquals($originalsections[2]->$field, $restoredsections[2]->$field);
}
-
}
}
diff --git a/backup/util/dbops/backup_controller_dbops.class.php b/backup/util/dbops/backup_controller_dbops.class.php
index 2bc367fd47614..f022b76b70da7 100644
--- a/backup/util/dbops/backup_controller_dbops.class.php
+++ b/backup/util/dbops/backup_controller_dbops.class.php
@@ -234,7 +234,9 @@ private static function get_activity_backup_information($task) {
'sectionid' => $task->get_sectionid(),
'modulename' => $task->get_modulename(),
'title' => $task->get_name(),
- 'directory' => 'activities/' . $task->get_modulename() . '_' . $task->get_moduleid());
+ 'directory' => 'activities/' . $task->get_modulename() . '_' . $task->get_moduleid(),
+ 'insubsection' => ($task->is_in_subsection()) ? 1 : '',
+ );
// Now get activity settings
// Calculate prefix to find valid settings
@@ -246,7 +248,7 @@ private static function get_activity_backup_information($task) {
continue;
}
// Validate level is correct (activity)
- if ($setting->get_level() != backup_setting::ACTIVITY_LEVEL) {
+ if (!in_array($setting->get_level(), [backup_setting::ACTIVITY_LEVEL, backup_setting::SUBACTIVITY_LEVEL])) {
throw new backup_controller_exception('setting_not_activity_level', $setting);
}
$settinginfo = array(
@@ -268,7 +270,10 @@ private static function get_section_backup_information($task) {
$contentinfo = array(
'sectionid' => $task->get_sectionid(),
'title' => $task->get_name(),
- 'directory' => 'sections/' . 'section_' . $task->get_sectionid());
+ 'directory' => 'sections/' . 'section_' . $task->get_sectionid(),
+ 'parentcmid' => $task->get_delegated_cm() ?? '',
+ 'modname' => $task->get_modname() ?? '',
+ );
// Now get section settings
// Calculate prefix to find valid settings
@@ -280,7 +285,7 @@ private static function get_section_backup_information($task) {
continue;
}
// Validate level is correct (section)
- if ($setting->get_level() != backup_setting::SECTION_LEVEL) {
+ if (!in_array($setting->get_level(), [backup_setting::SECTION_LEVEL, backup_setting::SUBSECTION_LEVEL])) {
throw new backup_controller_exception('setting_not_section_level', $setting);
}
$settinginfo = array(
diff --git a/backup/util/dbops/backup_plan_dbops.class.php b/backup/util/dbops/backup_plan_dbops.class.php
index d3a650bf91ef8..4dae3e5d56370 100644
--- a/backup/util/dbops/backup_plan_dbops.class.php
+++ b/backup/util/dbops/backup_plan_dbops.class.php
@@ -77,7 +77,6 @@ public static function get_modules_from_sectionid($sectionid) {
// Get the course and sequence of the section
$secrec = $DB->get_record('course_sections', array('id' => $sectionid), 'course, sequence');
$courseid = $secrec->course;
- $sequence = $secrec->sequence;
// Get the section->sequence contents (it roots the activities order)
// Get all course modules belonging to requested section
@@ -89,7 +88,7 @@ public static function get_modules_from_sectionid($sectionid) {
WHERE cm.course = ?
AND cm.section = ?
AND cm.deletioninprogress <> 1", array($courseid, $sectionid));
- foreach (explode(',', $sequence) as $moduleid) {
+ foreach (explode(',', (string) $secrec->sequence) as $moduleid) {
if (isset($modules[$moduleid])) {
$module = array('id' => $modules[$moduleid]->id, 'modname' => $modules[$moduleid]->modname);
$modulesarr[] = (object)$module;
@@ -120,6 +119,17 @@ public static function get_sections_from_courseid($courseid) {
return $sectionsarr;
}
+ /**
+ * Given one section id, returns the full section record.
+ *
+ * @param int $sectionid
+ * @return stdClass
+ */
+ public static function get_section_from_id($sectionid): stdClass {
+ global $DB;
+ return $DB->get_record('course_sections', ['id' => $sectionid]);
+ }
+
/**
* Given one course id, return its format in DB
*/
diff --git a/backup/util/plan/base_task.class.php b/backup/util/plan/base_task.class.php
index 37d001e1a7835..148c0bbe88308 100644
--- a/backup/util/plan/base_task.class.php
+++ b/backup/util/plan/base_task.class.php
@@ -103,7 +103,20 @@ public function get_setting($name) {
}
}
+ /**
+ * Check if a setting with the given name exists.
+ *
+ * This method find first in the current settings and then in the plan settings.
+ *
+ * @param string $name Setting name
+ * @return bool
+ */
public function setting_exists($name) {
+ foreach ($this->settings as $setting) {
+ if ($setting->get_name() == $name) {
+ return true;
+ }
+ }
return $this->plan->setting_exists($name);
}
diff --git a/backup/util/settings/backup_setting.class.php b/backup/util/settings/backup_setting.class.php
index d32fdc36566d1..7856dd4677410 100644
--- a/backup/util/settings/backup_setting.class.php
+++ b/backup/util/settings/backup_setting.class.php
@@ -37,6 +37,12 @@ abstract class backup_setting extends base_setting implements checksumable {
const SECTION_LEVEL = 9;
const ACTIVITY_LEVEL = 13;
+ /** @var int the subsection level. */
+ const SUBSECTION_LEVEL = 17;
+
+ /** @var int the activity inside a subsection level. */
+ const SUBACTIVITY_LEVEL = 21;
+
/** @var int Level of the setting, eg {@link self::ROOT_LEVEL} */
protected $level;
@@ -96,7 +102,12 @@ public function add_dependency(base_setting $dependentsetting, $type=setting_dep
}
// Check the dependency level is >= current level
if ($dependentsetting->get_level() < $this->level) {
- throw new backup_setting_exception('cannot_add_upper_level_dependency');
+ throw new backup_setting_exception('cannot_add_upper_level_dependency', [
+ $dependentsetting->get_level(),
+ $dependentsetting->get_name(),
+ $this->level,
+ $this->get_name(),
+ ]);
}
parent::add_dependency($dependentsetting, $type, $options);
}
diff --git a/backup/util/ui/UPGRADING.md b/backup/util/ui/UPGRADING.md
new file mode 100644
index 0000000000000..1bbf593c80546
--- /dev/null
+++ b/backup/util/ui/UPGRADING.md
@@ -0,0 +1,10 @@
+# core_backup (subsystem) Upgrade notes
+
+## 4.5dev
+
+### Removed
+
+- Final deprecation and removal of core_backup\copy\copy in backup/util/ui/classes/copy.php. Please use copy_helper from backup/util/helper/copy_helper.class.php instead.
+
+ For more information see [MDL-75022](https://tracker.moodle.org/browse/MDL-75022)
+
diff --git a/backup/util/ui/backup_ui_setting.class.php b/backup/util/ui/backup_ui_setting.class.php
index c1f248ff471b5..ed82227e23c8e 100644
--- a/backup/util/ui/backup_ui_setting.class.php
+++ b/backup/util/ui/backup_ui_setting.class.php
@@ -256,9 +256,11 @@ public function __construct(backup_setting $setting, $label = null, array $attri
$this->name = 'course_'.$setting->get_name();
break;
case backup_setting::SECTION_LEVEL :
+ case backup_setting::SUBSECTION_LEVEL:
$this->name = 'section_'.$setting->get_name();
break;
case backup_setting::ACTIVITY_LEVEL :
+ case backup_setting::SUBACTIVITY_LEVEL:
$this->name = 'activity_'.$setting->get_name();
break;
}
@@ -329,9 +331,10 @@ public function get_label(base_task $task = null) {
// If a task has been provided and the label is not already set meaningfully
// we will attempt to improve it.
if (!is_null($task) && $this->label == $this->setting->get_name() && strpos($this->setting->get_name(), '_include') !== false) {
- if ($this->setting->get_level() == backup_setting::SECTION_LEVEL) {
+ $level = $this->setting->get_level();
+ if ($level == backup_setting::SECTION_LEVEL || $level == backup_setting::SUBSECTION_LEVEL) {
$this->label = get_string('includesection', 'backup', $task->get_name());
- } else if ($this->setting->get_level() == backup_setting::ACTIVITY_LEVEL) {
+ } else if ($level == backup_setting::ACTIVITY_LEVEL || $level == backup_setting::SUBACTIVITY_LEVEL) {
$this->label = $task->get_name();
}
}
diff --git a/backup/util/ui/base_moodleform.class.php b/backup/util/ui/base_moodleform.class.php
index 88925ce8cdc8e..f4a0ed5cebd9b 100644
--- a/backup/util/ui/base_moodleform.class.php
+++ b/backup/util/ui/base_moodleform.class.php
@@ -48,22 +48,10 @@ abstract class base_moodleform extends moodleform {
protected $uistage = null;
/**
- * True if we have a course div open, false otherwise
- * @var bool
+ * Group stack to control open and closed div groups.
+ * @var array
*/
- protected $coursediv = false;
-
- /**
- * True if we have a section div open, false otherwise
- * @var bool
- */
- protected $sectiondiv = false;
-
- /**
- * True if we have an activity div open, false otherwise
- * @var bool
- */
- protected $activitydiv = false;
+ protected array $groupstack = [];
/**
* Creates the form
@@ -177,20 +165,12 @@ public function definition_after_data() {
}
/**
- * Closes any open divs
+ * Closes any open divs.
*/
public function close_task_divs() {
- if ($this->activitydiv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- $this->activitydiv = false;
- }
- if ($this->sectiondiv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- $this->sectiondiv = false;
- }
- if ($this->coursediv) {
+ while (!empty($this->groupstack)) {
$this->_form->addElement('html', html_writer::end_tag('div'));
- $this->coursediv = false;
+ array_pop($this->groupstack);
}
}
@@ -244,7 +224,7 @@ public function add_settings(array $settingstasks) {
list($identifier, $component) = $setting->get_help();
$this->_form->addHelpButton($setting->get_ui_name(), $identifier, $component);
}
- $this->_form->addElement('html', html_writer::end_tag('div'));
+ $this->pop_group();
}
$this->_form->setDefaults($defaults);
return true;
@@ -265,54 +245,42 @@ public function add_heading($name , $text) {
* @param backup_setting $setting
*/
protected function add_html_formatting(backup_setting $setting) {
- $mform = $this->_form;
$isincludesetting = (strpos($setting->get_name(), '_include') !== false);
if ($isincludesetting && $setting->get_level() != backup_setting::ROOT_LEVEL) {
switch ($setting->get_level()) {
case backup_setting::COURSE_LEVEL:
- if ($this->activitydiv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- $this->activitydiv = false;
- }
- if ($this->sectiondiv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- $this->sectiondiv = false;
- }
- if ($this->coursediv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- }
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'grouped_settings course_level')));
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'include_setting course_level')));
- $this->coursediv = true;
+ $this->pop_groups_to('course');
+ $this->push_group_start('course', 'grouped_settings course_level');
+ $this->push_group_start(null, 'include_setting course_level');
break;
case backup_setting::SECTION_LEVEL:
- if ($this->activitydiv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- $this->activitydiv = false;
- }
- if ($this->sectiondiv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- }
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'grouped_settings section_level')));
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'include_setting section_level')));
- $this->sectiondiv = true;
+ $this->pop_groups_to('course');
+ $this->push_group_start('section', 'grouped_settings section_level');
+ $this->push_group_start(null, 'include_setting section_level');
break;
case backup_setting::ACTIVITY_LEVEL:
- if ($this->activitydiv) {
- $this->_form->addElement('html', html_writer::end_tag('div'));
- }
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'grouped_settings activity_level')));
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'include_setting activity_level')));
- $this->activitydiv = true;
+ $this->pop_groups_to('section');
+ $this->push_group_start('activity', 'grouped_settings activity_level');
+ $this->push_group_start(null, 'include_setting activity_level');
+ break;
+ case backup_setting::SUBSECTION_LEVEL:
+ $this->pop_groups_to('section');
+ $this->push_group_start('subsection', 'grouped_settings subsection_level');
+ $this->push_group_start(null, 'normal_setting');
+ break;
+ case backup_setting::SUBACTIVITY_LEVEL:
+ $this->pop_groups_to('subsection');
+ $this->push_group_start('subactivity', 'grouped_settings activity_level');
+ $this->push_group_start(null, 'include_setting activity_level');
break;
default:
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'normal_setting')));
+ $this->push_group_start(null, 'normal_setting');
break;
}
} else if ($setting->get_level() == backup_setting::ROOT_LEVEL) {
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'root_setting')));
+ $this->push_group_start('root', 'root_setting');
} else {
- $mform->addElement('html', html_writer::start_tag('div', array('class' => 'normal_setting')));
+ $this->push_group_start(null, 'normal_setting');
}
}
@@ -350,12 +318,55 @@ public function add_fixed_setting(backup_setting $setting, base_task $task) {
$label .= $OUTPUT->render($labelicon);
}
$this->_form->addElement('static', 'static_'.$settingui->get_name(), $label, $settingui->get_static_value().$icon);
- $this->_form->addElement('html', html_writer::end_tag('div'));
+ $this->pop_group();
}
$this->_form->addElement('hidden', $settingui->get_name(), $settingui->get_value());
$this->_form->setType($settingui->get_name(), $settingui->get_param_validation());
}
+ /**
+ * Pushes a group start to the form.
+ *
+ * This method will create a new group div in the form and add it to the group stack.
+ * The name can be used to close all stacked groups up to a certain group.
+ *
+ * @param string|null $name The name of the group, if any.
+ * @param string $classes The classes to add to the div.
+ */
+ protected function push_group_start(?string $name, string $classes) {
+ $mform = $this->_form;
+ $this->groupstack[] = $name;
+ $mform->addElement('html', html_writer::start_tag('div', ['class' => $classes]));
+ }
+
+ /**
+ * Pops groups from the stack until the given group name is reached.
+ *
+ * @param string $name The name of the group to pop to.
+ */
+ protected function pop_groups_to(string $name) {
+ if (empty($this->groupstack)) {
+ return;
+ }
+ while (!empty($this->groupstack) && end($this->groupstack) !== $name) {
+ $this->pop_group();
+ }
+ }
+
+ /**
+ * Pops a group from the stack and closes the div.
+ *
+ * @return string|null The name of the group that was popped, or null if the stack is empty.
+ */
+ protected function pop_group(): ?string {
+ if (empty($this->groupstack)) {
+ return null;
+ }
+ $mform = $this->_form;
+ $mform->addElement('html', html_writer::end_tag('div'));
+ return array_pop($this->groupstack);
+ }
+
/**
* Adds dependencies to the form recursively
*
diff --git a/backup/util/ui/classes/copy/copy.php b/backup/util/ui/classes/copy/copy.php
deleted file mode 100644
index 7adddafc01ed1..0000000000000
--- a/backup/util/ui/classes/copy/copy.php
+++ /dev/null
@@ -1,170 +0,0 @@
-.
-
-/**
- * Course copy class.
- *
- * Handles procesing data submitted by UI copy form
- * and sets up the course copy process.
- *
- * @package core_backup
- * @copyright 2020 onward The Moodle Users Association
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @deprecated since Moodle 4.1. Use copy_helper instead
- */
-
-namespace core_backup\copy;
-
-defined('MOODLE_INTERNAL') || die;
-
-global $CFG;
-require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
-require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
-
-/**
- * Course copy class.
- *
- * Handles procesing data submitted by UI copy form
- * and sets up the course copy process.
- *
- * @package core_backup
- * @copyright 2020 onward The Moodle Users Association
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @deprecated since Moodle 4.1 MDL-74548 - please use copy_helper instead
- * @todo MDL-75022 This class will be deleted in Moodle 4.5
- * @see copy_helper
- */
-class copy {
-
- /**
- * The fields required for copy operations.
- *
- * @var array
- */
- private $copyfields = array(
- 'courseid', // Course id integer.
- 'fullname', // Fullname of the destination course.
- 'shortname', // Shortname of the destination course.
- 'category', // Category integer ID that contains the destination course.
- 'visible', // Integer to detrmine of the copied course will be visible.
- 'startdate', // Integer timestamp of the start of the destination course.
- 'enddate', // Integer timestamp of the end of the destination course.
- 'idnumber', // ID of the destination course.
- 'userdata', // Integer to determine if the copied course will contain user data.
- );
-
- /**
- * Data required for course copy operations.
- *
- * @var array
- */
- private $copydata = array();
-
- /**
- * List of role ids to keep enrolments for in the destination course.
- *
- * @var array
- */
- private $roles = array();
-
- /**
- * Constructor for the class.
- *
- * @param \stdClass $formdata Data from the validated course copy form.
- */
- public function __construct(\stdClass $formdata) {
- debugging('Class \course_backup\copy\copy is deprecated. Please use the copy_helper class instead.');
- $this->copydata = $this->get_copy_data($formdata);
- $this->roles = $this->get_enrollment_roles($formdata);
- }
-
- /**
- * Extract the enrolment roles to keep in the copied course
- * from the raw submitted form data.
- *
- * @param \stdClass $formdata Data from the validated course copy form.
- * @return array $keptroles The roles to keep.
- */
- private function get_enrollment_roles(\stdClass $formdata): array {
- $keptroles = array();
-
- foreach ($formdata as $key => $value) {
- if ((substr($key, 0, 5 ) === 'role_') && ($value != 0)) {
- $keptroles[] = $value;
- }
- }
-
- return $keptroles;
- }
-
- /**
- * Take the validated form data and extract the required information for copy operations.
- *
- * @param \stdClass $formdata Data from the validated course copy form.
- * @return \stdClass $copydata Data required for course copy operations.
- * @throws \moodle_exception If one of the required copy fields is missing
- */
- private function get_copy_data(\stdClass $formdata): \stdClass {
- $copydata = new \stdClass();
-
- foreach ($this->copyfields as $field) {
- if (isset($formdata->{$field})) {
- $copydata->{$field} = $formdata->{$field};
- } else {
- throw new \moodle_exception('copyfieldnotfound', 'backup', '', null, $field);
- }
- }
-
- return $copydata;
- }
-
- /**
- * Creates a course copy.
- * Sets up relevant controllers and adhoc task.
- *
- * @return array $copyids THe backup and restore controller ids.
- * @deprecated since Moodle 4.1 MDL-74548 - please use copy_helper instead.
- * @todo MDL-75023 This method will be deleted in Moodle 4.5
- * @see copy_helper::process_formdata()
- * @see copy_helper::create_copy()
- */
- public function create_copy(): array {
- debugging('The method \core_backup\copy\copy::create_copy() is deprecated.
- Please use the methods provided by copy_helper instead.', DEBUG_DEVELOPER);
- $copydata = clone($this->copydata);
- $copydata->keptroles = $this->roles;
- return \copy_helper::create_copy($copydata);
- }
-
- /**
- * Get the in progress course copy operations for a user.
- *
- * @param int $userid User id to get the course copies for.
- * @param int $courseid The optional source course id to get copies for.
- * @return array $copies Details of the inprogress copies.
- * @deprecated since Moodle 4.1 MDL-74548 - please use copy_helper::get_copies() instead.
- * @todo MDL-75024 This method will be deleted in Moodle 4.5
- * @see copy_helper::get_copies()
- */
- public static function get_copies(int $userid, int $courseid=0): array {
- debugging('The method \core_backup\copy\copy::get_copies() is deprecated.
- Please use copy_helper::get_copies() instead.', DEBUG_DEVELOPER);
-
- return \copy_helper::get_copies($userid, $coursied);
- }
-}
diff --git a/backup/util/ui/renderer.php b/backup/util/ui/renderer.php
index df14d273b7d1c..87c137a757a10 100644
--- a/backup/util/ui/renderer.php
+++ b/backup/util/ui/renderer.php
@@ -203,7 +203,7 @@ public function backup_details($details, $nextstageurl) {
$table->data = array();
}
$name = get_string('pluginname', $activity->modulename);
- $icon = new image_icon('monologo', '', $activity->modulename, ['class' => 'iconlarge icon-pre']);
+ $icon = new image_icon('monologo', '', $activity->modulename);
$table->data[] = array(
$this->output->render($icon).$name,
$activity->title,
@@ -522,7 +522,7 @@ public function precheck_notices($results) {
public function substage_buttons($haserrors) {
$output = html_writer::start_tag('div', array('continuebutton'));
if (!$haserrors) {
- $attrs = array('type' => 'submit', 'value' => get_string('continue'), 'class' => 'btn btn-primary');
+ $attrs = ['type' => 'submit', 'value' => get_string('continue'), 'class' => 'btn btn-primary mr-1'];
$output .= html_writer::empty_tag('input', $attrs);
}
$attrs = array('type' => 'submit', 'name' => 'cancel', 'value' => get_string('cancel'), 'class' => 'btn btn-secondary');
diff --git a/badges/criteria/award_criteria_courseset.php b/badges/criteria/award_criteria_courseset.php
index b798842356bc3..68e26b40d82a0 100644
--- a/badges/criteria/award_criteria_courseset.php
+++ b/badges/criteria/award_criteria_courseset.php
@@ -197,6 +197,7 @@ public function get_options(&$mform) {
* @return bool Whether criteria is complete
*/
public function review($userid, $filtered = false) {
+ $overall = false;
foreach ($this->params as $param) {
$course = new stdClass();
$course->id = $param['course'];
diff --git a/badges/overview.php b/badges/overview.php
index dbf814fc7788e..87ea1d76948ee 100644
--- a/badges/overview.php
+++ b/badges/overview.php
@@ -75,7 +75,7 @@
if ($awards == 'cron') {
echo $OUTPUT->notification(get_string('awardoncron', 'badges'), 'notifysuccess');
-} else if ($awards != 0) {
+} else if ((int)$awards > 0) {
echo $OUTPUT->notification(get_string('numawardstat', 'badges', $awards), 'notifysuccess');
}
echo $output->print_badge_status_box($badge);
diff --git a/badges/renderer.php b/badges/renderer.php
index 2651c02cf8208..8740f66f0f350 100644
--- a/badges/renderer.php
+++ b/badges/renderer.php
@@ -783,13 +783,13 @@ protected function helper_sortable_heading($text, $sortid = null, $sortby = null
$url = new moodle_url($this->page->url);
$url->params(array('sort' => $sortid, 'dir' => 'ASC'));
$out .= $this->output->action_icon($url,
- new pix_icon('t/sort_asc', get_string('sortbyx', 'core', s($text)), null, array('class' => 'iconsort')));
+ new pix_icon('t/sort_asc', get_string('sortbyx', 'core', s($text)), null));
}
if ($sortby !== $sortid || $sorthow !== 'DESC') {
$url = new moodle_url($this->page->url);
$url->params(array('sort' => $sortid, 'dir' => 'DESC'));
$out .= $this->output->action_icon($url,
- new pix_icon('t/sort_desc', get_string('sortbyxreverse', 'core', s($text)), null, array('class' => 'iconsort')));
+ new pix_icon('t/sort_desc', get_string('sortbyxreverse', 'core', s($text)), null));
}
}
return $out;
diff --git a/badges/templates/award_badge.mustache b/badges/templates/award_badge.mustache
index 0aadf5b802120..ea88840962209 100644
--- a/badges/templates/award_badge.mustache
+++ b/badges/templates/award_badge.mustache
@@ -48,7 +48,7 @@
"url": "http://example.org/help",
"linktext": "",
"icon":{
- "extraclasses": "iconhelp",
+ "extraclasses": "",
"attributes": [
{"name": "src", "value": "../../../pix/help.svg"},
{"name": "alt", "value": "Help icon"}
diff --git a/badges/templates/manage_badge.mustache b/badges/templates/manage_badge.mustache
index 1974521f7cf66..9a5fd160c2862 100644
--- a/badges/templates/manage_badge.mustache
+++ b/badges/templates/manage_badge.mustache
@@ -47,7 +47,7 @@
"url": "http://example.org/help",
"linktext": "",
"icon":{
- "extraclasses": "iconhelp",
+ "extraclasses": "",
"attributes": [
{"name": "src", "value": "../../../pix/help.svg"},
{"name": "alt", "value": "Help icon"}
diff --git a/badges/tests/badgeslib_test.php b/badges/tests/badgeslib_test.php
index 9214ffaefb24c..834c026fa5c67 100644
--- a/badges/tests/badgeslib_test.php
+++ b/badges/tests/badgeslib_test.php
@@ -758,6 +758,66 @@ public function test_badges_observer_any_cohort_criteria_review(): void {
$this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().
}
+ /**
+ * Test badges observer when user_updated event is fired.
+ * @covers \award_criteria_courseset
+ */
+ public function test_badges_observer_courseset_criteria_review(): void {
+ $this->preventResetByRollback(); // Messaging is not compatible with transactions.
+ $badge = new badge($this->coursebadge);
+ $this->assertFalse($badge->is_issued($this->user->id));
+
+ $additionalcourse = $this->getDataGenerator()->create_course(['enablecompletion' => true]);
+ $this->getDataGenerator()->enrol_user($this->user->id, $additionalcourse->id);
+
+ $criteriaoverall = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id]);
+ $criteriaoverall->save(['agg' => BADGE_CRITERIA_AGGREGATION_ANY]);
+ $criteriaoverall1 = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_COURSESET, 'badgeid' => $badge->id]);
+ $criteriaoverall1->save(['agg' => BADGE_CRITERIA_AGGREGATION_ANY, 'course_' . $this->course->id => $this->course->id,
+ 'course_' . $additionalcourse->id => $additionalcourse->id]);
+
+ $ccompletion = new completion_completion(['course' => $this->course->id, 'userid' => $this->user->id]);
+ $ccompletion2 = new completion_completion(['course' => $additionalcourse->id, 'userid' => $this->user->id]);
+ // Assert the badge will not be issued to the user as is.
+ $badge = new badge($this->coursebadge);
+ $badge->review_all_criteria();
+ $this->assertFalse($badge->is_issued($this->user->id));
+
+ // Mark course as complete.
+ $sink = $this->redirectMessages();
+ $ccompletion->mark_complete();
+ $ccompletion2->mark_complete();
+ // Thee messages are generated: Two for the course completed and the other one for the badge awarded.
+ $messages = $sink->get_messages();
+ $this->assertCount(3, $messages);
+ $this->assertEquals('badgerecipientnotice', $messages[0]->eventtype);
+ $this->assertEquals('coursecompleted', $messages[1]->eventtype);
+ $sink->close();
+
+ // Check if badge is awarded.
+ $this->assertDebuggingCalled('Error baking badge image!');
+ $this->assertTrue($badge->is_issued($this->user->id));
+ }
+
+ /**
+ * Test the criteria review method for courseset
+ * @covers \award_criteria_courseset::review
+ */
+ public function test_badges_courseset_criteria_review_empty_courseset(): void {
+ $this->preventResetByRollback(); // Messaging is not compatible with transactions.
+ $badge = new badge($this->coursebadge);
+ $this->assertFalse($badge->is_issued($this->user->id));
+
+ $criteriaoverall = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id]);
+ $criteriaoverall->save(['agg' => BADGE_CRITERIA_AGGREGATION_ANY]);
+ $criteriaoverall1 = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_COURSESET, 'badgeid' => $badge->id]);
+ $criteriaoverall1->save();
+ // Assert the badge will not be issued to the user as is.
+ $badge = new badge($this->coursebadge);
+ $badge->review_all_criteria();
+ $this->assertFalse($badge->is_issued($this->user->id));
+ }
+
/**
* Test badges observer when cohort_member_added event is fired and user required to belong to multiple (all) cohorts.
*
diff --git a/blocks/classes/output/block_contents.php b/blocks/classes/output/block_contents.php
new file mode 100644
index 0000000000000..6d8f7850e4c24
--- /dev/null
+++ b/blocks/classes/output/block_contents.php
@@ -0,0 +1,168 @@
+.
+
+namespace core_block\output;
+
+/**
+ * This class represents how a block appears on a page.
+ *
+ * During output, each block instance is asked to return a block_contents object,
+ * those are then passed to the $OUTPUT->block function for display.
+ *
+ * contents should probably be generated using a moodle_block_..._renderer.
+ *
+ * Other block-like things that need to appear on the page, for example the
+ * add new block UI, are also represented as block_contents objects.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core_block
+ * @category output
+ */
+class block_contents {
+ /** Used when the block cannot be collapsed **/
+ const NOT_HIDEABLE = 0;
+
+ /** Used when the block can be collapsed but currently is not **/
+ const VISIBLE = 1;
+
+ /** Used when the block has been collapsed **/
+ const HIDDEN = 2;
+
+ /**
+ * @var int Used to set $skipid.
+ */
+ protected static $idcounter = 1;
+
+ /**
+ * @var int All the blocks (or things that look like blocks) printed on
+ * a page are given a unique number that can be used to construct id="" attributes.
+ * This is set automatically be the {@see prepare()} method.
+ * Do not try to set it manually.
+ */
+ public $skipid;
+
+ /**
+ * @var int If this is the contents of a real block, this should be set
+ * to the block_instance.id. Otherwise this should be set to 0.
+ */
+ public $blockinstanceid = 0;
+
+ /**
+ * @var int If this is a real block instance, and there is a corresponding
+ * block_position.id for the block on this page, this should be set to that id.
+ * Otherwise it should be 0.
+ */
+ public $blockpositionid = 0;
+
+ /**
+ * @var array An array of attribute => value pairs that are put on the outer div of this
+ * block. {@see $id} and {@see $classes} attributes should be set separately.
+ */
+ public $attributes;
+
+ /**
+ * @var string The title of this block. If this came from user input, it should already
+ * have had format_string() processing done on it. This will be output inside
+ * tags. Please do not cause invalid XHTML.
+ */
+ public $title = '';
+
+ /**
+ * @var string The label to use when the block does not, or will not have a visible title.
+ * You should never set this as well as title... it will just be ignored.
+ */
+ public $arialabel = '';
+
+ /**
+ * @var string HTML for the content
+ */
+ public $content = '';
+
+ /**
+ * @var array An alternative to $content, it you want a list of things with optional icons.
+ */
+ public $footer = '';
+
+ /**
+ * @var string Any small print that should appear under the block to explain
+ * to the teacher about the block, for example 'This is a sticky block that was
+ * added in the system context.'
+ */
+ public $annotation = '';
+
+ /**
+ * @var int One of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
+ * the user can toggle whether this block is visible.
+ */
+ public $collapsible = self::NOT_HIDEABLE;
+
+ /**
+ * Set this to true if the block is dockable.
+ * @var bool
+ */
+ public $dockable = false;
+
+ /**
+ * @var array A (possibly empty) array of editing controls. Each element of
+ * this array should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
+ * $icon is the icon name. Fed to $OUTPUT->image_url.
+ */
+ public $controls = [];
+
+
+ /**
+ * Create new instance of block content.
+ *
+ * @param null|array $attributes
+ */
+ public function __construct(?array $attributes = null) {
+ $this->skipid = self::$idcounter;
+ self::$idcounter += 1;
+
+ if ($attributes) {
+ // Standard block.
+ $this->attributes = $attributes;
+ } else {
+ // Simple "fake" blocks used in some modules and "Add new block" block.
+ $this->attributes = ['class' => 'block'];
+ }
+ }
+
+ /**
+ * Add html class to block
+ *
+ * @param string $class
+ */
+ public function add_class($class) {
+ $this->attributes['class'] .= ' ' . $class;
+ }
+
+ /**
+ * Check if the block is a fake block.
+ *
+ * @return boolean
+ */
+ public function is_fake() {
+ return isset($this->attributes['data-block']) && $this->attributes['data-block'] == '_fake';
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(block_contents::class, \block_contents::class);
diff --git a/blocks/classes/output/block_move_target.php b/blocks/classes/output/block_move_target.php
new file mode 100644
index 0000000000000..d305a901daa04
--- /dev/null
+++ b/blocks/classes/output/block_move_target.php
@@ -0,0 +1,50 @@
+.
+
+namespace core_block\output;
+
+use moodle_url;
+
+/**
+ * This class represents a target for where a block can go when it is being moved.
+ *
+ * This needs to be rendered as a form with the given hidden from fields, and
+ * clicking anywhere in the form should submit it. The form action should be
+ * $PAGE->url.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core_block
+ * @category output
+ */
+class block_move_target {
+ /**
+ * Constructor.
+ *
+ * @param moodle_url $url
+ */
+ public function __construct(
+ /** @var moodle_url Move url */
+ public moodle_url $url,
+ ) {
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(block_move_target::class, \block_move_target::class);
diff --git a/blocks/glossary_random/tests/behat/glossary_random_addblock.feature b/blocks/glossary_random/tests/behat/glossary_random_addblock.feature
index 204e500896dd9..3a295adf186f7 100644
--- a/blocks/glossary_random/tests/behat/glossary_random_addblock.feature
+++ b/blocks/glossary_random/tests/behat/glossary_random_addblock.feature
@@ -17,7 +17,7 @@ Feature: Add the glossary random block when main feature is enabled
Scenario: The glossary random block cannot be added when glossary module is disabled
Given I navigate to "Plugins > Activity modules > Manage activities" in site administration
- And I click on "Disable Glossary" "icon" in the "Glossary" "table_row"
+ And I toggle the "Disable Glossary" admin switch "off"
And I am on "Course 1" course homepage with editing mode on
When I click on "Add a block" "link"
Then I should not see "Random glossary entry"
diff --git a/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature b/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature
index 1df05238ba28c..b952ba11c618e 100644
--- a/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature
+++ b/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature
@@ -15,7 +15,7 @@ Feature: Add the glossary random block when main feature is disabled
Scenario: The glossary random block is displayed even when glossary module is disabled
When I log in as "admin"
And I navigate to "Plugins > Activity modules > Manage activities" in site administration
- And I click on "Disable Glossary" "icon" in the "Glossary" "table_row"
+ And I toggle the "Disable Glossary" admin switch "off"
And I am on "Course 1" course homepage with editing mode on
Then "Random glossary entry" "block" should exist
@@ -28,7 +28,7 @@ Feature: Add the glossary random block when main feature is disabled
And I click on "Cancel" "button" in the "Delete block?" "dialogue"
And "Random glossary entry" "block" should exist
When I navigate to "Plugins > Activity modules > Manage activities" in site administration
- And I click on "Disable Glossary" "icon" in the "Glossary" "table_row"
+ And I toggle the "Disable Glossary" admin switch "off"
And I am on "Course 1" course homepage with editing mode on
And I open the "Random glossary entry" blocks action menu
And I click on "Delete Random glossary entry block" "link" in the "Random glossary entry" "block"
diff --git a/blocks/myoverview/templates/main.mustache b/blocks/myoverview/templates/main.mustache
index 1828a0efcfb5f..b333e92ae24f1 100644
--- a/blocks/myoverview/templates/main.mustache
+++ b/blocks/myoverview/templates/main.mustache
@@ -27,7 +27,7 @@
tags. Please do not cause invalid XHTML.
+ */
+ public $title = '';
+
+ /**
+ * @var string The label to use when the block does not, or will not have a visible title.
+ * You should never set this as well as title... it will just be ignored.
+ */
+ public $arialabel = '';
+
+ /**
+ * @var string HTML for the content
+ */
+ public $content = '';
+
+ /**
+ * @var array An alternative to $content, it you want a list of things with optional icons.
+ */
+ public $footer = '';
+
+ /**
+ * @var string Any small print that should appear under the block to explain
+ * to the teacher about the block, for example 'This is a sticky block that was
+ * added in the system context.'
+ */
+ public $annotation = '';
+
+ /**
+ * @var int One of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
+ * the user can toggle whether this block is visible.
+ */
+ public $collapsible = self::NOT_HIDEABLE;
+
+ /**
+ * Set this to true if the block is dockable.
+ * @var bool
+ */
+ public $dockable = false;
+
+ /**
+ * @var array A (possibly empty) array of editing controls. Each element of
+ * this array should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
+ * $icon is the icon name. Fed to $OUTPUT->image_url.
+ */
+ public $controls = [];
+
+
+ /**
+ * Create new instance of block content.
+ *
+ * @param null|array $attributes
+ */
+ public function __construct(?array $attributes = null) {
+ $this->skipid = self::$idcounter;
+ self::$idcounter += 1;
+
+ if ($attributes) {
+ // Standard block.
+ $this->attributes = $attributes;
+ } else {
+ // Simple "fake" blocks used in some modules and "Add new block" block.
+ $this->attributes = ['class' => 'block'];
+ }
+ }
+
+ /**
+ * Add html class to block
+ *
+ * @param string $class
+ */
+ public function add_class($class) {
+ $this->attributes['class'] .= ' ' . $class;
+ }
+
+ /**
+ * Check if the block is a fake block.
+ *
+ * @return boolean
+ */
+ public function is_fake() {
+ return isset($this->attributes['data-block']) && $this->attributes['data-block'] == '_fake';
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(block_contents::class, \block_contents::class);
diff --git a/blocks/classes/output/block_move_target.php b/blocks/classes/output/block_move_target.php
new file mode 100644
index 0000000000000..d305a901daa04
--- /dev/null
+++ b/blocks/classes/output/block_move_target.php
@@ -0,0 +1,50 @@
+.
+
+namespace core_block\output;
+
+use moodle_url;
+
+/**
+ * This class represents a target for where a block can go when it is being moved.
+ *
+ * This needs to be rendered as a form with the given hidden from fields, and
+ * clicking anywhere in the form should submit it. The form action should be
+ * $PAGE->url.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core_block
+ * @category output
+ */
+class block_move_target {
+ /**
+ * Constructor.
+ *
+ * @param moodle_url $url
+ */
+ public function __construct(
+ /** @var moodle_url Move url */
+ public moodle_url $url,
+ ) {
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(block_move_target::class, \block_move_target::class);
diff --git a/blocks/glossary_random/tests/behat/glossary_random_addblock.feature b/blocks/glossary_random/tests/behat/glossary_random_addblock.feature
index 204e500896dd9..3a295adf186f7 100644
--- a/blocks/glossary_random/tests/behat/glossary_random_addblock.feature
+++ b/blocks/glossary_random/tests/behat/glossary_random_addblock.feature
@@ -17,7 +17,7 @@ Feature: Add the glossary random block when main feature is enabled
Scenario: The glossary random block cannot be added when glossary module is disabled
Given I navigate to "Plugins > Activity modules > Manage activities" in site administration
- And I click on "Disable Glossary" "icon" in the "Glossary" "table_row"
+ And I toggle the "Disable Glossary" admin switch "off"
And I am on "Course 1" course homepage with editing mode on
When I click on "Add a block" "link"
Then I should not see "Random glossary entry"
diff --git a/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature b/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature
index 1df05238ba28c..b952ba11c618e 100644
--- a/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature
+++ b/blocks/glossary_random/tests/behat/glossary_random_addblock_disabled.feature
@@ -15,7 +15,7 @@ Feature: Add the glossary random block when main feature is disabled
Scenario: The glossary random block is displayed even when glossary module is disabled
When I log in as "admin"
And I navigate to "Plugins > Activity modules > Manage activities" in site administration
- And I click on "Disable Glossary" "icon" in the "Glossary" "table_row"
+ And I toggle the "Disable Glossary" admin switch "off"
And I am on "Course 1" course homepage with editing mode on
Then "Random glossary entry" "block" should exist
@@ -28,7 +28,7 @@ Feature: Add the glossary random block when main feature is disabled
And I click on "Cancel" "button" in the "Delete block?" "dialogue"
And "Random glossary entry" "block" should exist
When I navigate to "Plugins > Activity modules > Manage activities" in site administration
- And I click on "Disable Glossary" "icon" in the "Glossary" "table_row"
+ And I toggle the "Disable Glossary" admin switch "off"
And I am on "Course 1" course homepage with editing mode on
And I open the "Random glossary entry" blocks action menu
And I click on "Delete Random glossary entry block" "link" in the "Random glossary entry" "block"
diff --git a/blocks/myoverview/templates/main.mustache b/blocks/myoverview/templates/main.mustache
index 1828a0efcfb5f..b333e92ae24f1 100644
--- a/blocks/myoverview/templates/main.mustache
+++ b/blocks/myoverview/templates/main.mustache
@@ -27,7 +27,7 @@
-
+
{{> block_myoverview/nav-grouping-selector }}
{{> block_myoverview/nav-search-widget }}
diff --git a/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature b/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature
index 1ff584bbc83a4..e646087e9c4cf 100644
--- a/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature
+++ b/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature
@@ -7,7 +7,7 @@ Feature: Adding and configuring YouTube block
Background:
Given I log in as "admin"
And I navigate to "Plugins > Blocks > Manage blocks" in site administration
- And I click on "Enable YouTube" "icon" in the "YouTube" "table_row"
+ And I toggle the "Enable YouTube" admin switch "on"
@javascript
Scenario: Category options are not available (except default) in the block settings if the YouTube API key is not set.
diff --git a/blocks/timeline/templates/main.mustache b/blocks/timeline/templates/main.mustache
index b3f7ea87eb3cd..3f7a761a1af05 100644
--- a/blocks/timeline/templates/main.mustache
+++ b/blocks/timeline/templates/main.mustache
@@ -25,7 +25,7 @@
-
+
{{> block_timeline/nav-day-filter }}
diff --git a/blocks/timeline/tests/behat/block_timeline_search.feature b/blocks/timeline/tests/behat/block_timeline_search.feature
index f25bbd4cf856e..5814ea418a35b 100644
--- a/blocks/timeline/tests/behat/block_timeline_search.feature
+++ b/blocks/timeline/tests/behat/block_timeline_search.feature
@@ -141,7 +141,7 @@ Feature: The timeline block allows users to search for upcoming activities
And I should see "Test choice 7" in the ".block-timeline [data-region='view-courses']" "css_element"
And I should see "Test choice 8" in the ".block-timeline [data-region='view-courses']" "css_element"
When I set the field "Search by activity type or name" to "choice 1"
- And I wait until "Course 4" "text" does not exist
+ And I wait until "//h4[contains(@class, 'h5') and contains(.,'Course 4')]" "xpath_element" does not exist
Then I should see "Test choice 1" in the "Timeline" "block"
And I should see "Course 2" in the ".block-timeline [data-region='view-courses']" "css_element"
And I should not see "Course 1" in the ".block-timeline [data-region='view-courses']" "css_element"
diff --git a/cache/tests/cache_test.php b/cache/tests/cache_test.php
index 142b11cf2fa31..c6371b4b5df46 100644
--- a/cache/tests/cache_test.php
+++ b/cache/tests/cache_test.php
@@ -2230,7 +2230,7 @@ public function test_application_locking_before_write(): void {
/**
* Test that locking before write works when writing across multiple layers.
*
- * @covers \cache_loader
+ * @covers \cache_application
* @return void
*/
public function test_application_locking_multiple_layers(): void {
@@ -2310,7 +2310,7 @@ public function test_application_locking_multiple_layers(): void {
/**
* Tests that locking fails correctly when either layer of a 2-layer cache has a lock already.
*
- * @covers \cache_loader
+ * @covers \cache_application
*/
public function test_application_locking_multiple_layers_failures(): void {
diff --git a/calendar/renderer.php b/calendar/renderer.php
index 5134fa007fa5c..2c356347dc671 100644
--- a/calendar/renderer.php
+++ b/calendar/renderer.php
@@ -206,7 +206,7 @@ public function course_filter_selector(moodle_url $returnurl, $label = null, $co
}
$contextrecords = [];
- $courses = calendar_get_default_courses($courseid, 'id, shortname');
+ $courses = calendar_get_default_courses($courseid, 'id, fullname');
if (!empty($courses) && count($courses) > CONTEXT_CACHE_MAX_SIZE) {
// We need to pull the context records from the DB to preload them
@@ -235,7 +235,9 @@ public function course_filter_selector(moodle_url $returnurl, $label = null, $co
context_helper::preload_from_record($contextrecords[$course->id]);
}
$coursecontext = context_course::instance($course->id);
- $courseoptions[$course->id] = format_string($course->shortname, true, array('context' => $coursecontext));
+ // Limit the displayed course name to prevent the dropdown from getting too wide.
+ $coursename = shorten_text($course->fullname, 50, true);
+ $courseoptions[$course->id] = format_string($coursename, true, ['context' => $coursecontext]);
}
if ($courseid) {
@@ -260,7 +262,7 @@ public function course_filter_selector(moodle_url $returnurl, $label = null, $co
}
$select = html_writer::label($label, $filterid, false, $labelattributes);
$select .= html_writer::select($courseoptions, 'course', $selected, false,
- ['class' => 'cal_courses_flt ml-1 mr-auto', 'id' => $filterid]);
+ ['class' => 'cal_courses_flt ml-1 mr-auto mr-2 mb-2', 'id' => $filterid]);
return $select;
}
@@ -298,9 +300,8 @@ public function render_subscriptions_header(): string {
*/
public function render_no_calendar_subscriptions(): string {
$output = html_writer::start_div('mt-5');
- $importlink = html_writer::link((new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out(),
- get_string('importcalendarexternal', 'calendar'));
- $output .= get_string('nocalendarsubscriptions', 'calendar', $importlink);
+ $importlink = (new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out();
+ $output .= get_string('nocalendarsubscriptionsimportexternal', 'core_calendar', $importlink);
$output .= html_writer::end_div();
return $output;
@@ -327,7 +328,8 @@ public function subscription_details($unused, $subscriptions, $unused2 = '') {
$table->id = 'subscription_details_table';
if (empty($subscriptions)) {
- $cell = new html_table_cell(get_string('nocalendarsubscriptions', 'calendar'));
+ $importlink = (new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out();
+ $cell = new html_table_cell(get_string('nocalendarsubscriptionsimportexternal', 'core_calendar', $importlink));
$cell->colspan = 5;
$table->data[] = new html_table_row(array($cell));
}
diff --git a/calendar/templates/add_event_button.mustache b/calendar/templates/add_event_button.mustache
index 115e58ce5dbe4..06cdebfd80dca 100644
--- a/calendar/templates/add_event_button.mustache
+++ b/calendar/templates/add_event_button.mustache
@@ -34,7 +34,7 @@
}}
{{#defaulteventcontext}}
diff --git a/calendar/templates/view_selector.mustache b/calendar/templates/view_selector.mustache
index 6a9de4cad1dd8..a0d5ce36edf2f 100644
--- a/calendar/templates/view_selector.mustache
+++ b/calendar/templates/view_selector.mustache
@@ -27,7 +27,7 @@
}
}}
-
diff --git a/course/templates/defaultactivitycompletion.mustache b/course/templates/defaultactivitycompletion.mustache
index d2a64d21855d0..5d1e05dc7c5d6 100644
--- a/course/templates/defaultactivitycompletion.mustache
+++ b/course/templates/defaultactivitycompletion.mustache
@@ -68,7 +68,7 @@
{{#pix}} t/expandedchevron, core {{/pix}}
{{#str}} collapsecategory, core, {{formatedname}} {{/str}}
-
+
{{{formattedname}}}
diff --git a/course/tests/backup/restore_test.php b/course/tests/backup/restore_test.php
index bfd98f5752bc0..83dd5dfc5c6fc 100644
--- a/course/tests/backup/restore_test.php
+++ b/course/tests/backup/restore_test.php
@@ -575,7 +575,9 @@ public function test_restore_course_startdate_in_existing_course_without_permiss
* Tests course restore with editor in course format.
*
* @author Matthew Hilton
- * @covers \core_courseformat
+ * @covers \core_courseformat\base
+ * @covers \backup_course_structure_step
+ * @covers \restore_course_structure_step
*/
public function test_restore_editor_courseformat(): void {
$this->resetAfterTest();
diff --git a/course/tests/behat/activities_visibility_icons.feature b/course/tests/behat/activities_visibility_icons.feature
index 382110cc13e3e..557b378dabf64 100644
--- a/course/tests/behat/activities_visibility_icons.feature
+++ b/course/tests/behat/activities_visibility_icons.feature
@@ -6,16 +6,18 @@ Feature: Toggle activities visibility from the course page
Background:
Given the following "users" exist:
- | username | firstname | lastname | email |
- | teacher1 | Teacher | 1 | teacher1@example.com |
- | student1 | Student | 1 | student1@example.com |
+ | username | firstname | lastname | email |
+ | teacher1 | Teacher | 1 | teacher1@example.com |
+ | noneditingteacher1 | Non-Editing Teacher | 1 | noneditingteacher1@example.com |
+ | student1 | Student | 1 | student1@example.com |
And the following "courses" exist:
| fullname | shortname | format | numsections |
| Course 1 | C1 | topics | 2 |
And the following "course enrolments" exist:
- | user | course | role |
- | teacher1 | C1 | editingteacher |
- | student1 | C1 | student |
+ | user | course | role |
+ | teacher1 | C1 | editingteacher |
+ | noneditingteacher1 | C1 | teacher |
+ | student1 | C1 | student |
And the following "activities" exist:
| activity | course | section | idnumber | name | intro | id_visible |
| assign | C1 | 1 | 1 | Test assignment name | Test assignment description | 1 |
@@ -53,6 +55,9 @@ Feature: Toggle activities visibility from the course page
And the field "Availability" matches value "Hide on course page"
And I press "Save and return to course"
And "Test forum name" activity should be hidden
+ # Non-editing teacher should see this activity.
+ And I am on the "Course 1" course page logged in as noneditingteacher1
+ And I should see "Test forum name" in the "region-main" "region"
# Student should not see this activity.
And I am on the "Course 1" course page logged in as student1
And I should not see "Test forum name"
@@ -115,12 +120,12 @@ Feature: Toggle activities visibility from the course page
And "Test assignment name" activity should be available but hidden from course page
And I turn editing mode off
And "Test assignment name" activity should be available but hidden from course page
- And I log out
+ # Non-editing teacher will see the module on the course page:
+ And I am on the "Course 1" course page logged in as noneditingteacher1
+ And I should see "Test assignment name" in the "region-main" "region"
# Student will not see the module on the course page but can access it from other reports and blocks:
- And I log in as "student1"
- And I am on "Course 1" course homepage
+ And I am on the "Course 1" course page logged in as student1
And "Test assignment name" activity should be hidden
And I click on "Test assignment name" "link" in the "Recent activity" "block"
And I should see "Test assignment name"
And I should see "Submission status"
- And I log out
diff --git a/course/tests/behat/activity_chooser.feature b/course/tests/behat/activity_chooser.feature
index 1d099e6fde8ac..ad6b9115fb13c 100644
--- a/course/tests/behat/activity_chooser.feature
+++ b/course/tests/behat/activity_chooser.feature
@@ -302,7 +302,7 @@ Feature: Display and choose from the available activities in course
# Confirm more help link exists
Then "More help" "link" should exist
# Confirm that corresponding help icon exist
- And ".iconhelp" "css_element" should exist
+ And ".fa-info-circle" "css_element" should exist
# Confirm that link opens in new window
And "Opens in new window" "link" should be visible
# Confirm the same behaviour for weekly format course
@@ -313,6 +313,6 @@ Feature: Display and choose from the available activities in course
# Confirm more help link exists
And "More help" "link" should exist
# Confirm that corresponding help icon exist
- And ".iconhelp" "css_element" should exist
+ And ".fa-info-circle" "css_element" should exist
# Confirm that link opens in new window
And "Opens in new window" "link" should be visible
diff --git a/course/tests/behat/activity_tags_deletion.feature b/course/tests/behat/activity_tags_deletion.feature
index a969aae3e7ae8..f4a034cb6d9b4 100644
--- a/course/tests/behat/activity_tags_deletion.feature
+++ b/course/tests/behat/activity_tags_deletion.feature
@@ -22,7 +22,9 @@ Feature: Delete activity tags during course reset
# Perform course reset without checking anything.
And I log in as "admin"
And I am on the "Course 1" "reset" page
- And I press "Reset"
+ And I press "Deselect all"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I press "Continue"
# Confirm that book chapter tags are not deleted.
When I am on the "Test Book" "book activity" page
@@ -30,9 +32,10 @@ Feature: Delete activity tags during course reset
And I should see "ChapterTag"
# Delete book chapter tags using course reset.
And I am on the "Course 1" "reset" page
- And I expand all fieldsets
+ And I press "Deselect all"
And I click on "All book tags" "checkbox"
- And I press "Reset"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
# Confirm that book chapter tags are deleted.
And I should see "All book tags" in the "Books" "table_row"
And I press "Continue"
@@ -47,7 +50,9 @@ Feature: Delete activity tags during course reset
| admin | forum1 | Discussion 1 | Discussion 1 message | SampleTag, DiscussionTag |
# Perform course reset without checking anything.
And I am on the "Course 1" "reset" page logged in as admin
- And I press "Reset"
+ And I press "Deselect all"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I press "Continue"
# Confirm that forum discussion tags are not deleted.
When I am on the "Test Forum" "forum activity" page
@@ -55,12 +60,13 @@ Feature: Delete activity tags during course reset
Then I should see "SampleTag"
And I should see "DiscussionTag"
And I am on the "Course 1" "reset" page
- And I expand all fieldsets
+ And I press "Deselect all"
# Depending on value, either delete all discussion posts or remove all forum discussion tags only.
And I click on "" "checkbox"
# Confirm `Remove all forum tags` is disabled when `Delete all posts` on previous step is checked.
And the "All forum tags" "checkbox" should be
- And I press "Reset"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I should see "" in the "Forums" "table_row"
And I press "Continue"
And I am on the "Test Forum" "forum activity" page
@@ -82,19 +88,22 @@ Feature: Delete activity tags during course reset
| Test Glossary | Aubergine | Also eggpgplant | admin | SampleTag, GlossaryTag |
# Perform course reset without checking anything.
And I am on the "Course 1" "reset" page logged in as admin
- And I press "Reset"
+ And I press "Deselect all"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I press "Continue"
# Confirm that glossary entry tags are not deleted.
When I am on the "Test Glossary" "glossary activity" page
Then I should see "SampleTag"
And I should see "GlossaryTag"
And I am on the "Course 1" "reset" page
- And I expand all fieldsets
+ And I press "Deselect all"
# Depending on value, either delete all glossary entries or remove all glossary entry tags only.
And I click on "" "checkbox"
# Confirm `Remove all forum tags` is disabled when `Delete entries from all glossaries` on previous step is checked.
And the "All glossary tags" "checkbox" should be
- And I press "Reset"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I should see "" in the "Glossaries" "table_row"
And I press "Continue"
And I am on the "Test Glossary" "glossary activity" page
diff --git a/course/tests/behat/reset_course.feature b/course/tests/behat/reset_course.feature
new file mode 100644
index 0000000000000..e202c965e7c3f
--- /dev/null
+++ b/course/tests/behat/reset_course.feature
@@ -0,0 +1,75 @@
+@core @core_course
+Feature: Reset course
+ In order to reuse a course
+ As a teacher
+ I need to clear all user data and reset the course to its initial state
+
+ Background:
+ Given the following "users" exist:
+ | username | firstname | lastname | email |
+ | teacher1 | Teacher | 1 | teacher1@example.com |
+ | student1 | Student | 1 | student1@example.com |
+ And the following "courses" exist:
+ | fullname | shortname | format | numsections |
+ | Course 1 | C1 | topics | 2 |
+ And the following "course enrolments" exist:
+ | user | course | role |
+ | teacher1 | C1 | editingteacher |
+ | student1 | C1 | student |
+ And the following "activity" exists:
+ | activity | assign |
+ | course | C1 |
+ | name | Test assignment name |
+ | assignsubmission_onlinetext_enabled | 1 |
+ | assignsubmission_file_enabled | 0 |
+ | submissiondrafts | 0 |
+ And the following "mod_assign > submissions" exist:
+ | assign | user | onlinetext |
+ | Test assignment name | student1 | I'm the student1 submission |
+
+ Scenario: Reset course select and deselect buttons
+ When I am on the "Course 1" "reset" page logged in as "teacher1"
+ Then I should see "Collapse all"
+ And the field "Events" matches value "1"
+ And the field "All notes" matches value "1"
+ And the field "All comments" matches value "0"
+ And the field "Completion data" matches value "0"
+ And the field "All submissions" matches value "1"
+ And the field "All user overrides" matches value "1"
+ And the field "All group overrides" matches value "1"
+ # Check fields are unchecked when Deselect all is clicked
+ And I click on "Deselect all" "button"
+ And the field "Events" matches value "0"
+ And the field "All notes" matches value "0"
+ And the field "All comments" matches value "0"
+ And the field "Completion data" matches value "0"
+ And the field "All submissions" matches value "0"
+ And the field "All user overrides" matches value "0"
+ And the field "All group overrides" matches value "0"
+ # Check default fields are checked again when Select default is clicked
+ And I click on "Select default" "button"
+ And the field "Events" matches value "1"
+ And the field "All notes" matches value "1"
+ And the field "All comments" matches value "0"
+ And the field "Completion data" matches value "0"
+ And the field "All submissions" matches value "1"
+ And the field "All user overrides" matches value "1"
+ And the field "All group overrides" matches value "1"
+
+ @javascript
+ Scenario: Reset course with default settings
+ Given I am on the "Course 1" "reset" page logged in as "teacher1"
+ When I click on "Reset course" "button"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
+ Then I should see "Done" in the "All notes" "table_row"
+ And I should see "Done" in the "All local role assignments" "table_row"
+ And I should see "Done" in the "All submissions" "table_row"
+ And I click on "Continue" "button"
+ # Check that you're redirected to the course page.
+ And I should not see "Reset course"
+ # Check the course has been reset.
+ And I navigate to course participants
+ And I should see "Teacher 1"
+ And I should not see "Student 1"
+ And I am on the "Test assignment name" "assign activity" page
+ And I should see "0" in the "Submitted" "table_row"
diff --git a/course/tests/course_delete_modules_test.php b/course/tests/course_delete_modules_test.php
index 1164f0964fe59..d70d567d7fffa 100644
--- a/course/tests/course_delete_modules_test.php
+++ b/course/tests/course_delete_modules_test.php
@@ -21,6 +21,7 @@
* @subpackage course
* @copyright 2021 Tomo Tsuyuki
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \core_course\task\course_delete_modules
*/
namespace core_course;
@@ -68,8 +69,6 @@ public function test_delete_module_execution(): void {
/**
* Test with failed and successful cms
- *
- * @covers ::course_delete_modules
*/
public function test_delete_module_exception(): void {
global $DB;
diff --git a/customfield/templates/list.mustache b/customfield/templates/list.mustache
index 521b268c11611..9e4cf28a42552 100644
--- a/customfield/templates/list.mustache
+++ b/customfield/templates/list.mustache
@@ -78,10 +78,11 @@
diff --git a/enrol/cohort/tests/behat/enrolcohorts.feature b/enrol/cohort/tests/behat/enrolcohorts.feature
index 2571dc52cbebf..a59b8a48029c6 100644
--- a/enrol/cohort/tests/behat/enrolcohorts.feature
+++ b/enrol/cohort/tests/behat/enrolcohorts.feature
@@ -83,11 +83,11 @@ Feature: Cohort enrolment management
And I navigate to course participants
# Verifies students 1 and 4 are in the cohort and student 2 is not any more.
And the following should exist in the "participants" table:
- | First name / Last name | Email address | Roles | Groups |
+ | First name | Email address | Roles | Groups |
| Sandra Cole | s1@example.com | Student | Alpha1 cohort |
| Jane Doe | s4@example.com | Student | Alpha1 cohort |
And the following should not exist in the "participants" table:
- | First name / Last name | Email address | Roles | Groups |
+ | First name | Email address | Roles | Groups |
| John Smith | s2@example.com | Student | Alpha1 cohort |
@javascript
diff --git a/enrol/editinstance.php b/enrol/editinstance.php
index 2363340f918ee..047ab93e93304 100644
--- a/enrol/editinstance.php
+++ b/enrol/editinstance.php
@@ -38,7 +38,10 @@
}
require_login($course);
-require_capability('enrol/' . $type . ':config', $context);
+
+if (!has_any_capability(['enrol/' . $type . ':config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ throw new \moodle_exception('nopermissiontoaccesspage', 'error');
+}
$url = new moodle_url('/enrol/editinstance.php', ['courseid' => $course->id, 'id' => $instanceid, 'type' => $type]);
$PAGE->set_url($url);
diff --git a/enrol/manual/lib.php b/enrol/manual/lib.php
index c41d5d970d021..0ef478a228b98 100644
--- a/enrol/manual/lib.php
+++ b/enrol/manual/lib.php
@@ -114,8 +114,17 @@ public function get_action_icons(stdClass $instance) {
$managelink = new moodle_url("/enrol/manual/manage.php", array('enrolid'=>$instance->id));
$icons[] = $OUTPUT->action_icon($managelink, new pix_icon('t/enrolusers', get_string('enrolusers', 'enrol_manual'), 'core', array('class'=>'iconsmall')));
}
- $parenticons = parent::get_action_icons($instance);
- $icons = array_merge($icons, $parenticons);
+
+ if (has_any_capability(['enrol/manual:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $linkparams = [
+ 'courseid' => $instance->courseid,
+ 'id' => $instance->id,
+ 'type' => $instance->enrol,
+ ];
+ $editlink = new moodle_url('/enrol/editinstance.php', $linkparams);
+ $icon = new pix_icon('t/edit', get_string('edit'), 'core', ['class' => 'iconsmall']);
+ $icons[] = $OUTPUT->action_icon($editlink, $icon);
+ }
return $icons;
}
@@ -175,7 +184,11 @@ public function update_instance($instance, $data) {
}
}
- $data->notifyall = $data->expirynotify == 2 ? 1 : 0;
+ // This method is used when configuring the enrolment method, and when only updating the welcome message.
+ // The 'expirynotify' property won't be set when updating the welcome message.
+ if (isset($data->expirynotify)) {
+ $data->notifyall = $data->expirynotify == 2 ? 1 : 0;
+ }
return parent::update_instance($instance, $data);
}
@@ -582,86 +595,92 @@ protected function get_expirynotify_options() {
*/
public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
- $options = $this->get_status_options();
- $mform->addElement('select', 'status', get_string('status', 'enrol_manual'), $options);
- $mform->addHelpButton('status', 'status', 'enrol_manual');
- $mform->setDefault('status', $this->get_config('status'));
-
- $roles = $this->get_roleid_options($instance, $context);
- $mform->addElement('select', 'roleid', get_string('defaultrole', 'role'), $roles);
- $mform->setDefault('roleid', $this->get_config('roleid'));
-
- $options = array('optional' => true, 'defaultunit' => 86400);
- $mform->addElement('duration', 'enrolperiod', get_string('defaultperiod', 'enrol_manual'), $options);
- $mform->setDefault('enrolperiod', $this->get_config('enrolperiod'));
- $mform->addHelpButton('enrolperiod', 'defaultperiod', 'enrol_manual');
-
- $options = $this->get_expirynotify_options();
- $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
- $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
-
- $options = array('optional' => false, 'defaultunit' => 86400);
- $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
- $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
- $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
+ // Main fields.
+ if (has_capability('enrol/manual:config', $context)) {
+ $options = $this->get_status_options();
+ $mform->addElement('select', 'status', get_string('status', 'enrol_manual'), $options);
+ $mform->addHelpButton('status', 'status', 'enrol_manual');
+ $mform->setDefault('status', $this->get_config('status'));
+
+ $roles = $this->get_roleid_options($instance, $context);
+ $mform->addElement('select', 'roleid', get_string('defaultrole', 'role'), $roles);
+ $mform->setDefault('roleid', $this->get_config('roleid'));
+
+ $options = ['optional' => true, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'enrolperiod', get_string('defaultperiod', 'enrol_manual'), $options);
+ $mform->setDefault('enrolperiod', $this->get_config('enrolperiod'));
+ $mform->addHelpButton('enrolperiod', 'defaultperiod', 'enrol_manual');
+
+ $options = $this->get_expirynotify_options();
+ $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
+ $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
+
+ $options = ['optional' => false, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
+ $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
+ $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
+ }
// Course welcome message.
- $mform->addElement(
- 'select',
- 'customint1',
- get_string(
+ if (has_any_capability(['enrol/manual:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $mform->addElement(
+ 'select',
+ 'customint1',
+ get_string(
+ identifier: 'sendcoursewelcomemessage',
+ component: 'core_enrol',
+ ),
+ enrol_send_welcome_email_options(),
+ );
+ $mform->addHelpButton(
+ elementname: 'customint1',
identifier: 'sendcoursewelcomemessage',
component: 'core_enrol',
- ),
- enrol_send_welcome_email_options(),
- );
- $mform->addHelpButton(
- elementname: 'customint1',
- identifier: 'sendcoursewelcomemessage',
- component: 'core_enrol',
- );
-
- $options = [
- 'cols' => '60',
- 'rows' => '8',
- ];
- $mform->addElement(
- 'textarea',
- 'customtext1',
- get_string(
- identifier: 'customwelcomemessage',
- component: 'core_enrol',
- ),
- $options,
- );
- $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
- $mform->hideIf(
- elementname: 'customtext1',
- dependenton: 'customint1',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
-
- // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
- // See: https://tracker.moodle.org/browse/MDL-66251.
- $group[] = $mform->createElement(
- 'static',
- 'customwelcomemessage_extra_help',
- null,
- get_string(
- identifier: 'customwelcomemessage_help',
- component: 'core_enrol',
- ),
- );
- $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
- $mform->hideIf(
- elementname: 'group_customwelcomemessage_extra_help',
- dependenton: 'customint1',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
+ );
+
+ $options = [
+ 'cols' => '60',
+ 'rows' => '8',
+ ];
+ $mform->addElement(
+ 'textarea',
+ 'customtext1',
+ get_string(
+ identifier: 'customwelcomemessage',
+ component: 'core_enrol',
+ ),
+ $options,
+ );
+ $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
+ $mform->hideIf(
+ elementname: 'customtext1',
+ dependenton: 'customint1',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
+
+ // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
+ // See: https://tracker.moodle.org/browse/MDL-66251.
+ $group[] = $mform->createElement(
+ 'static',
+ 'customwelcomemessage_extra_help',
+ null,
+ get_string(
+ identifier: 'customwelcomemessage_help',
+ component: 'core_enrol',
+ ),
+ );
+ $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
+ $mform->hideIf(
+ elementname: 'group_customwelcomemessage_extra_help',
+ dependenton: 'customint1',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
+ }
- if (enrol_accessing_via_instance($instance)) {
+ // Enrolment changes warning.
+ if (has_capability('enrol/manual:config', $context) && enrol_accessing_via_instance($instance)) {
$warntext = get_string('instanceeditselfwarningtext', 'core_enrol');
$mform->addElement('static', 'selfwarn', get_string('instanceeditselfwarning', 'core_enrol'), $warntext);
}
@@ -681,7 +700,9 @@ public function edit_instance_form($instance, MoodleQuickForm $mform, $context)
public function edit_instance_validation($data, $files, $instance, $context) {
$errors = array();
- if ($data['expirynotify'] > 0 and $data['expirythreshold'] < 86400) {
+ // This method is used when configuring the enrolment method, and when only updating the welcome message.
+ // The 'expirynotify' key won't be set when updating the welcome message.
+ if (isset($data['expirynotify']) && $data['expirynotify'] > 0 && $data['expirythreshold'] < 86400) {
$errors['expirythreshold'] = get_string('errorthresholdlow', 'core_enrol');
}
diff --git a/enrol/manual/tests/behat/welcomemessage.feature b/enrol/manual/tests/behat/welcomemessage.feature
index 17d5377d5c634..6beda6759060d 100644
--- a/enrol/manual/tests/behat/welcomemessage.feature
+++ b/enrol/manual/tests/behat/welcomemessage.feature
@@ -35,6 +35,22 @@ Feature: A course welcome message will be sent to the user when they are enrolle
And I should not see "Custom welcome message"
And I should not see "Accepted formats: Plain text or Moodle-auto format. HTML tags and multi-lang tags are also accepted, as well as the following placeholders:"
+ @javascript
+ Scenario: Teacher can edit the course welcome message
+ Given I am on the "C1" "Enrolled users" page logged in as teacher
+ And I set the field "Participants tertiary navigation" to "Enrolment methods"
+ When I click on "Edit" "link" in the "Manual enrolments" "table_row"
+ Then I should see "Send course welcome message"
+ And I should not see "Enable manual enrolments"
+ And I should not see "Default role"
+ And I should not see "Default enrolment duration"
+ And I should not see "Notify before enrolment expires"
+ And I should not see "Notification threshold"
+ And I set the field "Custom welcome message" to "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+ And I press "Save changes"
+ And I click on "Edit" "link" in the "Manual enrolments" "table_row"
+ And I should see "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+
@javascript
Scenario: Student should not receive a welcome message if the setting is disabled
Given I am on the "C1" "Enrolled users" page logged in as manager
diff --git a/enrol/self/lib.php b/enrol/self/lib.php
index 80ad7d48e2844..3c987aec9a2ab 100644
--- a/enrol/self/lib.php
+++ b/enrol/self/lib.php
@@ -133,6 +133,32 @@ public function can_add_instance($courseid) {
return true;
}
+ /**
+ * Returns edit icons for the page with list of instances.
+ *
+ * @param stdClass $instance
+ * @return array
+ */
+ public function get_action_icons(stdClass $instance): array {
+ global $OUTPUT;
+
+ $context = context_course::instance($instance->courseid);
+
+ $icons = [];
+ if (has_any_capability(['enrol/self:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $linkparams = [
+ 'courseid' => $instance->courseid,
+ 'id' => $instance->id,
+ 'type' => $instance->enrol,
+ ];
+ $editlink = new moodle_url('/enrol/editinstance.php', $linkparams);
+ $icon = new pix_icon('t/edit', get_string('edit'), 'core', ['class' => 'iconsmall']);
+ $icons[] = $OUTPUT->action_icon($editlink, $icon);
+ }
+
+ return $icons;
+ }
+
/**
* Self enrol user to course
*
@@ -828,139 +854,149 @@ public function get_bulk_operations(course_enrolment_manager $manager) {
public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
global $CFG, $DB;
- // Merge these two settings to one value for the single selection element.
- if ($instance->notifyall and $instance->expirynotify) {
- $instance->expirynotify = 2;
- }
- unset($instance->notifyall);
-
- $nameattribs = array('size' => '20', 'maxlength' => '255');
- $mform->addElement('text', 'name', get_string('custominstancename', 'enrol'), $nameattribs);
- $mform->setType('name', PARAM_TEXT);
- $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'server');
-
- $options = $this->get_status_options();
- $mform->addElement('select', 'status', get_string('status', 'enrol_self'), $options);
- $mform->addHelpButton('status', 'status', 'enrol_self');
-
- $options = $this->get_newenrols_options();
- $mform->addElement('select', 'customint6', get_string('newenrols', 'enrol_self'), $options);
- $mform->addHelpButton('customint6', 'newenrols', 'enrol_self');
- $mform->disabledIf('customint6', 'status', 'eq', ENROL_INSTANCE_DISABLED);
-
- $passattribs = array('size' => '20', 'maxlength' => '50');
- $mform->addElement('passwordunmask', 'password', get_string('password', 'enrol_self'), $passattribs);
- $mform->addHelpButton('password', 'password', 'enrol_self');
- if (empty($instance->id) and $this->get_config('requirepassword')) {
- $mform->addRule('password', get_string('required'), 'required', null, 'client');
- }
- $mform->addRule('password', get_string('maximumchars', '', 50), 'maxlength', 50, 'server');
-
- $options = $this->get_groupkey_options();
- $mform->addElement('select', 'customint1', get_string('groupkey', 'enrol_self'), $options);
- $mform->addHelpButton('customint1', 'groupkey', 'enrol_self');
-
- $roles = $this->extend_assignable_roles($context, $instance->roleid);
- $mform->addElement('select', 'roleid', get_string('role', 'enrol_self'), $roles);
-
- $options = array('optional' => true, 'defaultunit' => 86400);
- $mform->addElement('duration', 'enrolperiod', get_string('enrolperiod', 'enrol_self'), $options);
- $mform->addHelpButton('enrolperiod', 'enrolperiod', 'enrol_self');
-
- $options = $this->get_expirynotify_options();
- $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
- $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
-
- $options = array('optional' => false, 'defaultunit' => 86400);
- $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
- $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
- $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
-
- $options = array('optional' => true);
- $mform->addElement('date_time_selector', 'enrolstartdate', get_string('enrolstartdate', 'enrol_self'), $options);
- $mform->setDefault('enrolstartdate', 0);
- $mform->addHelpButton('enrolstartdate', 'enrolstartdate', 'enrol_self');
-
- $options = array('optional' => true);
- $mform->addElement('date_time_selector', 'enrolenddate', get_string('enrolenddate', 'enrol_self'), $options);
- $mform->setDefault('enrolenddate', 0);
- $mform->addHelpButton('enrolenddate', 'enrolenddate', 'enrol_self');
-
- $options = $this->get_longtimenosee_options();
- $mform->addElement('select', 'customint2', get_string('longtimenosee', 'enrol_self'), $options);
- $mform->addHelpButton('customint2', 'longtimenosee', 'enrol_self');
-
- $mform->addElement('text', 'customint3', get_string('maxenrolled', 'enrol_self'));
- $mform->addHelpButton('customint3', 'maxenrolled', 'enrol_self');
- $mform->setType('customint3', PARAM_INT);
-
- require_once($CFG->dirroot.'/cohort/lib.php');
-
- $cohorts = array(0 => get_string('no'));
- $allcohorts = cohort_get_available_cohorts($context, 0, 0, 0);
- if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
- $c = $DB->get_record('cohort',
- array('id' => $instance->customint5),
- 'id, name, idnumber, contextid, visible',
- IGNORE_MISSING);
- if ($c) {
- // Current cohort was not found because current user can not see it. Still keep it.
- $allcohorts[$instance->customint5] = $c;
+ // Main fields.
+ if (has_capability('enrol/self:config', $context)) {
+ // Merge these two settings to one value for the single selection element.
+ if ($instance->notifyall && $instance->expirynotify) {
+ $instance->expirynotify = 2;
}
- }
- foreach ($allcohorts as $c) {
- $cohorts[$c->id] = format_string($c->name, true, array('context' => context::instance_by_id($c->contextid)));
- if ($c->idnumber) {
- $cohorts[$c->id] .= ' ['.s($c->idnumber).']';
+ unset($instance->notifyall);
+
+ $nameattribs = ['size' => '20', 'maxlength' => '255'];
+ $mform->addElement('text', 'name', get_string('custominstancename', 'enrol'), $nameattribs);
+ $mform->setType('name', PARAM_TEXT);
+ $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'server');
+
+ $options = $this->get_status_options();
+ $mform->addElement('select', 'status', get_string('status', 'enrol_self'), $options);
+ $mform->addHelpButton('status', 'status', 'enrol_self');
+
+ $options = $this->get_newenrols_options();
+ $mform->addElement('select', 'customint6', get_string('newenrols', 'enrol_self'), $options);
+ $mform->addHelpButton('customint6', 'newenrols', 'enrol_self');
+ $mform->disabledIf('customint6', 'status', 'eq', ENROL_INSTANCE_DISABLED);
+
+ $passattribs = ['size' => '20', 'maxlength' => '50'];
+ $mform->addElement('passwordunmask', 'password', get_string('password', 'enrol_self'), $passattribs);
+ $mform->addHelpButton('password', 'password', 'enrol_self');
+ if (empty($instance->id) && $this->get_config('requirepassword')) {
+ $mform->addRule('password', get_string('required'), 'required', null, 'client');
+ }
+ $mform->addRule('password', get_string('maximumchars', '', 50), 'maxlength', 50, 'server');
+
+ $options = $this->get_groupkey_options();
+ $mform->addElement('select', 'customint1', get_string('groupkey', 'enrol_self'), $options);
+ $mform->addHelpButton('customint1', 'groupkey', 'enrol_self');
+
+ $roles = $this->extend_assignable_roles($context, $instance->roleid);
+ $mform->addElement('select', 'roleid', get_string('role', 'enrol_self'), $roles);
+
+ $options = ['optional' => true, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'enrolperiod', get_string('enrolperiod', 'enrol_self'), $options);
+ $mform->addHelpButton('enrolperiod', 'enrolperiod', 'enrol_self');
+
+ $options = $this->get_expirynotify_options();
+ $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
+ $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
+
+ $options = ['optional' => false, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
+ $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
+ $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
+
+ $options = ['optional' => true];
+ $mform->addElement('date_time_selector', 'enrolstartdate', get_string('enrolstartdate', 'enrol_self'), $options);
+ $mform->setDefault('enrolstartdate', 0);
+ $mform->addHelpButton('enrolstartdate', 'enrolstartdate', 'enrol_self');
+
+ $options = ['optional' => true];
+ $mform->addElement('date_time_selector', 'enrolenddate', get_string('enrolenddate', 'enrol_self'), $options);
+ $mform->setDefault('enrolenddate', 0);
+ $mform->addHelpButton('enrolenddate', 'enrolenddate', 'enrol_self');
+
+ $options = $this->get_longtimenosee_options();
+ $mform->addElement('select', 'customint2', get_string('longtimenosee', 'enrol_self'), $options);
+ $mform->addHelpButton('customint2', 'longtimenosee', 'enrol_self');
+
+ $mform->addElement('text', 'customint3', get_string('maxenrolled', 'enrol_self'));
+ $mform->addHelpButton('customint3', 'maxenrolled', 'enrol_self');
+ $mform->setType('customint3', PARAM_INT);
+
+ require_once($CFG->dirroot.'/cohort/lib.php');
+
+ $cohorts = [0 => get_string('no')];
+ $allcohorts = cohort_get_available_cohorts($context, 0, 0, 0);
+ if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
+ $c = $DB->get_record('cohort',
+ ['id' => $instance->customint5],
+ 'id, name, idnumber, contextid, visible',
+ IGNORE_MISSING);
+ if ($c) {
+ // Current cohort was not found because current user can not see it. Still keep it.
+ $allcohorts[$instance->customint5] = $c;
+ }
+ }
+ foreach ($allcohorts as $c) {
+ $cohorts[$c->id] = format_string($c->name, true, ['context' => context::instance_by_id($c->contextid)]);
+ if ($c->idnumber) {
+ $cohorts[$c->id] .= ' ['.s($c->idnumber).']';
+ }
+ }
+ if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
+ // Somebody deleted a cohort, better keep the wrong value so that random ppl can not enrol.
+ $cohorts[$instance->customint5] = get_string('unknowncohort', 'cohort', $instance->customint5);
+ }
+ if (count($cohorts) > 1) {
+ $mform->addElement('select', 'customint5', get_string('cohortonly', 'enrol_self'), $cohorts);
+ $mform->addHelpButton('customint5', 'cohortonly', 'enrol_self');
+ } else {
+ $mform->addElement('hidden', 'customint5');
+ $mform->setType('customint5', PARAM_INT);
+ $mform->setConstant('customint5', 0);
}
- }
- if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
- // Somebody deleted a cohort, better keep the wrong value so that random ppl can not enrol.
- $cohorts[$instance->customint5] = get_string('unknowncohort', 'cohort', $instance->customint5);
- }
- if (count($cohorts) > 1) {
- $mform->addElement('select', 'customint5', get_string('cohortonly', 'enrol_self'), $cohorts);
- $mform->addHelpButton('customint5', 'cohortonly', 'enrol_self');
- } else {
- $mform->addElement('hidden', 'customint5');
- $mform->setType('customint5', PARAM_INT);
- $mform->setConstant('customint5', 0);
}
- $mform->addElement('select', 'customint4', get_string('sendcoursewelcomemessage', 'enrol_self'),
- enrol_send_welcome_email_options());
- $mform->addHelpButton('customint4', 'sendcoursewelcomemessage', 'enrol_self');
-
- $options = array('cols' => '60', 'rows' => '8');
- $mform->addElement('textarea', 'customtext1', get_string('customwelcomemessage', 'core_enrol'), $options);
- $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
- $mform->hideIf(
- elementname: 'customtext1',
- dependenton: 'customint4',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
+ // Course welcome message.
+ if (has_any_capability(['enrol/self:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $mform->addElement('select', 'customint4', get_string('sendcoursewelcomemessage', 'enrol_self'),
+ enrol_send_welcome_email_options());
+ $mform->addHelpButton('customint4', 'sendcoursewelcomemessage', 'enrol_self');
+
+ $options = [
+ 'cols' => '60',
+ 'rows' => '8',
+ ];
+ $mform->addElement('textarea', 'customtext1', get_string('customwelcomemessage', 'core_enrol'), $options);
+ $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
+ $mform->hideIf(
+ elementname: 'customtext1',
+ dependenton: 'customint4',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
- // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
- // See: https://tracker.moodle.org/browse/MDL-66251.
- $group[] = $mform->createElement(
- 'static',
- 'customwelcomemessage_extra_help',
- null,
- get_string(
- identifier: 'customwelcomemessage_help',
- component: 'core_enrol',
- ),
- );
- $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
- $mform->hideIf(
- elementname: 'group_customwelcomemessage_extra_help',
- dependenton: 'customint4',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
+ // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
+ // See: https://tracker.moodle.org/browse/MDL-66251.
+ $group[] = $mform->createElement(
+ 'static',
+ 'customwelcomemessage_extra_help',
+ null,
+ get_string(
+ identifier: 'customwelcomemessage_help',
+ component: 'core_enrol',
+ ),
+ );
+ $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
+ $mform->hideIf(
+ elementname: 'group_customwelcomemessage_extra_help',
+ dependenton: 'customint4',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
+ }
- if (enrol_accessing_via_instance($instance)) {
+ // Enrolment changes warning.
+ if (has_capability('enrol/self:config', $context) && enrol_accessing_via_instance($instance)) {
$warntext = get_string('instanceeditselfwarningtext', 'core_enrol');
$mform->addElement('static', 'selfwarn', get_string('instanceeditselfwarning', 'core_enrol'), $warntext);
}
diff --git a/enrol/self/tests/behat/welcomemessage.feature b/enrol/self/tests/behat/welcomemessage.feature
index 3cc8e7df22fea..adf2e9f561239 100644
--- a/enrol/self/tests/behat/welcomemessage.feature
+++ b/enrol/self/tests/behat/welcomemessage.feature
@@ -40,6 +40,17 @@ Feature: A course welcome message will be sent to the user when they auto-enrol
And I should not see "Custom welcome message"
And I should not see "Accepted formats: Plain text or Moodle-auto format. HTML tags and multi-lang tags are also accepted, as well as the following placeholders:"
+ @javascript
+ Scenario: Teacher can edit the course welcome message
+ Given I am on the "C1" "Enrolled users" page logged in as teacher
+ And I set the field "Participants tertiary navigation" to "Enrolment methods"
+ When I click on "Edit" "link" in the "Self enrolment" "table_row"
+ Then I should see "Send course welcome message"
+ And I set the field "Custom welcome message" to "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+ And I press "Save changes"
+ And I click on "Edit" "link" in the "Self enrolment" "table_row"
+ And I should see "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+
@javascript
Scenario: Student should not receive a welcome message if the setting is disabled
Given I am on the "C1" "Enrolled users" page logged in as manager
diff --git a/enrol/tests/enrollib_test.php b/enrol/tests/enrollib_test.php
index b19530f672626..654d4fe1e4be6 100644
--- a/enrol/tests/enrollib_test.php
+++ b/enrol/tests/enrollib_test.php
@@ -1739,7 +1739,7 @@ public function test_enrol_selfenrol_available(): void {
/**
* Test the behaviour of validate_enrol_plugin_data().
*
- * @covers ::validate_enrol_plugin_data
+ * @covers \enrol_plugin::validate_enrol_plugin_data
*/
public function test_validate_enrol_plugin_data(): void {
$this->resetAfterTest();
@@ -1761,7 +1761,7 @@ public function test_validate_enrol_plugin_data(): void {
/**
* Test the behaviour of update_enrol_plugin_data().
*
- * @covers ::update_enrol_plugin_data
+ * @covers \enrol_plugin::update_enrol_plugin_data
*/
public function test_update_enrol_plugin_data(): void {
global $DB;
diff --git a/files/classes/reportbuilder/local/entities/file.php b/files/classes/reportbuilder/local/entities/file.php
index 489fe73ef291e..ea6fd5a5eb72d 100644
--- a/files/classes/reportbuilder/local/entities/file.php
+++ b/files/classes/reportbuilder/local/entities/file.php
@@ -425,6 +425,26 @@ protected function get_all_filters(): array {
))
->add_joins($this->get_joins());
+ // Component.
+ $filters[] = (new filter(
+ text::class,
+ 'component',
+ new lang_string('plugin'),
+ $this->get_entity_name(),
+ "{$filesalias}.component"
+ ))
+ ->add_joins($this->get_joins());
+
+ // Area.
+ $filters[] = (new filter(
+ text::class,
+ 'area',
+ new lang_string('pluginarea'),
+ $this->get_entity_name(),
+ "{$filesalias}.filearea"
+ ))
+ ->add_joins($this->get_joins());
+
// Time created.
$filters[] = (new filter(
date::class,
diff --git a/files/tests/reportbuilder/datasource/files_test.php b/files/tests/reportbuilder/datasource/files_test.php
index 246817fff8509..8bc26ac8a3b8a 100644
--- a/files/tests/reportbuilder/datasource/files_test.php
+++ b/files/tests/reportbuilder/datasource/files_test.php
@@ -36,7 +36,7 @@
* @copyright 2022 Paul Holden
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class files_test extends core_reportbuilder_testcase {
+final class files_test extends core_reportbuilder_testcase {
/**
* Test default datasource
@@ -205,7 +205,7 @@ public function test_datasource_non_default_columns(): void {
*
* @return array[]
*/
- public function datasource_filters_provider(): array {
+ public static function datasource_filters_provider(): array {
return [
// File.
'Filter directory' => ['file:directory', [
@@ -247,6 +247,22 @@ public function datasource_filters_provider(): array {
'file:contenthash_operator' => text::IS_EQUAL_TO,
'file:contenthash_value' => 'f00f',
], 0],
+ 'Filter component' => ['file:component', [
+ 'file:component_operator' => text::IS_EQUAL_TO,
+ 'file:component_value' => 'course',
+ ], 2],
+ 'Filter component (no match)' => ['file:component', [
+ 'file:component_operator' => text::IS_EQUAL_TO,
+ 'file:component_value' => 'reportbuilder',
+ ], 0],
+ 'Filter area' => ['file:area', [
+ 'file:area_operator' => text::IS_EQUAL_TO,
+ 'file:area_value' => 'summary',
+ ], 2],
+ 'Filter area (no match)' => ['file:area', [
+ 'file:area_operator' => text::IS_EQUAL_TO,
+ 'file:area_value' => 'report',
+ ], 0],
'Filter time created' => ['file:timecreated', [
'file:timecreated_operator' => date::DATE_RANGE,
'file:timecreated_from' => 1622502000,
diff --git a/grade/grading/form/guide/tests/behat/assign_marking_guide.feature b/grade/grading/form/guide/tests/behat/assign_marking_guide.feature
index 9336cd303b878..ef8ffce9789d8 100644
--- a/grade/grading/form/guide/tests/behat/assign_marking_guide.feature
+++ b/grade/grading/form/guide/tests/behat/assign_marking_guide.feature
@@ -88,7 +88,7 @@ Feature: Display marking guide information to students
And I should not see "Grade Critera 2"
And I am on the "Course 1" "grades > Grader report > View" page
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | 90 |
And I am on the "Assign 1" "assign activity editing" page
And I set the following fields to these values:
diff --git a/grade/grading/form/guide/tests/behat/delete_marking_guide.feature b/grade/grading/form/guide/tests/behat/delete_marking_guide.feature
index 06abc20e352fb..4bbc83d886ab1 100644
--- a/grade/grading/form/guide/tests/behat/delete_marking_guide.feature
+++ b/grade/grading/form/guide/tests/behat/delete_marking_guide.feature
@@ -49,5 +49,5 @@ Feature: Teacher can delete marking guide
And I should not see "Criterion 1"
And I am on the "Course 1" "grades > Grader report > View" page
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student One | student1@example.com | 70 |
diff --git a/grade/grading/form/rubric/tests/behat/edit_rubric.feature b/grade/grading/form/rubric/tests/behat/edit_rubric.feature
index 2c5dc28981824..612bfd534b12d 100644
--- a/grade/grading/form/rubric/tests/behat/edit_rubric.feature
+++ b/grade/grading/form/rubric/tests/behat/edit_rubric.feature
@@ -50,7 +50,9 @@ Feature: Rubrics can be created and edited
Then I should see "Ready for use"
# Grading two students.
And I navigate to "Assignment" in current page administration
+ And I change window size to "large"
And I go to "Student 1" "Test assignment 1 name" activity advanced grading page
+ And I change window size to "medium"
And I grade by filling the rubric with:
| Criterion 1 | 50 | Very good |
And I press "Save changes"
@@ -66,7 +68,9 @@ Feature: Rubrics can be created and edited
And I should see "65" in the "Student 1" "table_row"
# Updating the user grade.
And I am on the "Test assignment 1 name" "assign activity" page
+ And I change window size to "large"
And I go to "Student 1" "Test assignment 1 name" activity advanced grading page
+ And I change window size to "medium"
And I grade by filling the rubric with:
| Criterion 1 | 20 | Bad, I changed my mind |
| Criterion 2 | 10 | Mmmm, you can do it better |
@@ -118,7 +122,9 @@ Feature: Rubrics can be created and edited
And I log out
# Regrade student.
And I am on the "Test assignment 1 name" "assign activity" page logged in as teacher1
+ And I change window size to "large"
And I go to "Student 1" "Test assignment 1 name" activity advanced grading page
+ And I change window size to "medium"
And I should see "The rubric definition was changed after this student had been graded. The student can not see this rubric until you check the rubric and update the grade."
And I save the advanced grading form
And I log out
diff --git a/grade/report/grader/UPGRADING.md b/grade/report/grader/UPGRADING.md
index dd347b7501d5e..e3ff2487d963d 100644
--- a/grade/report/grader/UPGRADING.md
+++ b/grade/report/grader/UPGRADING.md
@@ -7,4 +7,3 @@
- The `gradereport_grader/group` ESM has been deprecated. Please use `core_course/actionbar/group` instead.
For more information see [MDL-80745](https://tracker.moodle.org/browse/MDL-80745)
-
diff --git a/grade/report/grader/tests/behat/switch_views.feature b/grade/report/grader/tests/behat/switch_views.feature
index 8560e94ac0f2d..d493e43a746d5 100644
--- a/grade/report/grader/tests/behat/switch_views.feature
+++ b/grade/report/grader/tests/behat/switch_views.feature
@@ -48,7 +48,7 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- | -6- |
+ | -1- | -2- | -3- | -4- | -5- | -6- |
| Student 1 | student1@example.com | 80 | 90 | 30 | 170 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
And I choose "Show totals only" in the open action menu
@@ -57,7 +57,7 @@ Feature: We can change what we are viewing on the grader report
And I should not see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | 170 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
And I click on "Show grades only" "link"
@@ -66,7 +66,7 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should not see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | 80 | 90 | 30 |
@javascript @skip_chrome_zerosize
@@ -83,7 +83,7 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- | -6- |
+ | -1- | -2- | -3- | -4- | -5- | -6- |
| Student 1 | student1@example.com | 80 | - | 30 | 105.71 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
And I choose "Show totals only" in the open action menu
@@ -92,7 +92,7 @@ Feature: We can change what we are viewing on the grader report
And I should not see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | 105.71 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
When I click on "Show grades only" "link"
@@ -101,5 +101,5 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should not see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | 80 | - | 30 |
diff --git a/grade/report/grader/tests/behat/tertiary_name_filter.feature b/grade/report/grader/tests/behat/tertiary_name_filter.feature
index ae82f47d565b6..f962bf861eb3b 100644
--- a/grade/report/grader/tests/behat/tertiary_name_filter.feature
+++ b/grade/report/grader/tests/behat/tertiary_name_filter.feature
@@ -156,10 +156,10 @@ Feature: Within the grader report, test that we can open our generic filter drop
When I press "Apply"
And the field "Search users" matches value "Student 1"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Teacher 1 | teacher1@example.com | - |
| Dummy User | student2@example.com | - |
| User Example | student3@example.com | - |
@@ -169,7 +169,7 @@ Feature: Within the grader report, test that we can open our generic filter drop
And I select "M" in the "First name" "core_grades > initials bar"
And I press "Apply"
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
| Teacher 1 | teacher1@example.com | - |
| Dummy User | student2@example.com | - |
@@ -181,12 +181,12 @@ Feature: Within the grader report, test that we can open our generic filter drop
Given I set the field "Search users" to "User"
And I click on "View all results (3)" "option_role"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| User Example | student3@example.com | - |
| User Test | student4@example.com | - |
| Dummy User | student2@example.com | - |
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
| Teacher 1 | teacher1@example.com | - |
| Turtle Manatee | student5@example.com | - |
@@ -194,10 +194,10 @@ Feature: Within the grader report, test that we can open our generic filter drop
And I select "E" in the "Last name" "core_grades > initials bar"
And I press "Apply"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| User Example | student3@example.com | - |
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
| Teacher 1 | teacher1@example.com | - |
| Dummy User | student2@example.com | - |
diff --git a/grade/report/grader/tests/behat/tertiary_navigation_searching.feature b/grade/report/grader/tests/behat/tertiary_navigation_searching.feature
index b9319b3f7dea9..3f787e7a89c2b 100644
--- a/grade/report/grader/tests/behat/tertiary_navigation_searching.feature
+++ b/grade/report/grader/tests/behat/tertiary_navigation_searching.feature
@@ -274,6 +274,8 @@ Feature: Within the grader report, test that we can search for users
And I press the up key
And I press the enter key
And I wait to be redirected
+ # Sometimes with behat we get unattached nodes causing spurious failures.
+ And I wait "1" seconds
And the following should exist in the "user-grades" table:
| -1- |
| Dummy User |
@@ -284,6 +286,13 @@ Feature: Within the grader report, test that we can search for users
| Teacher 1 |
| Student 1 |
| Turtle Manatee |
+ And I set the field "Search users" to "ABC"
+ And I wait until "Turtle Manatee" "option_role" exists
+ And I press the tab key
+ And the focused element is "Clear search input" "button"
+ And I press the enter key
+ And I wait until the page is ready
+ And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist
Scenario: Once a teacher searches, it'll apply the currently set filters and inform the teacher as such
# Set up a basic filtering case.
diff --git a/grade/report/history/tests/behat/basic_functionality.feature b/grade/report/history/tests/behat/basic_functionality.feature
index 0889b4e176b43..8e2ca357014fa 100644
--- a/grade/report/history/tests/behat/basic_functionality.feature
+++ b/grade/report/history/tests/behat/basic_functionality.feature
@@ -51,7 +51,7 @@ Feature: A teacher checks the grade history report in a course
And I navigate to "View > Grade history" in the course gradebook
When I press "Submit"
Then the following should exist in the "gradereport_history" table:
- | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
+ | First name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
| Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 |
| Student 1 | student1@example.com | apple | Rewarding assignment | | 60.00 | Teacher 1 |
| Student 2 | student2@example.com | orange | The greatest assignment ever | | 50.00 | Teacher 1 |
@@ -79,7 +79,7 @@ Feature: A teacher checks the grade history report in a course
And I press "Finish selecting users"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Grade item | Original grade | Revised grade | Grader |
+ | First name | Grade item | Original grade | Revised grade | Grader |
| Student 1 | The greatest assignment ever | | 50.00 | Teacher 1 |
| Student 1 | Rewarding assignment | | 60.00 | Teacher 1 |
| Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 |
@@ -96,7 +96,7 @@ Feature: A teacher checks the grade history report in a course
And I set the field "Grade item" to "The greatest assignment ever"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Grade item | Original grade | Revised grade | Grader |
+ | First name | Grade item | Original grade | Revised grade | Grader |
| Student 1 | The greatest assignment ever | | 50.00 | Teacher 1 |
| Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 |
And the following should not exist in the "gradereport_history" table:
@@ -106,7 +106,7 @@ Feature: A teacher checks the grade history report in a course
And I set the field "Grader" to "Teacher 1"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
+ | First name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
| Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 |
And the following should not exist in the "gradereport_history" table:
| Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 |
@@ -114,5 +114,5 @@ Feature: A teacher checks the grade history report in a course
And I click on "id_revisedonly" "checkbox"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
+ | First name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
| Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 |
diff --git a/grade/report/singleview/UPGRADING.md b/grade/report/singleview/UPGRADING.md
index 6a803b14c835e..81a92440a906a 100644
--- a/grade/report/singleview/UPGRADING.md
+++ b/grade/report/singleview/UPGRADING.md
@@ -7,4 +7,3 @@
- The `gradereport_singleview/group` ESM has been deprecated. Please use `core_course/actionbar/group` instead.
For more information see [MDL-80745](https://tracker.moodle.org/browse/MDL-80745)
-
diff --git a/grade/report/singleview/tests/behat/singleview.feature b/grade/report/singleview/tests/behat/singleview.feature
index 1cb9f29b24c01..5475a4204fb5c 100644
--- a/grade/report/singleview/tests/behat/singleview.feature
+++ b/grade/report/singleview/tests/behat/singleview.feature
@@ -93,7 +93,7 @@ Feature: We can use Single view
And I press "Save"
Then I should see "Grades were set for 1 items"
And the following should exist in the "generaltable" table:
- | First name (Alternate name) Last name | Grade |
+ | User full name | Grade |
| Ann, Jill, Grainne, Beauchamp | Very good |
And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher2"
And I click on "Users" "link" in the ".page-toggler" "css_element"
diff --git a/grade/report/user/UPGRADING.md b/grade/report/user/UPGRADING.md
index f51b1c6f5807a..8b6be52ad1456 100644
--- a/grade/report/user/UPGRADING.md
+++ b/grade/report/user/UPGRADING.md
@@ -7,4 +7,3 @@
- The `gradereport_user/group` ESM has been deprecated. Please use `core_course/actionbar/group` instead.
For more information see [MDL-80745](https://tracker.moodle.org/browse/MDL-80745)
-
diff --git a/grade/tests/behat/grade_import.feature b/grade/tests/behat/grade_import.feature
index 2aa019a20781d..3025e85b5078d 100644
--- a/grade/tests/behat/grade_import.feature
+++ b/grade/tests/behat/grade_import.feature
@@ -61,7 +61,7 @@ Feature: An admin can import grades into gradebook using a CSV file
And I should see "Grade import success"
And I click on "Continue" "button"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- |
+ | -1- | -2- | -3- | -4- |
| Student 1 | student1@example.com | 400.00 | 400.00 |
| Student 2 | student2@example.com | 50.00 | 50.00 |
| Student 3 | student3@example.com | 50.00 | 50.00 |
@@ -82,7 +82,7 @@ Feature: An admin can import grades into gradebook using a CSV file
And I should see "Grade import success"
And I click on "Continue" "button"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- | -6- | -7- | -8- |
+ | -1- | -2- | -3- | -4- | -5- | -6- | -7- | -8- |
| Student 1 | student1@example.com | 50.00 | 11.00 | 12.00 | 13.00 | 14.00 | 100.00 |
| Student 2 | student2@example.com | 50.00 | 21.00 | 22.00 | 23.00 | 24.00 | 140.00 |
| Student 3 | student3@example.com | 50.00 | 31.00 | 32.00 | 33.00 | 34.00 | 180.00 |
diff --git a/grade/tests/behat/grade_letter_boundary.feature b/grade/tests/behat/grade_letter_boundary.feature
index 2cf197229302a..7265ffbbe49c8 100644
--- a/grade/tests/behat/grade_letter_boundary.feature
+++ b/grade/tests/behat/grade_letter_boundary.feature
@@ -37,5 +37,5 @@ Feature: We can customise the letter boundary of a course.
And I am on "Course 1" course homepage with editing mode off
And I navigate to "View > Grader report" in the course gradebook
Then the following should exist in the "user-grades" table:
- | -1- | -1- |-3- | -4- |
+ | -1- | -2- |-3- | -4- |
| Student 1 | student1@example.com | D | D |
diff --git a/grade/tests/behat/grade_letter_boundary_20160518.feature b/grade/tests/behat/grade_letter_boundary_20160518.feature
index 9c6636e983733..a984da8d62b4d 100644
--- a/grade/tests/behat/grade_letter_boundary_20160518.feature
+++ b/grade/tests/behat/grade_letter_boundary_20160518.feature
@@ -38,5 +38,5 @@ Feature: We can customise the letter boundary of a course in gradebook version 2
And I am on "Course 1" course homepage with editing mode off
And I navigate to "View > Grader report" in the course gradebook
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- |
+ | -1- | -2- | -3- | -4- |
| Student 1 | student1@example.com | F | F |
diff --git a/grade/tests/behat/grade_regrade_do_not_override.feature b/grade/tests/behat/grade_regrade_do_not_override.feature
index d20e68ed24c96..0dd89994422b9 100644
--- a/grade/tests/behat/grade_regrade_do_not_override.feature
+++ b/grade/tests/behat/grade_regrade_do_not_override.feature
@@ -32,8 +32,8 @@ Feature: Regrading grades does not unnecessarily mark some as overriden
And I press "Save changes"
And I am on the "Course 1" "grades > Grader report > View" page
And the following should exist in the "gradereport-grader-table" table:
- | | | |
- | First name / Last name | Assignment 1 | Course total |
+ | -1- | -3- | -4- |
+ | First name | Assignment 1 | Course total |
| Student 1 | 80.00 | 80.00 |
| Student 2 | 60.00 | 60.00 |
And I turn editing mode on
@@ -64,7 +64,7 @@ Feature: Regrading grades does not unnecessarily mark some as overriden
When I am on the "Course 1" "grades > Grader report > View" page
And I turn editing mode off
Then the following should exist in the "gradereport-grader-table" table:
- | | | |
- | First name / Last name | Assignment 1 | Course total |
+ | -1- | -3- | -4- |
+ | First name | Assignment 1 | Course total |
| Student 1 | 90.00 | 180.00 |
| Student 2 | 70.00 | 160.00 |
diff --git a/grade/tests/behat/grade_scales.feature b/grade/tests/behat/grade_scales.feature
index 64d126751981b..fee7dd54f357a 100644
--- a/grade/tests/behat/grade_scales.feature
+++ b/grade/tests/behat/grade_scales.feature
@@ -73,7 +73,7 @@ Feature: View gradebook when scales are used
Scenario: Test displaying scales in gradebook in aggregation method Natural
When I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | A | 5.00 | 5.00 |
| Student 2 | student2@example.com | B | 4.00 | 4.00 |
| Student 3 | student3@example.com | C | 3.00 | 3.00 |
@@ -116,7 +116,7 @@ Feature: View gradebook when scales are used
| Minimum grade | 1 |
And I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | A | 5.00 | |
| Student 2 | student2@example.com | B | 4.00 | |
| Student 3 | student3@example.com | C | 3.00 | |
diff --git a/grade/tests/behat/grade_single_item_scales.feature b/grade/tests/behat/grade_single_item_scales.feature
index 18889649ce487..16024ed456d80 100644
--- a/grade/tests/behat/grade_single_item_scales.feature
+++ b/grade/tests/behat/grade_single_item_scales.feature
@@ -58,7 +58,7 @@ Feature: View gradebook when single item scales are used
Scenario: Test displaying single item scales in gradebook in aggregation method Natural
When I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | Ace! | 1.00 | 1.00 |
And the following should exist in the "user-grades" table:
| -1- | -2- | -3- | -4- |
@@ -92,7 +92,7 @@ Feature: View gradebook when single item scales are used
| Category name | Sub category () |
And I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | Ace! | | |
| Student 2 | student2@example.com | - | - | - |
And the following should exist in the "user-grades" table:
diff --git a/grade/tests/behat/toggle_grade_categories.feature b/grade/tests/behat/toggle_grade_categories.feature
index 3eed4f6f0f3df..0e2e47445f0f1 100644
--- a/grade/tests/behat/toggle_grade_categories.feature
+++ b/grade/tests/behat/toggle_grade_categories.feature
@@ -78,14 +78,12 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course |
And I should see "Course" in the "setup-grades" "table"
And "Expand" "link" should exist in the "Course" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment one |
- | Category 1 |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
- | Course total |
+ And I should not see "Test assignment one" in the "setup-grades" "table"
+ And I should not see "Category 1" in the "setup-grades" "table"
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
+ And I should not see "Course total" in the "setup-grades" "table"
# Expand the grade category 'Course'. 'Category 1' should be still collapsed.
And I click on "Expand" "link" in the "Course" "table_row"
And the following should exist in the "setup-grades" table:
@@ -96,11 +94,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course total |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: A teacher can see the aggregated max grade for a grade category even when the category is collapsed
Given the following should exist in the "setup-grades" table:
@@ -150,11 +146,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Category 1 |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
# Expand the grade category 'Category 1'.
And I click on "Expand" "link" in the "Category 1" "table_row"
And the following should exist in the "setup-grades" table:
@@ -172,12 +166,10 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
And I click on "Collapse" "link" in the "Course" "table_row"
And I should see "Course" in the "setup-grades" "table"
And "Expand" "link" should exist in the "Course" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment one |
- | Category 1 |
- | Test assignment two |
- | Manual grade |
+ And I should not see "Test assignment one" in the "setup-grades" "table"
+ And I should not see "Category 1" in the "setup-grades" "table"
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
# Expand the grade category 'Course'. 'Category 1' should be still collapsed.
And I click on "Expand" "link" in the "Course" "table_row"
And the following should exist in the "setup-grades" table:
@@ -187,11 +179,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Category 1 |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: Previously collapsed categories are still shown as collapsed when a teacher navigates back to Gradebook setup
# Collapse the grade category 'Category 1' and navigate to the course homepage.
@@ -206,11 +196,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course total |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: Previously collapsed categories are still shown as collapsed when a teacher is moving grade items in Gradebook setup
# Collapse the grade category 'Category 1'.
@@ -224,11 +212,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Category 1 |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: Grade categories are shown as collapsed only to the teacher that collapsed them
# Collapse the grade category 'Category 1'.
@@ -256,8 +242,6 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course total |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
diff --git a/grade/tests/external/get_feedback_test.php b/grade/tests/external/get_feedback_test.php
index 9c90734ab686f..66c0fb064ce95 100644
--- a/grade/tests/external/get_feedback_test.php
+++ b/grade/tests/external/get_feedback_test.php
@@ -30,13 +30,13 @@
* @copyright 2023 Kevin Percy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 4.2
+ * @covers \core_grades\external\get_feedback
*/
class get_feedback_test extends \externallib_advanced_testcase {
/**
* Test get_feedback.
*
- * @covers ::get_feedback
* @dataProvider get_feedback_provider
* @param string|null $feedback The feedback text added for the grade item.
* @param array $expected The expected feedback data.
@@ -103,7 +103,6 @@ public function get_feedback_provider(): array {
/**
* Test get_feedback with invalid requests.
*
- * @covers ::get_feedback
* @dataProvider get_feedback_invalid_request_provider
* @param string $loggeduserrole The role of the logged user.
* @param bool $feedbacknotincourse Whether to request a feedback for a grade item which is not a part of the course.
diff --git a/grade/tests/external/get_grade_tree_test.php b/grade/tests/external/get_grade_tree_test.php
index 8f6c4df747310..50501a928e03a 100644
--- a/grade/tests/external/get_grade_tree_test.php
+++ b/grade/tests/external/get_grade_tree_test.php
@@ -37,7 +37,6 @@ class get_grade_tree_test extends \externallib_advanced_testcase {
/**
* Test the return value of the external function.
*
- * @covers ::execute
* @return void
*/
public function test_execute(): void {
diff --git a/group/tests/behat/private_groups.feature b/group/tests/behat/private_groups.feature
index 87f9db427f1ac..3d8b665523946 100644
--- a/group/tests/behat/private_groups.feature
+++ b/group/tests/behat/private_groups.feature
@@ -56,7 +56,7 @@ Feature: Private groups
Scenario: Participants in "Visible" groups see their membership and other members:
Given I am on the "C1" "enrolled users" page logged in as "student1"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 3 | No groups |
@@ -69,7 +69,7 @@ Feature: Private groups
Scenario: Participants in "Only visible to members" groups see their membership and other members, plus "Visible"
Given I am on the "C1" "enrolled users" page logged in as "student2"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | Only visible to members/Non-Participation, Only visible to members/Participation |
| Student 3 | No groups |
@@ -82,7 +82,7 @@ Feature: Private groups
Scenario: Participants in "Only see own membership" groups see their membership but not other members, plus "Visible"
Given I am on the "C1" "enrolled users" page logged in as "student3"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 3 | Only see own membership |
@@ -95,7 +95,7 @@ Feature: Private groups
Scenario: Participants in "Not visible" groups do not see that group, do see "Visible"
Given I am on the "C1" "enrolled users" page logged in as "student4"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 3 | No groups |
@@ -108,7 +108,7 @@ Feature: Private groups
Scenario: View participants list as a teacher:
Given I am on the "C1" "enrolled users" page logged in as "teacher1"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | Only visible to members/Non-Participation, Only visible to members/Participation |
| Student 3 | Only see own membership |
@@ -125,10 +125,10 @@ Feature: Private groups
And I set the field "Type or select..." to "Only see own membership"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 3 | Only see own membership |
And the following should not exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 7 | No groups |
@javascript
@@ -138,7 +138,7 @@ Feature: Private groups
And I set the field "Type or select..." to "No group"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 2 | No groups |
| Student 4 | No groups |
| Student 6 | No groups |
@@ -153,7 +153,7 @@ Feature: Private groups
And I set the field "Type or select..." to "Only see own membership"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 4 | No groups |
@@ -170,7 +170,7 @@ Feature: Private groups
And I set the field "Type or select..." to "No group"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 3 | Only see own membership |
| Student 5 | Visible/Non-Participation, Visible/Participation |
diff --git a/group/tests/lib_test.php b/group/tests/lib_test.php
index 0fc33bae68825..ad6ad471a8cb4 100644
--- a/group/tests/lib_test.php
+++ b/group/tests/lib_test.php
@@ -883,7 +883,7 @@ public function test_groups_get_members_by_role(): void {
/**
* Tests set_groups_messaging
*
- * @covers \core_group::set_groups_messaging
+ * @covers ::set_groups_messaging
*/
public function test_set_groups_messaging(): void {
$this->resetAfterTest();
@@ -923,7 +923,7 @@ public function test_set_groups_messaging(): void {
/**
* Tests set group messaging where it doesn't exist
*
- * @covers \core_group::set_groups_messaging
+ * @covers ::set_groups_messaging
*/
public function test_set_groups_messaging_doesnt_exist(): void {
$this->resetAfterTest();
diff --git a/h5p/tests/file_storage_test.php b/h5p/tests/file_storage_test.php
index 065f0e516c220..23605719cd91b 100644
--- a/h5p/tests/file_storage_test.php
+++ b/h5p/tests/file_storage_test.php
@@ -33,6 +33,7 @@
* @copyright 2019 Victor Deniz
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @runTestsInSeparateProcesses
+ * @covers \core_h5p\file_storage
*/
class file_storage_test extends \advanced_testcase {
@@ -847,8 +848,6 @@ public function test_removeContentFile(): void {
/**
* Test H5P custom styles generation.
- *
- * @covers ::generate_custom_styles
*/
public function test_generate_custom_styles(): void {
\set_config('h5pcustomcss', '.debug { color: #fab; }', 'core_h5p');
@@ -895,8 +894,6 @@ public function test_generate_custom_styles(): void {
/**
* Test H5P custom styles retrieval.
- *
- * @covers ::get_custom_styles
*/
public function test_get_custom_styles(): void {
global $CFG;
diff --git a/h5p/tests/framework_test.php b/h5p/tests/framework_test.php
index b0b7aaaebfcaa..3200f8c985ea7 100644
--- a/h5p/tests/framework_test.php
+++ b/h5p/tests/framework_test.php
@@ -1099,8 +1099,6 @@ public function test_updateContent(): void {
/**
* Test the behaviour of updateContent() with metadata.
- *
- * @covers ::updateContent
*/
public function test_updateContent_withmetadata(): void {
global $DB;
diff --git a/h5p/tests/helper_test.php b/h5p/tests/helper_test.php
index d1aef73a0d399..afc2bf3cd9606 100644
--- a/h5p/tests/helper_test.php
+++ b/h5p/tests/helper_test.php
@@ -205,7 +205,6 @@ public function test_save_h5p_existing_libraries(): void {
* Test the behaviour of save_h5p() when the H5P file contains metadata.
*
* @runInSeparateProcess
- * @covers ::save_h5p
*/
public function test_save_h5p_metadata(): void {
global $DB;
diff --git a/install/lang/de_kids/langconfig.php b/install/lang/de_kids/langconfig.php
index 32a2d5992ec34..7b5842a1696f0 100644
--- a/install/lang/de_kids/langconfig.php
+++ b/install/lang/de_kids/langconfig.php
@@ -31,4 +31,4 @@
$string['parentlanguage'] = 'de_du';
$string['thisdirection'] = 'ltr';
-$string['thislanguage'] = 'Deutsch (kids)';
+$string['thislanguage'] = 'Deutsch';
diff --git a/install/lang/el_kids/langconfig.php b/install/lang/el_kids/langconfig.php
index 00def5ad34895..644ca01059a55 100644
--- a/install/lang/el_kids/langconfig.php
+++ b/install/lang/el_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'el';
-$string['thislanguage'] = 'Ελληνικά για παιδιά';
+$string['thislanguage'] = 'Ελληνικά';
diff --git a/install/lang/en_kids/langconfig.php b/install/lang/en_kids/langconfig.php
index 64bfc834f0fc5..5016ecaeff711 100644
--- a/install/lang/en_kids/langconfig.php
+++ b/install/lang/en_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'en';
-$string['thislanguage'] = 'English (kids)';
+$string['thislanguage'] = 'English';
diff --git a/install/lang/es_mx_kids/langconfig.php b/install/lang/es_mx_kids/langconfig.php
index 662a0b2075e3f..77f53f4229e24 100644
--- a/install/lang/es_mx_kids/langconfig.php
+++ b/install/lang/es_mx_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'es_mx';
-$string['thislanguage'] = 'Español - México para niños';
+$string['thislanguage'] = 'Español - México';
diff --git a/install/lang/ja_kids/langconfig.php b/install/lang/ja_kids/langconfig.php
index 6cc9bce34805b..13d08143fd076 100644
--- a/install/lang/ja_kids/langconfig.php
+++ b/install/lang/ja_kids/langconfig.php
@@ -31,4 +31,4 @@
$string['parentlanguage'] = 'ja';
$string['thisdirection'] = 'ltr';
-$string['thislanguage'] = 'Japanese (kids)';
+$string['thislanguage'] = 'Japanese';
diff --git a/install/lang/pt_br_kids/langconfig.php b/install/lang/pt_br_kids/langconfig.php
index 5151effc71e86..cc172aea0ca5d 100644
--- a/install/lang/pt_br_kids/langconfig.php
+++ b/install/lang/pt_br_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'pt_br';
-$string['thislanguage'] = 'Português Brasil para Crianças';
+$string['thislanguage'] = 'Português Brasil';
diff --git a/lang/en/admin.php b/lang/en/admin.php
index 664b9790dc73b..be392c748380c 100644
--- a/lang/en/admin.php
+++ b/lang/en/admin.php
@@ -286,7 +286,7 @@
$string['configfullnamedisplay'] = 'This defines how names are shown when they are displayed in full. The default value, "language", leaves it to the string "fullnamedisplay" in the current language pack to decide. Some languages have different name display conventions.
For most mono-lingual sites the most efficient setting is "firstname lastname", but you may choose to hide last names altogether. Placeholders that can be used are: firstname, lastname, firstnamephonetic, lastnamephonetic, middlename, and alternatename.';
-$string['configgeoipfile'] = 'Location of GeoLite2 City binary data file. This file is not part of Moodle distribution and must be obtained separately from MaxMind. You can either buy a commercial version or use the free version. You\'ll need to register to download the City database file, which you can do at https://dev.maxmind.com/geoip/geoip2/geolite2/. Once you\'ve registered and downloaded the file, extract it into "{$a}" directory on your server.';
+$string['configgeoipfile'] = 'Location of GeoIP City binary data file. This file is not part of Moodle distribution and must be obtained separately from MaxMind. You can either buy a commercial version or use the free version. You\'ll need to register to download the City database file, which you can do at https://dev.maxmind.com/geoip/geoip2/geolite2/. Once you\'ve registered and downloaded the file, extract it into "{$a}" directory on your server.';
$string['configgetremoteaddrconf'] = 'If your server is behind a reverse proxy, you can use this setting to specify which HTTP headers can be trusted to contain the remote IP address. The headers are read in order, using the first one that is available.';
$string['configgradebookroles'] = 'This setting allows you to control who appears on the gradebook. Users need to have at least one of these roles in a course to be shown in the gradebook for that course.';
$string['configgradeexport'] = 'Choose which gradebook export formats are your primary methods for exporting grades. Chosen plugins will then set and use a "last exported" field for every grade. For example, this might result in exported records being identified as being "new" or "updated". If you are not sure about this then leave everything unchecked.';
@@ -690,7 +690,13 @@
$string['fullnamedisplayprivate'] = 'Full name format - private';
$string['gdrequired'] = 'The GD extension is now required by Moodle for image conversion.';
$string['generalsettings'] = 'General settings';
-$string['geoipfile'] = 'GeoLite2 City MaxMind DB';
+$string['geoipdbedition'] = 'GeoIP Database Edition';
+$string['geoipdbedition_desc'] = 'Select the edition of the GeoIP database to download. Please be aware that using the GeoIP2-City database requires a valid paid license.';
+$string['geoipfile'] = 'GeoIP City DB';
+$string['geoipmaxmindaccid'] = 'MaxMind account ID';
+$string['geoipmaxmindaccid_desc'] = 'The account ID of the account created on the MaxMind API service.';
+$string['geoipmaxmindlicensekey'] = 'MaxMind license key';
+$string['geoipmaxmindlicensekey_desc'] = 'The license key of the account created on the MaxMind API service.';
$string['getremoteaddrconf'] = 'Logged IP address source';
$string['globalsearch'] = 'Global search';
$string['globalsearchmanage'] = 'Manage global search';
@@ -775,10 +781,10 @@
$string['ipblocker'] = 'IP blocker';
$string['ipblockersyntax'] = 'Put every entry on one line. Valid entries are either full IP address (such as 192.168.10.1) which matches a single host; or partial address (such as 192.168) which matches any address starting with those numbers; or CIDR notation (such as 231.54.211.0/20); or a range of IP addresses (such as 231.3.56.10-20) where the range applies to the last part of the address. Text domain names (like \'example.com\') are not supported. Blank lines, and text following a "#" character are ignored.';
$string['iplookup'] = 'IP address lookup';
-$string['iplookupgeoplugin'] = 'The geoPlugin service is currently being used to look up geographical information. For more accurate results we recommend installing a local copy of the MaxMind GeoLite database.';
-$string['iplookupinfo'] = 'The free online NetGeo server is used to look up IP address locations. The database is not maintained any more though, and may return incorrect data. Installing a local copy of the free GeoLite2 City database from MaxMind is recommended.
+$string['iplookupgeoplugin'] = 'The geoPlugin service is currently being used to look up geographical information. For more accurate results we recommend installing a local copy of the MaxMind GeoIP City database.';
+$string['iplookupinfo'] = 'The free online NetGeo server is used to look up IP address locations. The database is not maintained any more though, and may return incorrect data. Installing a local copy of a GeoIP database from MaxMind is recommended.
If a Google Maps API V3 key is provided, IP address location is displayed using Google Maps. You need a Google account and to apply for a Google Maps API key. If no Google Maps API V3 key is provided, IP address location is displayed using OpenStreetMap.';
-$string['iplookupmaxmindnote'] = 'This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.';
+$string['iplookupmaxmindnote'] = 'This product includes GeoIP City data created by MaxMind, available from https://www.maxmind.com.';
$string['iscustomadminwarnings'] = 'It has been detected that your site is using a custom admin directory. This feature is no longer supported and will be removed after Moodle 4.2.';
$string['ishttpswarning'] = 'It has been detected that your site is not secured using HTTPS. It is strongly recommended to migrate your site to HTTPS for increased security and improved integration with other systems.';
$string['keeptagnamecase'] = 'Keep tag name casing';
@@ -1436,6 +1442,7 @@
$string['taskstatscron'] = 'Background processing for statistics';
$string['tasktagcron'] = 'Background processing for tags';
$string['tasktempfilecleanup'] = 'Delete stale temp files';
+$string['taskupdategeoip2file'] = 'Update GeoIP file';
$string['tempdatafoldercleanup'] = 'Clean up temporary data files older than';
$string['templates'] = 'Templates';
$string['testoutgoingmailconf'] = 'Test outgoing mail configuration';
diff --git a/lang/en/backup.php b/lang/en/backup.php
index 9fa54d69ea646..8a9002a0488af 100644
--- a/lang/en/backup.php
+++ b/lang/en/backup.php
@@ -198,6 +198,7 @@
$string['enterasearch'] = 'Enter a search';
$string['error_block_for_module_not_found'] = 'Orphan block instance (id: {$a->bid}) for course module (id: {$a->mid}) found. This block will not be backed up';
$string['error_course_module_not_found'] = 'Orphan course module (id: {$a}) found. This module will not be backed up.';
+$string['error_delegate_section_not_found'] = 'Missing delegate section form course module (id: {$a}. The section will not be backed up.';
$string['errorcopyingbackupfile'] = "Failed to copy the backup file to the temporary folder before restoring.";
$string['errorfilenamerequired'] = 'You must enter a valid filename for this backup';
$string['errorfilenametoolong'] = 'The filename must be less than 255 characters in length.';
@@ -416,6 +417,7 @@
$string['skipmodifprev'] = 'Skip courses not modified since previous backup';
$string['skipmodifprevhelp'] = 'Choose whether to skip courses that have not been modified since the last automatic backup. This requires logging to be enabled.';
$string['status'] = 'Status';
+$string['subsectioncontent'] = 'Subsection content';
$string['successful'] = 'Backup successful';
$string['successfulcopy'] = 'Copy successful';
$string['successfulrestore'] = 'Restore successful';
diff --git a/lang/en/calendar.php b/lang/en/calendar.php
index f922d5d46d90d..694efe548bf09 100644
--- a/lang/en/calendar.php
+++ b/lang/en/calendar.php
@@ -168,7 +168,6 @@
$string['hideeventtype'] = 'Hide {$a} events';
$string['showeventtype'] = 'Show {$a} events';
$string['hourly'] = 'Hourly';
-$string['importcalendarexternal'] = 'Import an external calendar?';
$string['importcalendar'] = 'Import calendar';
$string['importcalendarheading'] = 'Import calendar...';
$string['importcalendarfrom'] = 'Import from';
@@ -193,9 +192,9 @@
$string['never'] = 'Never';
$string['newevent'] = 'New event';
$string['newmonthannouncement'] = 'Calendar is now set to {$a}.';
+$string['nocalendarsubscriptionsimportexternal'] = 'No calendar subscriptions yet. Import an external calendar';
$string['notitle'] = 'no title';
$string['noupcomingevents'] = 'There are no upcoming events';
-$string['nocalendarsubscriptions'] = 'No calendar subscriptions yet. Do you want to {$a}';
$string['oneevent'] = '1 event';
$string['pollinterval'] = 'Update interval';
$string['pollinterval_help'] = 'How often you would like the calendar to update with new events.';
@@ -287,3 +286,7 @@
// Deprecated since Moodle 4.4.
$string['coursecalendar'] = '{$a} calendar';
+
+// Deprecated since Moodle 4.5.
+$string['importcalendarexternal'] = 'Import an external calendar?';
+$string['nocalendarsubscriptions'] = 'No calendar subscriptions yet. Do you want to {$a}';
diff --git a/lang/en/cohort.php b/lang/en/cohort.php
index b913521a1c03a..93c94e0f20536 100644
--- a/lang/en/cohort.php
+++ b/lang/en/cohort.php
@@ -47,6 +47,7 @@
$string['currentusersmatching'] = 'Current users matching';
$string['defaultcontext'] = 'Default context';
$string['delcohort'] = 'Delete cohort';
+$string['delcohortsconfirm'] = 'Do you really want to delete the selected cohorts?';
$string['delconfirm'] = 'Do you really want to delete cohort \'{$a}\'?';
$string['description'] = 'Description';
$string['displayedrows'] = '{$a->displayed} rows displayed out of {$a->total}.';
diff --git a/lang/en/deprecated.txt b/lang/en/deprecated.txt
index 31c9828e288d2..b934616128dbf 100644
--- a/lang/en/deprecated.txt
+++ b/lang/en/deprecated.txt
@@ -113,4 +113,6 @@ coursesearch_help,core
blocknotexist,core_debug
modulenotexist,core_debug
coursecalendar,core_calendar
+importcalendarexternal,core_calendar
+nocalendarsubscriptions,core_calendar
datechanged,core
diff --git a/lang/en/error.php b/lang/en/error.php
index 09764f33a61d3..9de16f6fe16f9 100644
--- a/lang/en/error.php
+++ b/lang/en/error.php
@@ -96,7 +96,7 @@
$string['cannotfindlang'] = 'Cannot find "{$a}" language pack!';
$string['cannotfindteacher'] = 'Cannot find teacher';
$string['cannotfinduser'] = 'Cannot find user named "{$a}"';
-$string['cannotgeoplugin'] = 'Cannot connect to the geoPlugin server at https://www.geoplugin.com. Please check your proxy settings or install the MaxMind GeoLite City data file.';
+$string['cannotgeoplugin'] = 'Cannot connect to the geoPlugin server at https://www.geoplugin.com. Please check your proxy settings or install the MaxMind GeoIP City data file.';
$string['cannotgetblock'] = 'Could not retrieve blocks from the database';
$string['cannotgetcats'] = 'Cannot get category record';
$string['cannotgetdata'] = 'Cannot get data';
diff --git a/lang/en/moodle.php b/lang/en/moodle.php
index 13d916783acee..9a27682c6c309 100644
--- a/lang/en/moodle.php
+++ b/lang/en/moodle.php
@@ -1863,7 +1863,12 @@
$string['reset'] = 'Reset';
$string['resetcomponent'] = 'Component';
$string['resetcourse'] = 'Reset course';
-$string['resetinfo'] = 'Delete all user data and reset this course to its original state, keeping activities and settings intact.';
+$string['resetcourseconfirm'] = 'Reset course?';
+$string['resetcoursewarning'] = 'Are you sure you want to reset the course \'{$a}\'?
+
+This will delete the selected data and reset the course back to its original state. You can\'t undo this action.';
+$string['resetinfo'] = 'This feature allows you to clear all user data and reset the course to its original state. Course activities and settings will remain untouched.';
+$string['resetinfoselect'] = 'Select the data you want to delete or reset from the categories below:';
$string['resetnotimplemented'] = 'Reset not supported';
$string['resetnotimplementedinfo'] = 'These activities can\'t be reset:';
$string['resetrecordexpired'] = 'The password reset link you used is more than {$a} minutes old and has expired. Please initiate a new password reset.';
diff --git a/lang/en/report.php b/lang/en/report.php
new file mode 100644
index 0000000000000..a2f9672ab1f3c
--- /dev/null
+++ b/lang/en/report.php
@@ -0,0 +1,26 @@
+.
+
+/**
+ * Strings for component 'report', language 'en'
+ *
+ * @package core_report
+ * @copyright 2024 Amaia Anabitarte
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['privacy:metadata'] = 'The Report system does not store any personal data.';
+
diff --git a/lang/en/role.php b/lang/en/role.php
index 97fa84054228c..915f240d8c371 100644
--- a/lang/en/role.php
+++ b/lang/en/role.php
@@ -180,6 +180,7 @@
$string['course:configurecustomfields'] = 'Configure course custom fields';
$string['course:configuredownloadcontent'] = 'Configure download course content';
$string['course:downloadcoursecontent'] = 'Download course content';
+$string['course:editcoursewelcomemessage'] = 'Edit course welcome message';
$string['course:enrolconfig'] = 'Configure enrol instances in courses';
$string['course:enrolreview'] = 'Review course enrolments';
$string['course:setforcedlanguage'] = 'Force course or activity language';
diff --git a/lib/UPGRADING.md b/lib/UPGRADING.md
index 457c1804d8958..60793c39bdd3b 100644
--- a/lib/UPGRADING.md
+++ b/lib/UPGRADING.md
@@ -17,6 +17,9 @@
- Final deprecation of print_error(). Use moodle_exception instead.
For more information see [MDL-74484](https://tracker.moodle.org/browse/MDL-74484)
+- Final deprecation of \core\task\manager::ensure_adhoc_task_qos()
+
+ For more information see [MDL-74843](https://tracker.moodle.org/browse/MDL-74843)
### Changed
@@ -54,6 +57,89 @@
- `\webservice_parameter_exception`
For more information see [MDL-81919](https://tracker.moodle.org/browse/MDL-81919)
+- The following classes have been moved into the `\core` namespace and now support autoloading:
+ - `emoticon_manager`
+ - `lang_string`
+
+ For more information see [MDL-81920](https://tracker.moodle.org/browse/MDL-81920)
+- The following classes have been renamed and now support autoloading. Existing classes are currently unaffected.
+ | Old class name | New class name |
+ | --- | --- |
+ | `\moodle_url` | `\core\url` |
+ | `\progress_trace` | `\core\output\progress_trace` |
+ | `\combined_progress_trace` | `\core\output\progress_trace\combined_progress_trace` |
+ | `\error_log_progress_trace` | `\core\output\progress_trace\error_log_progress_trace` |
+ | `\html_list_progress_trace` | `\core\output\progress_trace\html_list_progress_trace` |
+ | `\html_progress_trace` | `\core\output\progress_trace\html_progress_trace` |
+ | `\null_progress_trace` | `\core\output\progress_trace\null_progress_trace` |
+ | `\progress_trace_buffer` | `\core\output\progress_trace\progress_trace_buffer` |
+ | `\text_progress_trace` | `\core\output\progress_trace\text_progress_trace` |
+
+ For more information see [MDL-81960](https://tracker.moodle.org/browse/MDL-81960)
+- The following classes are now also available in the following new locations. They will continue to work in their old locations:
+ | Old classname | New classname |
+ | --- | --- |
+ | `\action_link` | `\core\output\action_link` |
+ | `\action_menu_filler` | `\core\output\action_menu\filler` |
+ | `\action_menu_link_primary` | `\core\output\action_menu\link_primary` |
+ | `\action_menu_link_secondary` | `\core\output\action_menu\link_secondary` |
+ | `\action_menu_link` | `\core\output\action_menu\link` |
+ | `\action_menu` | `\core\output\action_menu` |
+ | `\block_contents` | `\core_block\output\block_contents` |
+ | `\block_move_target` | `\core_block\output\block_move_target` |
+ | `\component_action` | `\core\output\actions\component_action` |
+ | `\confirm_action` | `\core\output\actions\confirm_action` |
+ | `\context_header` | `\core\output\context_header` |
+ | `\core\output\local\action_menu\subpanel` | `\core\output\action_menu\subpanel` |
+ | `\core_renderer_ajax` | `\core\output\core_renderer_ajax` |
+ | `\core_renderer_cli` | `\core\output\core_renderer_cli` |
+ | `\core_renderer_maintenance` | `\core\output\core_renderer_maintenance` |
+ | `\core_renderer` | `\core\output\core_renderer` |
+ | `\custom_menu_item` | `\core\output\custom_menu_item` |
+ | `\custom_menu` | `\core\output\custom_menu` |
+ | `\file_picker` | `\core\output\file_picker` |
+ | `\flexible_table` | `\core_table\flexible_table` |
+ | `\fragment_requirements_manager` | `\core\output\requirements\fragment_requirements_manager` |
+ | `\help_icon` | `\core\output\help_icon` |
+ | `\html_table_cell` | `\core_table\output\html_table_cell` |
+ | `\html_table_row` | `\core_table\output\html_table_row` |
+ | `\html_table` | `\core_table\output\html_table` |
+ | `\html_writer` | `\core\output\html_writer` |
+ | `\image_icon` | `\core\output\image_icon` |
+ | `\initials_bar` | `\core\output\initials_bar` |
+ | `\js_writer` | `\core\output\js_writer` |
+ | `\page_requirements_manager` | `\core\output\requirements\page_requirements_manager` |
+ | `\paging_bar` | `\core\output\paging_bar` |
+ | `\pix_emoticon` | `\core\output\pix_emoticon` |
+ | `\pix_icon_font` | `\core\output\pix_icon_font` |
+ | `\pix_icon_fontawesome` | `\core\output\pix_icon_fontawesome` |
+ | `\pix_icon` | `\core\output\pix_icon` |
+ | `\plugin_renderer_base` | `\core\output\plugin_renderer_base` |
+ | `\popup_action` | `\core\output\actions\popup_action` |
+ | `\preferences_group` | `\core\output\preferences_group` |
+ | `\preferences_groups` | `\core\output\preferences_groups` |
+ | `\progress_bar` | `\core\output\progress_bar` |
+ | `\renderable` | `\core\output\renderable` |
+ | `\renderer_base` | `\core\output\renderer_base` |
+ | `\renderer_factory_base` | `\core\output\renderer_factory\renderer_factory_base` |
+ | `\renderer_factory` | `\core\output\renderer_factory\renderer_factory_interface` |
+ | `\single_button` | `\core\output\single_button` |
+ | `\single_select` | `\core\output\single_select` |
+ | `\standard_renderer_factory` | `\core\output\renderer_factory\standard_renderer_factory` |
+ | `\table_dataformat_export_format` | `\core_table\dataformat_export_format` |
+ | `\table_default_export_format_parent` | `\core_table\base_export_format` |
+ | `\table_sql` | `\core_table\sql_table` |
+ | `\tabobject` | `\core\output\tabobject` |
+ | `\tabtree` | `\core\output\tabtree` |
+ | `\templatable` | `\core\output\templatable` |
+ | `\theme_config` | `\core\output\theme_config` |
+ | `\theme_overridden_renderer_factory` | `\core\output\renderer_factory\theme_overridden_renderer_factory` |
+ | `\url_select` | `\core\output\url_select` |
+ | `\user_picture` | `\core\output\user_picture` |
+ | `\xhtml_container_stack` | `\core\output\xhtml_container_stack` |
+ | `\YUI_config` | `\core\output\requirements\yui` |
+
+ For more information see [MDL-82183](https://tracker.moodle.org/browse/MDL-82183)
### Fixed
diff --git a/lib/amd/build/local/reactive/debugpanel.min.js b/lib/amd/build/local/reactive/debugpanel.min.js
index 82de966570bc1..d6f23b882a6b2 100644
--- a/lib/amd/build/local/reactive/debugpanel.min.js
+++ b/lib/amd/build/local/reactive/debugpanel.min.js
@@ -9,6 +9,6 @@ define("core/local/reactive/debugpanel",["exports","core/reactive","core/log","c
* @module core/local/reactive/debugpanel
* @copyright 2021 Ferran Recio
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.initsubpanel=_exports.init=void 0,_log=(obj=_log)&&obj.__esModule?obj:{default:obj};_exports.init=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new GlobalDebugPanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};_exports.initsubpanel=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new DebugInstanceSubpanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};class GlobalDebugPanel extends _reactive.BaseComponent{create(){this.name="GlobalDebugPanel",this.selectors={LOADERS:"[data-for='loaders']",SUBPANEL:"[data-for='subpanel']",NOINSTANCES:"[data-for='noinstances']",LOG:"[data-for='log']"},this.classes={HIDE:"d-none"},this.subPanels=new Set}stateReady(state){this._updateReactivesPanels({state:state}),this.getElement(this.selectors.SUBPANEL).innerHTML=""}getWatchers(){return[{watch:"reactives:created",handler:this._updateReactivesPanels}]}_updateReactivesPanels(_ref){var _this$getElement,_this$getElement$clas;let{state:state}=_ref;null===(_this$getElement=this.getElement(this.selectors.NOINSTANCES))||void 0===_this$getElement||null===(_this$getElement$clas=_this$getElement.classList)||void 0===_this$getElement$clas||_this$getElement$clas.toggle(this.classes.HIDE,state.reactives.size>0),state.reactives.forEach((instance=>{this._createLoader(instance)}))}_createLoader(instance){if(this.subPanels.has(instance.id))return;this.subPanels.add(instance.id);const loaders=this.getElement(this.selectors.LOADERS),btn=document.createElement("button");btn.innerHTML=instance.id,btn.dataset.id=instance.id,loaders.appendChild(btn),this.addEventListener(btn,"click",(()=>this._openPanel(btn,instance)))}async _openPanel(btn,instance){try{const target=this.getElement(this.selectors.SUBPANEL),data={...instance};await this.renderComponent(target,"core/local/reactive/debuginstancepanel",data)}catch(error){throw _log.default.error("Cannot load reactive debug subpanel"),error}}}class DebugInstanceSubpanel extends _reactive.BaseComponent{create(){this.name="DebugInstanceSubpanel",this.selectors={NAME:"[data-for='name']",CLOSE:"[data-for='close']",READMODE:"[data-for='readmode']",HIGHLIGHT:"[data-for='highlight']",LOG:"[data-for='log']",STATE:"[data-for='state']",CLEAN:"[data-for='clean']",PIN:"[data-for='pin']",SAVE:"[data-for='save']",INVALID:"[data-for='invalid']"},this.id=this.element.dataset.id,this.controller=M.reactive[this.id],this.draggable=!1,this.relativeDrag=!0,this.strings={savewarning:""}}stateReady(){var _this$getElement$inne,_this$getElement2;this.dragdrop=new _reactive.DragDrop(this),this.addEventListener(this.getElement(this.selectors.CLOSE),"click",this.remove),this.controller.highlight&&this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT)),this.addEventListener(this.getElement(this.selectors.HIGHLIGHT),"click",(()=>{this.controller.highlight=!this.controller.highlight,this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT))})),this.addEventListener(this.getElement(this.selectors.READMODE),"click",this._toggleEditMode),this.addEventListener(this.getElement(this.selectors.CLEAN),"click",this._cleanAreas),this.addEventListener(this.getElement(this.selectors.PIN),"click",this._togglePin),this.getElement(this.selectors.SAVE).disabled=!0,this.addEventListener(this.getElement(this.selectors.STATE),"keyup",(0,_utils.debounce)(this._checkJSON,500)),this.addEventListener(this.getElement(this.selectors.SAVE),"click",this._saveState),this.strings.savewarning=null!==(_this$getElement$inne=null===(_this$getElement2=this.getElement(this.selectors.INVALID))||void 0===_this$getElement2?void 0:_this$getElement2.innerHTML)&&void 0!==_this$getElement$inne?_this$getElement$inne:"",this._refreshState()}destroy(){void 0!==this.dragdrop&&this.dragdrop.unregister()}getWatchers(){return[{watch:"reactives[".concat(this.id,"].lastChanges:updated"),handler:this._refreshLog},{watch:"reactives[".concat(this.id,"].modified:updated"),handler:this._refreshState},{watch:"reactives[".concat(this.id,"].readOnly:updated"),handler:this._refreshReadOnly}]}_refreshLog(_ref2){var _element$lastChanges;let{element:element}=_ref2;const logContent=(null!==(_element$lastChanges=null==element?void 0:element.lastChanges)&&void 0!==_element$lastChanges?_element$lastChanges:[]).join("\n"),target=this.getElement(this.selectors.LOG);target.value+="\n\n= Transaction =\n ".concat(logContent),target.scrollTop=target.scrollHeight}_cleanAreas(){this.getElement(this.selectors.LOG).value="",this._refreshState()}_refreshState(){this.getElement(this.selectors.STATE).value=JSON.stringify(this.controller.state,null,4)}_refreshReadOnly(){const target=this.getElement(this.selectors.READMODE);void 0===target.dataset.readonly&&(target.dataset.readonly=target.innerHTML),this.controller.readOnly?target.innerHTML=target.dataset.readonly:target.innerHTML=target.dataset.alt}_toggleEditMode(){this.controller.readOnly=!this.controller.readOnly}_checkJSON(){const invalid=this.getElement(this.selectors.INVALID),save=this.getElement(this.selectors.SAVE),edited=this.getElement(this.selectors.STATE).value,currentStateData=this.controller.stateData;if(edited==JSON.stringify(this.controller.state,null,4))return invalid.style.color="",invalid.innerHTML="",void(save.disabled=!0);try{const newState=JSON.parse(edited),result=this._generateStateUpdates(currentStateData,newState);return invalid.style.color="",invalid.innerHTML=this.strings.savewarning,save.disabled=!1,result}catch(error){var _error$message;return invalid.style.color="red",invalid.innerHTML=null!==(_error$message=error.message)&&void 0!==_error$message?_error$message:"Invalid JSON sctructure",void(save.disabled=!0)}}_saveState(){const updates=this._checkJSON();updates&&this.controller.processUpdates(updates)}_generateStateUpdates(currentStateData,newStateData){const updates=[],ids={};for(const[key,newValue]of Object.entries(newStateData))Array.isArray(newValue)?(ids[key]={},newValue.forEach((element=>{if(void 0===element.id)throw Error("Array ".concat(key," element without id attribute"));updates.push({name:key,action:"override",fields:element});const index=String(element.id).valueOf();ids[key][index]=!0}))):updates.push({name:key,action:"override",fields:newValue});for(const[key,oldValue]of Object.entries(currentStateData)){let deleteField=!1;if(void 0===newStateData[key]&&(deleteField=!0),Array.isArray(oldValue)){if(!deleteField&&void 0===ids[key])throw Error("Array ".concat(key," cannot change to object."));oldValue.forEach((element=>{const index=String(element.id).valueOf();let deleteEntry=deleteField;deleteEntry||void 0!==ids[key][index]||(deleteEntry=!0),deleteEntry&&updates.push({name:key,action:"delete",fields:element})}))}else{if(!deleteField&&void 0!==ids[key])throw Error("Object ".concat(key," cannot change to array."));deleteField&&updates.push({name:key,action:"delete",fields:oldValue})}}return updates}getDraggableData(){return this.draggable}dragEnd(dropdata,event){this.element.style.top="".concat(event.newFixedTop,"px"),this.element.style.left="".concat(event.newFixedLeft,"px")}_togglePin(){this.draggable=!this.draggable,this.dragdrop.setDraggable(this.draggable),this.draggable?this._unpin():this._pin()}_unpin(){const pageCenterY=window.innerHeight/2,pageCenterX=window.innerWidth/2,style={position:"fixed",resize:"both",overflow:"auto",height:"400px",width:"400px",top:"".concat(pageCenterY-200,"px"),left:"".concat(pageCenterX-200,"px")};Object.assign(this.element.style,style),this.getElement(this.selectors.STATE).style.height="50px",this.getElement(this.selectors.LOG).style.height="50px",this._toggleButtonText(this.getElement(this.selectors.PIN))}_pin(){["position","resize","overflow","top","left","height","width"].forEach((prop=>this.element.style.removeProperty(prop))),this._toggleButtonText(this.getElement(this.selectors.PIN))}_toggleButtonText(element){[element.innerHTML,element.dataset.alt]=[element.dataset.alt,element.innerHTML]}}}));
+ */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.initsubpanel=_exports.init=void 0,_log=(obj=_log)&&obj.__esModule?obj:{default:obj};_exports.init=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new GlobalDebugPanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};_exports.initsubpanel=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new DebugInstanceSubpanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};class GlobalDebugPanel extends _reactive.BaseComponent{create(){this.name="GlobalDebugPanel",this.selectors={LOADERS:"[data-for='loaders']",SUBPANEL:"[data-for='subpanel']",NOINSTANCES:"[data-for='noinstances']",LOG:"[data-for='log']"},this.classes={HIDE:"d-none"},this.subPanels=new Set}stateReady(state){this._updateReactivesPanels({state:state}),this.getElement(this.selectors.SUBPANEL).innerHTML=""}getWatchers(){return[{watch:"reactives:created",handler:this._updateReactivesPanels}]}_updateReactivesPanels(_ref){var _this$getElement,_this$getElement$clas;let{state:state}=_ref;null===(_this$getElement=this.getElement(this.selectors.NOINSTANCES))||void 0===_this$getElement||null===(_this$getElement$clas=_this$getElement.classList)||void 0===_this$getElement$clas||_this$getElement$clas.toggle(this.classes.HIDE,state.reactives.size>0),state.reactives.forEach((instance=>{this._createLoader(instance)}))}_createLoader(instance){if(this.subPanels.has(instance.id))return;this.subPanels.add(instance.id);const loaders=this.getElement(this.selectors.LOADERS),btn=document.createElement("button");btn.innerHTML=instance.id,btn.dataset.id=instance.id,loaders.appendChild(btn),this.addEventListener(btn,"click",(()=>this._openPanel(btn,instance)))}async _openPanel(btn,instance){try{const target=this.getElement(this.selectors.SUBPANEL),data={...instance};await this.renderComponent(target,"core/local/reactive/debuginstancepanel",data)}catch(error){throw _log.default.error("Cannot load reactive debug subpanel"),error}}}class DebugInstanceSubpanel extends _reactive.BaseComponent{create(){this.name="DebugInstanceSubpanel",this.selectors={NAME:"[data-for='name']",CLOSE:"[data-for='close']",READMODE:"[data-for='readmode']",HIGHLIGHT:"[data-for='highlight']",LOG:"[data-for='log']",STATE:"[data-for='state']",CLEAN:"[data-for='clean']",PIN:"[data-for='pin']",SAVE:"[data-for='save']",INVALID:"[data-for='invalid']"},this.id=this.element.dataset.id,this.controller=M.reactive[this.id],this.draggable=!1,this.relativeDrag=!0,this.strings={savewarning:""}}stateReady(){var _this$getElement$inne,_this$getElement2;this.dragdrop=new _reactive.DragDrop(this),this.addEventListener(this.getElement(this.selectors.CLOSE),"click",this.remove),this.controller.highlight&&this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT)),this.addEventListener(this.getElement(this.selectors.HIGHLIGHT),"click",(()=>{this.controller.highlight=!this.controller.highlight,this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT))})),this.addEventListener(this.getElement(this.selectors.READMODE),"click",this._toggleEditMode),this.addEventListener(this.getElement(this.selectors.CLEAN),"click",this._cleanAreas),this.addEventListener(this.getElement(this.selectors.PIN),"click",this._togglePin),this.getElement(this.selectors.SAVE).disabled=!0,this.addEventListener(this.getElement(this.selectors.STATE),"keyup",(0,_utils.debounce)(this._checkJSON.bind(this),500)),this.addEventListener(this.getElement(this.selectors.SAVE),"click",this._saveState),this.strings.savewarning=null!==(_this$getElement$inne=null===(_this$getElement2=this.getElement(this.selectors.INVALID))||void 0===_this$getElement2?void 0:_this$getElement2.innerHTML)&&void 0!==_this$getElement$inne?_this$getElement$inne:"",this._refreshState()}destroy(){void 0!==this.dragdrop&&this.dragdrop.unregister()}getWatchers(){return[{watch:"reactives[".concat(this.id,"].lastChanges:updated"),handler:this._refreshLog},{watch:"reactives[".concat(this.id,"].modified:updated"),handler:this._refreshState},{watch:"reactives[".concat(this.id,"].readOnly:updated"),handler:this._refreshReadOnly}]}_refreshLog(_ref2){var _element$lastChanges;let{element:element}=_ref2;const logContent=(null!==(_element$lastChanges=null==element?void 0:element.lastChanges)&&void 0!==_element$lastChanges?_element$lastChanges:[]).join("\n"),target=this.getElement(this.selectors.LOG);target.value+="\n\n= Transaction =\n ".concat(logContent),target.scrollTop=target.scrollHeight}_cleanAreas(){this.getElement(this.selectors.LOG).value="",this._refreshState()}_refreshState(){this.getElement(this.selectors.STATE).value=JSON.stringify(this.controller.state,null,4)}_refreshReadOnly(){const target=this.getElement(this.selectors.READMODE);void 0===target.dataset.readonly&&(target.dataset.readonly=target.innerHTML),this.controller.readOnly?target.innerHTML=target.dataset.readonly:target.innerHTML=target.dataset.alt}_toggleEditMode(){this.controller.readOnly=!this.controller.readOnly}_checkJSON(){const invalid=this.getElement(this.selectors.INVALID),save=this.getElement(this.selectors.SAVE),edited=this.getElement(this.selectors.STATE).value,currentStateData=this.controller.stateData;if(edited==JSON.stringify(this.controller.state,null,4))return invalid.style.color="",invalid.innerHTML="",void(save.disabled=!0);try{const newState=JSON.parse(edited),result=this._generateStateUpdates(currentStateData,newState);return invalid.style.color="",invalid.innerHTML=this.strings.savewarning,save.disabled=!1,result}catch(error){var _error$message;return invalid.style.color="red",invalid.innerHTML=null!==(_error$message=error.message)&&void 0!==_error$message?_error$message:"Invalid JSON sctructure",void(save.disabled=!0)}}_saveState(){const updates=this._checkJSON();updates&&this.controller.processUpdates(updates)}_generateStateUpdates(currentStateData,newStateData){const updates=[],ids={};for(const[key,newValue]of Object.entries(newStateData))Array.isArray(newValue)?(ids[key]={},newValue.forEach((element=>{if(void 0===element.id)throw Error("Array ".concat(key," element without id attribute"));updates.push({name:key,action:"override",fields:element});const index=String(element.id).valueOf();ids[key][index]=!0}))):updates.push({name:key,action:"override",fields:newValue});for(const[key,oldValue]of Object.entries(currentStateData)){let deleteField=!1;if(void 0===newStateData[key]&&(deleteField=!0),Array.isArray(oldValue)){if(!deleteField&&void 0===ids[key])throw Error("Array ".concat(key," cannot change to object."));oldValue.forEach((element=>{const index=String(element.id).valueOf();let deleteEntry=deleteField;deleteEntry||void 0!==ids[key][index]||(deleteEntry=!0),deleteEntry&&updates.push({name:key,action:"delete",fields:element})}))}else{if(!deleteField&&void 0!==ids[key])throw Error("Object ".concat(key," cannot change to array."));deleteField&&updates.push({name:key,action:"delete",fields:oldValue})}}return updates}getDraggableData(){return this.draggable}dragEnd(dropdata,event){this.element.style.top="".concat(event.newFixedTop,"px"),this.element.style.left="".concat(event.newFixedLeft,"px")}_togglePin(){this.draggable=!this.draggable,this.dragdrop.setDraggable(this.draggable),this.draggable?this._unpin():this._pin()}_unpin(){const pageCenterY=window.innerHeight/2,pageCenterX=window.innerWidth/2,style={position:"fixed",resize:"both",overflow:"auto",height:"400px",width:"400px",top:"".concat(pageCenterY-200,"px"),left:"".concat(pageCenterX-200,"px")};Object.assign(this.element.style,style),this.getElement(this.selectors.STATE).style.height="50px",this.getElement(this.selectors.LOG).style.height="50px",this._toggleButtonText(this.getElement(this.selectors.PIN))}_pin(){["position","resize","overflow","top","left","height","width"].forEach((prop=>this.element.style.removeProperty(prop))),this._toggleButtonText(this.getElement(this.selectors.PIN))}_toggleButtonText(element){[element.innerHTML,element.dataset.alt]=[element.dataset.alt,element.innerHTML]}}}));
//# sourceMappingURL=debugpanel.min.js.map
\ No newline at end of file
diff --git a/lib/amd/build/local/reactive/debugpanel.min.js.map b/lib/amd/build/local/reactive/debugpanel.min.js.map
index b69f3f6544023..b6841c9f46a63 100644
--- a/lib/amd/build/local/reactive/debugpanel.min.js.map
+++ b/lib/amd/build/local/reactive/debugpanel.min.js.map
@@ -1 +1 @@
-{"version":3,"file":"debugpanel.min.js","sources":["../../../src/local/reactive/debugpanel.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {BaseComponent, DragDrop, debug} from 'core/reactive';\nimport log from 'core/log';\nimport {debounce} from 'core/utils';\n\n/**\n * Init the main reactive panel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const init = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new GlobalDebugPanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Init an instance reactive subpanel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const initsubpanel = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new DebugInstanceSubpanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass GlobalDebugPanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'GlobalDebugPanel';\n // Default query selectors.\n this.selectors = {\n LOADERS: `[data-for='loaders']`,\n SUBPANEL: `[data-for='subpanel']`,\n NOINSTANCES: `[data-for='noinstances']`,\n LOG: `[data-for='log']`,\n };\n this.classes = {\n HIDE: `d-none`,\n };\n // The list of loaded debuggers.\n this.subPanels = new Set();\n }\n\n /**\n * Initial state ready method.\n *\n * @param {object} state the initial state\n */\n stateReady(state) {\n this._updateReactivesPanels({state});\n // Remove loading wheel.\n this.getElement(this.selectors.SUBPANEL).innerHTML = '';\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives:created`, handler: this._updateReactivesPanels},\n ];\n }\n\n /**\n * Update the list of reactive instances.\n * @param {Object} args\n * @param {Object} args.state the current state\n */\n _updateReactivesPanels({state}) {\n this.getElement(this.selectors.NOINSTANCES)?.classList?.toggle(\n this.classes.HIDE,\n state.reactives.size > 0\n );\n // Generate loading buttons.\n state.reactives.forEach(\n instance => {\n this._createLoader(instance);\n }\n );\n }\n\n /**\n * Create a debug panel button for a specific reactive instance.\n *\n * @param {object} instance hte instance data\n */\n _createLoader(instance) {\n if (this.subPanels.has(instance.id)) {\n return;\n }\n this.subPanels.add(instance.id);\n const loaders = this.getElement(this.selectors.LOADERS);\n const btn = document.createElement(\"button\");\n btn.innerHTML = instance.id;\n btn.dataset.id = instance.id;\n loaders.appendChild(btn);\n // Add click event.\n this.addEventListener(btn, 'click', () => this._openPanel(btn, instance));\n }\n\n /**\n * Open a debug panel.\n *\n * @param {Element} btn the button element\n * @param {object} instance the instance data\n */\n async _openPanel(btn, instance) {\n try {\n const target = this.getElement(this.selectors.SUBPANEL);\n const data = {...instance};\n await this.renderComponent(target, 'core/local/reactive/debuginstancepanel', data);\n } catch (error) {\n log.error('Cannot load reactive debug subpanel');\n throw error;\n }\n }\n}\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass DebugInstanceSubpanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'DebugInstanceSubpanel';\n // Default query selectors.\n this.selectors = {\n NAME: `[data-for='name']`,\n CLOSE: `[data-for='close']`,\n READMODE: `[data-for='readmode']`,\n HIGHLIGHT: `[data-for='highlight']`,\n LOG: `[data-for='log']`,\n STATE: `[data-for='state']`,\n CLEAN: `[data-for='clean']`,\n PIN: `[data-for='pin']`,\n SAVE: `[data-for='save']`,\n INVALID: `[data-for='invalid']`,\n };\n this.id = this.element.dataset.id;\n this.controller = M.reactive[this.id];\n\n // The component is created always pinned.\n this.draggable = false;\n // We want the element to be dragged like modal.\n this.relativeDrag = true;\n // Save warning (will be loaded when state is ready.\n this.strings = {\n savewarning: '',\n };\n }\n\n /**\n * Initial state ready method.\n *\n */\n stateReady() {\n // Enable drag and drop.\n this.dragdrop = new DragDrop(this);\n\n // Close button.\n this.addEventListener(\n this.getElement(this.selectors.CLOSE),\n 'click',\n this.remove\n );\n // Highlight button.\n if (this.controller.highlight) {\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n this.addEventListener(\n this.getElement(this.selectors.HIGHLIGHT),\n 'click',\n () => {\n this.controller.highlight = !this.controller.highlight;\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n );\n // Edit mode button.\n this.addEventListener(\n this.getElement(this.selectors.READMODE),\n 'click',\n this._toggleEditMode\n );\n // Clean log and state.\n this.addEventListener(\n this.getElement(this.selectors.CLEAN),\n 'click',\n this._cleanAreas\n );\n // Unpin panel butotn.\n this.addEventListener(\n this.getElement(this.selectors.PIN),\n 'click',\n this._togglePin\n );\n // Save button, state format error message and state textarea.\n this.getElement(this.selectors.SAVE).disabled = true;\n\n this.addEventListener(\n this.getElement(this.selectors.STATE),\n 'keyup',\n debounce(this._checkJSON, 500)\n );\n\n this.addEventListener(\n this.getElement(this.selectors.SAVE),\n 'click',\n this._saveState\n );\n // Save the default save warning message.\n this.strings.savewarning = this.getElement(this.selectors.INVALID)?.innerHTML ?? '';\n // Add current state.\n this._refreshState();\n }\n\n /**\n * Remove all subcomponents dependencies.\n */\n destroy() {\n if (this.dragdrop !== undefined) {\n this.dragdrop.unregister();\n }\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives[${this.id}].lastChanges:updated`, handler: this._refreshLog},\n {watch: `reactives[${this.id}].modified:updated`, handler: this._refreshState},\n {watch: `reactives[${this.id}].readOnly:updated`, handler: this._refreshReadOnly},\n ];\n }\n\n /**\n * Wtacher method to refresh the log panel.\n *\n * @param {object} args\n * @param {HTMLElement} args.element\n */\n _refreshLog({element}) {\n const list = element?.lastChanges ?? [];\n\n const logContent = list.join(\"\\n\");\n // Append last log.\n const target = this.getElement(this.selectors.LOG);\n target.value += `\\n\\n= Transaction =\\n ${logContent}`;\n target.scrollTop = target.scrollHeight;\n }\n\n /**\n * Listener method to clean the log area.\n */\n _cleanAreas() {\n let target = this.getElement(this.selectors.LOG);\n target.value = '';\n\n this._refreshState();\n }\n\n /**\n * Watcher to refresh the state information.\n */\n _refreshState() {\n const target = this.getElement(this.selectors.STATE);\n target.value = JSON.stringify(this.controller.state, null, 4);\n }\n\n /**\n * Watcher to update the read only information.\n */\n _refreshReadOnly() {\n // Toggle the read mode button.\n const target = this.getElement(this.selectors.READMODE);\n if (target.dataset.readonly === undefined) {\n target.dataset.readonly = target.innerHTML;\n }\n if (this.controller.readOnly) {\n target.innerHTML = target.dataset.readonly;\n } else {\n target.innerHTML = target.dataset.alt;\n }\n }\n\n /**\n * Listener to toggle the edit mode of the component.\n */\n _toggleEditMode() {\n this.controller.readOnly = !this.controller.readOnly;\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type.\n *\n * @return {undefined|array} Array of state updates.\n */\n _checkJSON() {\n const invalid = this.getElement(this.selectors.INVALID);\n const save = this.getElement(this.selectors.SAVE);\n\n const edited = this.getElement(this.selectors.STATE).value;\n\n const currentStateData = this.controller.stateData;\n\n // Check if the json is tha same as state.\n if (edited == JSON.stringify(this.controller.state, null, 4)) {\n invalid.style.color = '';\n invalid.innerHTML = '';\n save.disabled = true;\n return undefined;\n }\n\n // Check if the json format is valid.\n try {\n const newState = JSON.parse(edited);\n // Check the first level did not change types.\n const result = this._generateStateUpdates(currentStateData, newState);\n // Enable save button.\n invalid.style.color = '';\n invalid.innerHTML = this.strings.savewarning;\n save.disabled = false;\n return result;\n } catch (error) {\n invalid.style.color = 'red';\n invalid.innerHTML = error.message ?? 'Invalid JSON sctructure';\n save.disabled = true;\n return undefined;\n }\n }\n\n /**\n * Listener to save the current edited state into the real state.\n */\n _saveState() {\n const updates = this._checkJSON();\n if (!updates) {\n return;\n }\n // Sent the updates to the state manager.\n this.controller.processUpdates(updates);\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type. This method do a two\n * steps comparison between the current state data and the new state data.\n *\n * A reactive state cannot be overridden like any other variable. To keep\n * the watchers updated is necessary to transform the current state into\n * the new one. As a result, this method generates all the necessary state\n * updates to convert the state into the new state.\n *\n * @param {object} currentStateData\n * @param {object} newStateData\n * @return {array} Array of state updates.\n * @throws {Error} is the structure is not compatible\n */\n _generateStateUpdates(currentStateData, newStateData) {\n\n const updates = [];\n\n const ids = {};\n\n // Step 1: Add all overrides newStateData.\n for (const [key, newValue] of Object.entries(newStateData)) {\n // Check is it is new.\n if (Array.isArray(newValue)) {\n ids[key] = {};\n newValue.forEach(element => {\n if (element.id === undefined) {\n throw Error(`Array ${key} element without id attribute`);\n }\n updates.push({\n name: key,\n action: 'override',\n fields: element,\n });\n const index = String(element.id).valueOf();\n ids[key][index] = true;\n });\n } else {\n updates.push({\n name: key,\n action: 'override',\n fields: newValue,\n });\n }\n }\n // Step 2: delete unnecesary data from currentStateData.\n for (const [key, oldValue] of Object.entries(currentStateData)) {\n let deleteField = false;\n // Check if the attribute is still there.\n if (newStateData[key] === undefined) {\n deleteField = true;\n }\n if (Array.isArray(oldValue)) {\n if (!deleteField && ids[key] === undefined) {\n throw Error(`Array ${key} cannot change to object.`);\n }\n oldValue.forEach(element => {\n const index = String(element.id).valueOf();\n let deleteEntry = deleteField;\n // Check if the id is there.\n if (!deleteEntry && ids[key][index] === undefined) {\n deleteEntry = true;\n }\n if (deleteEntry) {\n updates.push({\n name: key,\n action: 'delete',\n fields: element,\n });\n }\n });\n } else {\n if (!deleteField && ids[key] !== undefined) {\n throw Error(`Object ${key} cannot change to array.`);\n }\n if (deleteField) {\n updates.push({\n name: key,\n action: 'delete',\n fields: oldValue,\n });\n }\n }\n }\n // Delete all elements without action.\n return updates;\n }\n\n // Drag and drop methods.\n\n /**\n * Get the draggable data of this component.\n *\n * @returns {Object} exported course module drop data\n */\n getDraggableData() {\n return this.draggable;\n }\n\n /**\n * The element drop end hook.\n *\n * @param {Object} dropdata the dropdata\n * @param {Event} event the dropdata\n */\n dragEnd(dropdata, event) {\n this.element.style.top = `${event.newFixedTop}px`;\n this.element.style.left = `${event.newFixedLeft}px`;\n }\n\n /**\n * Pin and unpin the panel.\n */\n _togglePin() {\n this.draggable = !this.draggable;\n this.dragdrop.setDraggable(this.draggable);\n if (this.draggable) {\n this._unpin();\n } else {\n this._pin();\n }\n }\n\n /**\n * Unpin the panel form the footer.\n */\n _unpin() {\n // Find the initial spot.\n const pageCenterY = window.innerHeight / 2;\n const pageCenterX = window.innerWidth / 2;\n // Put the element in the middle of the screen\n const style = {\n position: 'fixed',\n resize: 'both',\n overflow: 'auto',\n height: '400px',\n width: '400px',\n top: `${pageCenterY - 200}px`,\n left: `${pageCenterX - 200}px`,\n };\n Object.assign(this.element.style, style);\n // Small also the text areas.\n this.getElement(this.selectors.STATE).style.height = '50px';\n this.getElement(this.selectors.LOG).style.height = '50px';\n\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Pin the panel into the footer.\n */\n _pin() {\n const props = [\n 'position',\n 'resize',\n 'overflow',\n 'top',\n 'left',\n 'height',\n 'width',\n ];\n props.forEach(\n prop => this.element.style.removeProperty(prop)\n );\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Toogle the button text with the data-alt value.\n *\n * @param {Element} element the button element\n */\n _toggleButtonText(element) {\n [element.innerHTML, element.dataset.alt] = [element.dataset.alt, element.innerHTML];\n }\n\n}\n"],"names":["target","selectors","element","document","getElementById","undefined","debug","GlobalDebugPanel","reactive","remove","DebugInstanceSubpanel","BaseComponent","create","name","LOADERS","SUBPANEL","NOINSTANCES","LOG","classes","HIDE","subPanels","Set","stateReady","state","_updateReactivesPanels","getElement","this","innerHTML","getWatchers","watch","handler","classList","toggle","reactives","size","forEach","instance","_createLoader","has","id","add","loaders","btn","createElement","dataset","appendChild","addEventListener","_openPanel","data","renderComponent","error","NAME","CLOSE","READMODE","HIGHLIGHT","STATE","CLEAN","PIN","SAVE","INVALID","controller","M","draggable","relativeDrag","strings","savewarning","dragdrop","DragDrop","highlight","_toggleButtonText","_toggleEditMode","_cleanAreas","_togglePin","disabled","_checkJSON","_saveState","_this$getElement2","_refreshState","destroy","unregister","_refreshLog","_refreshReadOnly","logContent","lastChanges","join","value","scrollTop","scrollHeight","JSON","stringify","readonly","readOnly","alt","invalid","save","edited","currentStateData","stateData","style","color","newState","parse","result","_generateStateUpdates","message","updates","processUpdates","newStateData","ids","key","newValue","Object","entries","Array","isArray","Error","push","action","fields","index","String","valueOf","oldValue","deleteField","deleteEntry","getDraggableData","dragEnd","dropdata","event","top","newFixedTop","left","newFixedLeft","setDraggable","_unpin","_pin","pageCenterY","window","innerHeight","pageCenterX","innerWidth","position","resize","overflow","height","width","assign","prop","removeProperty"],"mappings":";;;;;;;;;;;wKAqCoB,CAACA,OAAQC,mBACnBC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAC,iBAAiB,CACjBL,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gCAiBY,CAACT,OAAQC,mBAC3BC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAI,sBAAsB,CACtBR,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gBAiBVF,yBAAyBI,wBAK3BC,cAESC,KAAO,wBAEPZ,UAAY,CACba,+BACAC,iCACAC,uCACAC,6BAECC,QAAU,CACXC,oBAGCC,UAAY,IAAIC,IAQzBC,WAAWC,YACFC,uBAAuB,CAACD,MAAAA,aAExBE,WAAWC,KAAKzB,UAAUc,UAAUY,UAAY,GAQzDC,oBACW,CACH,CAACC,0BAA4BC,QAASJ,KAAKF,yBASnDA,4EAAuBD,MAACA,0CACfE,WAAWC,KAAKzB,UAAUe,yFAAce,kEAAWC,OACpDN,KAAKR,QAAQC,KACbI,MAAMU,UAAUC,KAAO,GAG3BX,MAAMU,UAAUE,SACZC,gBACSC,cAAcD,aAU/BC,cAAcD,aACNV,KAAKN,UAAUkB,IAAIF,SAASG,gBAG3BnB,UAAUoB,IAAIJ,SAASG,UACtBE,QAAUf,KAAKD,WAAWC,KAAKzB,UAAUa,SACzC4B,IAAMvC,SAASwC,cAAc,UACnCD,IAAIf,UAAYS,SAASG,GACzBG,IAAIE,QAAQL,GAAKH,SAASG,GAC1BE,QAAQI,YAAYH,UAEfI,iBAAiBJ,IAAK,SAAS,IAAMhB,KAAKqB,WAAWL,IAAKN,6BASlDM,IAAKN,oBAERpC,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUc,UACxCiC,KAAO,IAAIZ,gBACXV,KAAKuB,gBAAgBjD,OAAQ,yCAA0CgD,MAC/E,MAAOE,0BACDA,MAAM,uCACJA,cAWZxC,8BAA8BC,wBAKhCC,cAESC,KAAO,6BAEPZ,UAAY,CACbkD,yBACAC,2BACAC,iCACAC,mCACArC,uBACAsC,2BACAC,2BACAC,uBACAC,yBACAC,qCAECpB,GAAKb,KAAKxB,QAAQ0C,QAAQL,QAC1BqB,WAAaC,EAAErD,SAASkB,KAAKa,SAG7BuB,WAAY,OAEZC,cAAe,OAEfC,QAAU,CACXC,YAAa,IAQrB3C,8DAES4C,SAAW,IAAIC,mBAASzC,WAGxBoB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUmD,OAC/B,QACA1B,KAAKjB,QAGLiB,KAAKkC,WAAWQ,gBACXC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,iBAErDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUqD,WAC/B,SACA,UACSM,WAAWQ,WAAa1C,KAAKkC,WAAWQ,eACxCC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,oBAIzDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUoD,UAC/B,QACA3B,KAAK4C,sBAGJxB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUuD,OAC/B,QACA9B,KAAK6C,kBAGJzB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUwD,KAC/B,QACA/B,KAAK8C,iBAGJ/C,WAAWC,KAAKzB,UAAUyD,MAAMe,UAAW,OAE3C3B,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUsD,OAC/B,SACA,mBAAS7B,KAAKgD,WAAY,WAGzB5B,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUyD,MAC/B,QACAhC,KAAKiD,iBAGJX,QAAQC,oEAAcvC,KAAKD,WAAWC,KAAKzB,UAAU0D,6CAA/BiB,kBAAyCjD,iEAAa,QAE5EkD,gBAMTC,eAC0BzE,IAAlBqB,KAAKwC,eACAA,SAASa,aAStBnD,oBACW,CACH,CAACC,0BAAoBH,KAAKa,4BAA2BT,QAASJ,KAAKsD,aACnE,CAACnD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKmD,eAChE,CAAChD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKuD,mBAUxED,gDAAY9E,QAACA,qBAGHgF,yCAFOhF,MAAAA,eAAAA,QAASiF,iEAAe,IAEbC,KAAK,MAEvBpF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUgB,KAC9CjB,OAAOqF,uCAAkCH,YACzClF,OAAOsF,UAAYtF,OAAOuF,aAM9BhB,cACiB7C,KAAKD,WAAWC,KAAKzB,UAAUgB,KACrCoE,MAAQ,QAEVR,gBAMTA,gBACmBnD,KAAKD,WAAWC,KAAKzB,UAAUsD,OACvC8B,MAAQG,KAAKC,UAAU/D,KAAKkC,WAAWrC,MAAO,KAAM,GAM/D0D,yBAEUjF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUoD,eACdhD,IAA5BL,OAAO4C,QAAQ8C,WACf1F,OAAO4C,QAAQ8C,SAAW1F,OAAO2B,WAEjCD,KAAKkC,WAAW+B,SAChB3F,OAAO2B,UAAY3B,OAAO4C,QAAQ8C,SAElC1F,OAAO2B,UAAY3B,OAAO4C,QAAQgD,IAO1CtB,uBACSV,WAAW+B,UAAYjE,KAAKkC,WAAW+B,SAWhDjB,mBACUmB,QAAUnE,KAAKD,WAAWC,KAAKzB,UAAU0D,SACzCmC,KAAOpE,KAAKD,WAAWC,KAAKzB,UAAUyD,MAEtCqC,OAASrE,KAAKD,WAAWC,KAAKzB,UAAUsD,OAAO8B,MAE/CW,iBAAmBtE,KAAKkC,WAAWqC,aAGrCF,QAAUP,KAAKC,UAAU/D,KAAKkC,WAAWrC,MAAO,KAAM,UACtDsE,QAAQK,MAAMC,MAAQ,GACtBN,QAAQlE,UAAY,QACpBmE,KAAKrB,UAAW,aAMV2B,SAAWZ,KAAKa,MAAMN,QAEtBO,OAAS5E,KAAK6E,sBAAsBP,iBAAkBI,iBAE5DP,QAAQK,MAAMC,MAAQ,GACtBN,QAAQlE,UAAYD,KAAKsC,QAAQC,YACjC6B,KAAKrB,UAAW,EACT6B,OACT,MAAOpD,iCACL2C,QAAQK,MAAMC,MAAQ,MACtBN,QAAQlE,iCAAYuB,MAAMsD,iDAAW,+BACrCV,KAAKrB,UAAW,IAQxBE,mBACU8B,QAAU/E,KAAKgD,aAChB+B,cAIA7C,WAAW8C,eAAeD,SAoBnCF,sBAAsBP,iBAAkBW,oBAE9BF,QAAU,GAEVG,IAAM,OAGP,MAAOC,IAAKC,YAAaC,OAAOC,QAAQL,cAErCM,MAAMC,QAAQJ,WACdF,IAAIC,KAAO,GACXC,SAAS3E,SAAQjC,kBACMG,IAAfH,QAAQqC,SACF4E,sBAAeN,sCAEzBJ,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,WACRC,OAAQpH,gBAENqH,MAAQC,OAAOtH,QAAQqC,IAAIkF,UACjCb,IAAIC,KAAKU,QAAS,MAGtBd,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,WACRC,OAAQR,eAKf,MAAOD,IAAKa,YAAaX,OAAOC,QAAQhB,kBAAmB,KACxD2B,aAAc,UAEQtH,IAAtBsG,aAAaE,OACbc,aAAc,GAEdV,MAAMC,QAAQQ,UAAW,KACpBC,kBAA4BtH,IAAbuG,IAAIC,WACdM,sBAAeN,kCAEzBa,SAASvF,SAAQjC,gBACPqH,MAAQC,OAAOtH,QAAQqC,IAAIkF,cAC7BG,YAAcD,YAEbC,kBAAmCvH,IAApBuG,IAAIC,KAAKU,SACzBK,aAAc,GAEdA,aACAnB,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,SACRC,OAAQpH,iBAIjB,KACEyH,kBAA4BtH,IAAbuG,IAAIC,WACdM,uBAAgBN,iCAEtBc,aACAlB,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,SACRC,OAAQI,mBAMjBjB,QAUXoB,0BACWnG,KAAKoC,UAShBgE,QAAQC,SAAUC,YACT9H,QAAQgG,MAAM+B,cAASD,MAAME,uBAC7BhI,QAAQgG,MAAMiC,eAAUH,MAAMI,mBAMvC5D,kBACSV,WAAapC,KAAKoC,eAClBI,SAASmE,aAAa3G,KAAKoC,WAC5BpC,KAAKoC,eACAwE,cAEAC,OAObD,eAEUE,YAAcC,OAAOC,YAAc,EACnCC,YAAcF,OAAOG,WAAa,EAElC1C,MAAQ,CACV2C,SAAU,QACVC,OAAQ,OACRC,SAAU,OACVC,OAAQ,QACRC,MAAO,QACPhB,cAAQO,YAAc,UACtBL,eAASQ,YAAc,WAE3B5B,OAAOmC,OAAOxH,KAAKxB,QAAQgG,MAAOA,YAE7BzE,WAAWC,KAAKzB,UAAUsD,OAAO2C,MAAM8C,OAAS,YAChDvH,WAAWC,KAAKzB,UAAUgB,KAAKiF,MAAM8C,OAAS,YAE9C3E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAM1D8E,OACkB,CACV,WACA,SACA,WACA,MACA,OACA,SACA,SAEEpG,SACFgH,MAAQzH,KAAKxB,QAAQgG,MAAMkD,eAAeD,aAEzC9E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAQ1DY,kBAAkBnE,UACbA,QAAQyB,UAAWzB,QAAQ0C,QAAQgD,KAAO,CAAC1F,QAAQ0C,QAAQgD,IAAK1F,QAAQyB"}
\ No newline at end of file
+{"version":3,"file":"debugpanel.min.js","sources":["../../../src/local/reactive/debugpanel.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {BaseComponent, DragDrop, debug} from 'core/reactive';\nimport log from 'core/log';\nimport {debounce} from 'core/utils';\n\n/**\n * Init the main reactive panel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const init = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new GlobalDebugPanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Init an instance reactive subpanel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const initsubpanel = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new DebugInstanceSubpanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass GlobalDebugPanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'GlobalDebugPanel';\n // Default query selectors.\n this.selectors = {\n LOADERS: `[data-for='loaders']`,\n SUBPANEL: `[data-for='subpanel']`,\n NOINSTANCES: `[data-for='noinstances']`,\n LOG: `[data-for='log']`,\n };\n this.classes = {\n HIDE: `d-none`,\n };\n // The list of loaded debuggers.\n this.subPanels = new Set();\n }\n\n /**\n * Initial state ready method.\n *\n * @param {object} state the initial state\n */\n stateReady(state) {\n this._updateReactivesPanels({state});\n // Remove loading wheel.\n this.getElement(this.selectors.SUBPANEL).innerHTML = '';\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives:created`, handler: this._updateReactivesPanels},\n ];\n }\n\n /**\n * Update the list of reactive instances.\n * @param {Object} args\n * @param {Object} args.state the current state\n */\n _updateReactivesPanels({state}) {\n this.getElement(this.selectors.NOINSTANCES)?.classList?.toggle(\n this.classes.HIDE,\n state.reactives.size > 0\n );\n // Generate loading buttons.\n state.reactives.forEach(\n instance => {\n this._createLoader(instance);\n }\n );\n }\n\n /**\n * Create a debug panel button for a specific reactive instance.\n *\n * @param {object} instance hte instance data\n */\n _createLoader(instance) {\n if (this.subPanels.has(instance.id)) {\n return;\n }\n this.subPanels.add(instance.id);\n const loaders = this.getElement(this.selectors.LOADERS);\n const btn = document.createElement(\"button\");\n btn.innerHTML = instance.id;\n btn.dataset.id = instance.id;\n loaders.appendChild(btn);\n // Add click event.\n this.addEventListener(btn, 'click', () => this._openPanel(btn, instance));\n }\n\n /**\n * Open a debug panel.\n *\n * @param {Element} btn the button element\n * @param {object} instance the instance data\n */\n async _openPanel(btn, instance) {\n try {\n const target = this.getElement(this.selectors.SUBPANEL);\n const data = {...instance};\n await this.renderComponent(target, 'core/local/reactive/debuginstancepanel', data);\n } catch (error) {\n log.error('Cannot load reactive debug subpanel');\n throw error;\n }\n }\n}\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass DebugInstanceSubpanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'DebugInstanceSubpanel';\n // Default query selectors.\n this.selectors = {\n NAME: `[data-for='name']`,\n CLOSE: `[data-for='close']`,\n READMODE: `[data-for='readmode']`,\n HIGHLIGHT: `[data-for='highlight']`,\n LOG: `[data-for='log']`,\n STATE: `[data-for='state']`,\n CLEAN: `[data-for='clean']`,\n PIN: `[data-for='pin']`,\n SAVE: `[data-for='save']`,\n INVALID: `[data-for='invalid']`,\n };\n this.id = this.element.dataset.id;\n this.controller = M.reactive[this.id];\n\n // The component is created always pinned.\n this.draggable = false;\n // We want the element to be dragged like modal.\n this.relativeDrag = true;\n // Save warning (will be loaded when state is ready.\n this.strings = {\n savewarning: '',\n };\n }\n\n /**\n * Initial state ready method.\n *\n */\n stateReady() {\n // Enable drag and drop.\n this.dragdrop = new DragDrop(this);\n\n // Close button.\n this.addEventListener(\n this.getElement(this.selectors.CLOSE),\n 'click',\n this.remove\n );\n // Highlight button.\n if (this.controller.highlight) {\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n this.addEventListener(\n this.getElement(this.selectors.HIGHLIGHT),\n 'click',\n () => {\n this.controller.highlight = !this.controller.highlight;\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n );\n // Edit mode button.\n this.addEventListener(\n this.getElement(this.selectors.READMODE),\n 'click',\n this._toggleEditMode\n );\n // Clean log and state.\n this.addEventListener(\n this.getElement(this.selectors.CLEAN),\n 'click',\n this._cleanAreas\n );\n // Unpin panel butotn.\n this.addEventListener(\n this.getElement(this.selectors.PIN),\n 'click',\n this._togglePin\n );\n // Save button, state format error message and state textarea.\n this.getElement(this.selectors.SAVE).disabled = true;\n\n this.addEventListener(\n this.getElement(this.selectors.STATE),\n 'keyup',\n debounce(this._checkJSON.bind(this), 500)\n );\n\n this.addEventListener(\n this.getElement(this.selectors.SAVE),\n 'click',\n this._saveState\n );\n // Save the default save warning message.\n this.strings.savewarning = this.getElement(this.selectors.INVALID)?.innerHTML ?? '';\n // Add current state.\n this._refreshState();\n }\n\n /**\n * Remove all subcomponents dependencies.\n */\n destroy() {\n if (this.dragdrop !== undefined) {\n this.dragdrop.unregister();\n }\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives[${this.id}].lastChanges:updated`, handler: this._refreshLog},\n {watch: `reactives[${this.id}].modified:updated`, handler: this._refreshState},\n {watch: `reactives[${this.id}].readOnly:updated`, handler: this._refreshReadOnly},\n ];\n }\n\n /**\n * Wtacher method to refresh the log panel.\n *\n * @param {object} args\n * @param {HTMLElement} args.element\n */\n _refreshLog({element}) {\n const list = element?.lastChanges ?? [];\n\n const logContent = list.join(\"\\n\");\n // Append last log.\n const target = this.getElement(this.selectors.LOG);\n target.value += `\\n\\n= Transaction =\\n ${logContent}`;\n target.scrollTop = target.scrollHeight;\n }\n\n /**\n * Listener method to clean the log area.\n */\n _cleanAreas() {\n let target = this.getElement(this.selectors.LOG);\n target.value = '';\n\n this._refreshState();\n }\n\n /**\n * Watcher to refresh the state information.\n */\n _refreshState() {\n const target = this.getElement(this.selectors.STATE);\n target.value = JSON.stringify(this.controller.state, null, 4);\n }\n\n /**\n * Watcher to update the read only information.\n */\n _refreshReadOnly() {\n // Toggle the read mode button.\n const target = this.getElement(this.selectors.READMODE);\n if (target.dataset.readonly === undefined) {\n target.dataset.readonly = target.innerHTML;\n }\n if (this.controller.readOnly) {\n target.innerHTML = target.dataset.readonly;\n } else {\n target.innerHTML = target.dataset.alt;\n }\n }\n\n /**\n * Listener to toggle the edit mode of the component.\n */\n _toggleEditMode() {\n this.controller.readOnly = !this.controller.readOnly;\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type.\n *\n * @return {undefined|array} Array of state updates.\n */\n _checkJSON() {\n const invalid = this.getElement(this.selectors.INVALID);\n const save = this.getElement(this.selectors.SAVE);\n\n const edited = this.getElement(this.selectors.STATE).value;\n\n const currentStateData = this.controller.stateData;\n\n // Check if the json is tha same as state.\n if (edited == JSON.stringify(this.controller.state, null, 4)) {\n invalid.style.color = '';\n invalid.innerHTML = '';\n save.disabled = true;\n return undefined;\n }\n\n // Check if the json format is valid.\n try {\n const newState = JSON.parse(edited);\n // Check the first level did not change types.\n const result = this._generateStateUpdates(currentStateData, newState);\n // Enable save button.\n invalid.style.color = '';\n invalid.innerHTML = this.strings.savewarning;\n save.disabled = false;\n return result;\n } catch (error) {\n invalid.style.color = 'red';\n invalid.innerHTML = error.message ?? 'Invalid JSON sctructure';\n save.disabled = true;\n return undefined;\n }\n }\n\n /**\n * Listener to save the current edited state into the real state.\n */\n _saveState() {\n const updates = this._checkJSON();\n if (!updates) {\n return;\n }\n // Sent the updates to the state manager.\n this.controller.processUpdates(updates);\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type. This method do a two\n * steps comparison between the current state data and the new state data.\n *\n * A reactive state cannot be overridden like any other variable. To keep\n * the watchers updated is necessary to transform the current state into\n * the new one. As a result, this method generates all the necessary state\n * updates to convert the state into the new state.\n *\n * @param {object} currentStateData\n * @param {object} newStateData\n * @return {array} Array of state updates.\n * @throws {Error} is the structure is not compatible\n */\n _generateStateUpdates(currentStateData, newStateData) {\n\n const updates = [];\n\n const ids = {};\n\n // Step 1: Add all overrides newStateData.\n for (const [key, newValue] of Object.entries(newStateData)) {\n // Check is it is new.\n if (Array.isArray(newValue)) {\n ids[key] = {};\n newValue.forEach(element => {\n if (element.id === undefined) {\n throw Error(`Array ${key} element without id attribute`);\n }\n updates.push({\n name: key,\n action: 'override',\n fields: element,\n });\n const index = String(element.id).valueOf();\n ids[key][index] = true;\n });\n } else {\n updates.push({\n name: key,\n action: 'override',\n fields: newValue,\n });\n }\n }\n // Step 2: delete unnecesary data from currentStateData.\n for (const [key, oldValue] of Object.entries(currentStateData)) {\n let deleteField = false;\n // Check if the attribute is still there.\n if (newStateData[key] === undefined) {\n deleteField = true;\n }\n if (Array.isArray(oldValue)) {\n if (!deleteField && ids[key] === undefined) {\n throw Error(`Array ${key} cannot change to object.`);\n }\n oldValue.forEach(element => {\n const index = String(element.id).valueOf();\n let deleteEntry = deleteField;\n // Check if the id is there.\n if (!deleteEntry && ids[key][index] === undefined) {\n deleteEntry = true;\n }\n if (deleteEntry) {\n updates.push({\n name: key,\n action: 'delete',\n fields: element,\n });\n }\n });\n } else {\n if (!deleteField && ids[key] !== undefined) {\n throw Error(`Object ${key} cannot change to array.`);\n }\n if (deleteField) {\n updates.push({\n name: key,\n action: 'delete',\n fields: oldValue,\n });\n }\n }\n }\n // Delete all elements without action.\n return updates;\n }\n\n // Drag and drop methods.\n\n /**\n * Get the draggable data of this component.\n *\n * @returns {Object} exported course module drop data\n */\n getDraggableData() {\n return this.draggable;\n }\n\n /**\n * The element drop end hook.\n *\n * @param {Object} dropdata the dropdata\n * @param {Event} event the dropdata\n */\n dragEnd(dropdata, event) {\n this.element.style.top = `${event.newFixedTop}px`;\n this.element.style.left = `${event.newFixedLeft}px`;\n }\n\n /**\n * Pin and unpin the panel.\n */\n _togglePin() {\n this.draggable = !this.draggable;\n this.dragdrop.setDraggable(this.draggable);\n if (this.draggable) {\n this._unpin();\n } else {\n this._pin();\n }\n }\n\n /**\n * Unpin the panel form the footer.\n */\n _unpin() {\n // Find the initial spot.\n const pageCenterY = window.innerHeight / 2;\n const pageCenterX = window.innerWidth / 2;\n // Put the element in the middle of the screen\n const style = {\n position: 'fixed',\n resize: 'both',\n overflow: 'auto',\n height: '400px',\n width: '400px',\n top: `${pageCenterY - 200}px`,\n left: `${pageCenterX - 200}px`,\n };\n Object.assign(this.element.style, style);\n // Small also the text areas.\n this.getElement(this.selectors.STATE).style.height = '50px';\n this.getElement(this.selectors.LOG).style.height = '50px';\n\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Pin the panel into the footer.\n */\n _pin() {\n const props = [\n 'position',\n 'resize',\n 'overflow',\n 'top',\n 'left',\n 'height',\n 'width',\n ];\n props.forEach(\n prop => this.element.style.removeProperty(prop)\n );\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Toogle the button text with the data-alt value.\n *\n * @param {Element} element the button element\n */\n _toggleButtonText(element) {\n [element.innerHTML, element.dataset.alt] = [element.dataset.alt, element.innerHTML];\n }\n\n}\n"],"names":["target","selectors","element","document","getElementById","undefined","debug","GlobalDebugPanel","reactive","remove","DebugInstanceSubpanel","BaseComponent","create","name","LOADERS","SUBPANEL","NOINSTANCES","LOG","classes","HIDE","subPanels","Set","stateReady","state","_updateReactivesPanels","getElement","this","innerHTML","getWatchers","watch","handler","classList","toggle","reactives","size","forEach","instance","_createLoader","has","id","add","loaders","btn","createElement","dataset","appendChild","addEventListener","_openPanel","data","renderComponent","error","NAME","CLOSE","READMODE","HIGHLIGHT","STATE","CLEAN","PIN","SAVE","INVALID","controller","M","draggable","relativeDrag","strings","savewarning","dragdrop","DragDrop","highlight","_toggleButtonText","_toggleEditMode","_cleanAreas","_togglePin","disabled","_checkJSON","bind","_saveState","_this$getElement2","_refreshState","destroy","unregister","_refreshLog","_refreshReadOnly","logContent","lastChanges","join","value","scrollTop","scrollHeight","JSON","stringify","readonly","readOnly","alt","invalid","save","edited","currentStateData","stateData","style","color","newState","parse","result","_generateStateUpdates","message","updates","processUpdates","newStateData","ids","key","newValue","Object","entries","Array","isArray","Error","push","action","fields","index","String","valueOf","oldValue","deleteField","deleteEntry","getDraggableData","dragEnd","dropdata","event","top","newFixedTop","left","newFixedLeft","setDraggable","_unpin","_pin","pageCenterY","window","innerHeight","pageCenterX","innerWidth","position","resize","overflow","height","width","assign","prop","removeProperty"],"mappings":";;;;;;;;;;;wKAqCoB,CAACA,OAAQC,mBACnBC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAC,iBAAiB,CACjBL,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gCAiBY,CAACT,OAAQC,mBAC3BC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAI,sBAAsB,CACtBR,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gBAiBVF,yBAAyBI,wBAK3BC,cAESC,KAAO,wBAEPZ,UAAY,CACba,+BACAC,iCACAC,uCACAC,6BAECC,QAAU,CACXC,oBAGCC,UAAY,IAAIC,IAQzBC,WAAWC,YACFC,uBAAuB,CAACD,MAAAA,aAExBE,WAAWC,KAAKzB,UAAUc,UAAUY,UAAY,GAQzDC,oBACW,CACH,CAACC,0BAA4BC,QAASJ,KAAKF,yBASnDA,4EAAuBD,MAACA,0CACfE,WAAWC,KAAKzB,UAAUe,yFAAce,kEAAWC,OACpDN,KAAKR,QAAQC,KACbI,MAAMU,UAAUC,KAAO,GAG3BX,MAAMU,UAAUE,SACZC,gBACSC,cAAcD,aAU/BC,cAAcD,aACNV,KAAKN,UAAUkB,IAAIF,SAASG,gBAG3BnB,UAAUoB,IAAIJ,SAASG,UACtBE,QAAUf,KAAKD,WAAWC,KAAKzB,UAAUa,SACzC4B,IAAMvC,SAASwC,cAAc,UACnCD,IAAIf,UAAYS,SAASG,GACzBG,IAAIE,QAAQL,GAAKH,SAASG,GAC1BE,QAAQI,YAAYH,UAEfI,iBAAiBJ,IAAK,SAAS,IAAMhB,KAAKqB,WAAWL,IAAKN,6BASlDM,IAAKN,oBAERpC,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUc,UACxCiC,KAAO,IAAIZ,gBACXV,KAAKuB,gBAAgBjD,OAAQ,yCAA0CgD,MAC/E,MAAOE,0BACDA,MAAM,uCACJA,cAWZxC,8BAA8BC,wBAKhCC,cAESC,KAAO,6BAEPZ,UAAY,CACbkD,yBACAC,2BACAC,iCACAC,mCACArC,uBACAsC,2BACAC,2BACAC,uBACAC,yBACAC,qCAECpB,GAAKb,KAAKxB,QAAQ0C,QAAQL,QAC1BqB,WAAaC,EAAErD,SAASkB,KAAKa,SAG7BuB,WAAY,OAEZC,cAAe,OAEfC,QAAU,CACXC,YAAa,IAQrB3C,8DAES4C,SAAW,IAAIC,mBAASzC,WAGxBoB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUmD,OAC/B,QACA1B,KAAKjB,QAGLiB,KAAKkC,WAAWQ,gBACXC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,iBAErDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUqD,WAC/B,SACA,UACSM,WAAWQ,WAAa1C,KAAKkC,WAAWQ,eACxCC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,oBAIzDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUoD,UAC/B,QACA3B,KAAK4C,sBAGJxB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUuD,OAC/B,QACA9B,KAAK6C,kBAGJzB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUwD,KAC/B,QACA/B,KAAK8C,iBAGJ/C,WAAWC,KAAKzB,UAAUyD,MAAMe,UAAW,OAE3C3B,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUsD,OAC/B,SACA,mBAAS7B,KAAKgD,WAAWC,KAAKjD,MAAO,WAGpCoB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUyD,MAC/B,QACAhC,KAAKkD,iBAGJZ,QAAQC,oEAAcvC,KAAKD,WAAWC,KAAKzB,UAAU0D,6CAA/BkB,kBAAyClD,iEAAa,QAE5EmD,gBAMTC,eAC0B1E,IAAlBqB,KAAKwC,eACAA,SAASc,aAStBpD,oBACW,CACH,CAACC,0BAAoBH,KAAKa,4BAA2BT,QAASJ,KAAKuD,aACnE,CAACpD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKoD,eAChE,CAACjD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKwD,mBAUxED,gDAAY/E,QAACA,qBAGHiF,yCAFOjF,MAAAA,eAAAA,QAASkF,iEAAe,IAEbC,KAAK,MAEvBrF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUgB,KAC9CjB,OAAOsF,uCAAkCH,YACzCnF,OAAOuF,UAAYvF,OAAOwF,aAM9BjB,cACiB7C,KAAKD,WAAWC,KAAKzB,UAAUgB,KACrCqE,MAAQ,QAEVR,gBAMTA,gBACmBpD,KAAKD,WAAWC,KAAKzB,UAAUsD,OACvC+B,MAAQG,KAAKC,UAAUhE,KAAKkC,WAAWrC,MAAO,KAAM,GAM/D2D,yBAEUlF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUoD,eACdhD,IAA5BL,OAAO4C,QAAQ+C,WACf3F,OAAO4C,QAAQ+C,SAAW3F,OAAO2B,WAEjCD,KAAKkC,WAAWgC,SAChB5F,OAAO2B,UAAY3B,OAAO4C,QAAQ+C,SAElC3F,OAAO2B,UAAY3B,OAAO4C,QAAQiD,IAO1CvB,uBACSV,WAAWgC,UAAYlE,KAAKkC,WAAWgC,SAWhDlB,mBACUoB,QAAUpE,KAAKD,WAAWC,KAAKzB,UAAU0D,SACzCoC,KAAOrE,KAAKD,WAAWC,KAAKzB,UAAUyD,MAEtCsC,OAAStE,KAAKD,WAAWC,KAAKzB,UAAUsD,OAAO+B,MAE/CW,iBAAmBvE,KAAKkC,WAAWsC,aAGrCF,QAAUP,KAAKC,UAAUhE,KAAKkC,WAAWrC,MAAO,KAAM,UACtDuE,QAAQK,MAAMC,MAAQ,GACtBN,QAAQnE,UAAY,QACpBoE,KAAKtB,UAAW,aAMV4B,SAAWZ,KAAKa,MAAMN,QAEtBO,OAAS7E,KAAK8E,sBAAsBP,iBAAkBI,iBAE5DP,QAAQK,MAAMC,MAAQ,GACtBN,QAAQnE,UAAYD,KAAKsC,QAAQC,YACjC8B,KAAKtB,UAAW,EACT8B,OACT,MAAOrD,iCACL4C,QAAQK,MAAMC,MAAQ,MACtBN,QAAQnE,iCAAYuB,MAAMuD,iDAAW,+BACrCV,KAAKtB,UAAW,IAQxBG,mBACU8B,QAAUhF,KAAKgD,aAChBgC,cAIA9C,WAAW+C,eAAeD,SAoBnCF,sBAAsBP,iBAAkBW,oBAE9BF,QAAU,GAEVG,IAAM,OAGP,MAAOC,IAAKC,YAAaC,OAAOC,QAAQL,cAErCM,MAAMC,QAAQJ,WACdF,IAAIC,KAAO,GACXC,SAAS5E,SAAQjC,kBACMG,IAAfH,QAAQqC,SACF6E,sBAAeN,sCAEzBJ,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,WACRC,OAAQrH,gBAENsH,MAAQC,OAAOvH,QAAQqC,IAAImF,UACjCb,IAAIC,KAAKU,QAAS,MAGtBd,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,WACRC,OAAQR,eAKf,MAAOD,IAAKa,YAAaX,OAAOC,QAAQhB,kBAAmB,KACxD2B,aAAc,UAEQvH,IAAtBuG,aAAaE,OACbc,aAAc,GAEdV,MAAMC,QAAQQ,UAAW,KACpBC,kBAA4BvH,IAAbwG,IAAIC,WACdM,sBAAeN,kCAEzBa,SAASxF,SAAQjC,gBACPsH,MAAQC,OAAOvH,QAAQqC,IAAImF,cAC7BG,YAAcD,YAEbC,kBAAmCxH,IAApBwG,IAAIC,KAAKU,SACzBK,aAAc,GAEdA,aACAnB,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,SACRC,OAAQrH,iBAIjB,KACE0H,kBAA4BvH,IAAbwG,IAAIC,WACdM,uBAAgBN,iCAEtBc,aACAlB,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,SACRC,OAAQI,mBAMjBjB,QAUXoB,0BACWpG,KAAKoC,UAShBiE,QAAQC,SAAUC,YACT/H,QAAQiG,MAAM+B,cAASD,MAAME,uBAC7BjI,QAAQiG,MAAMiC,eAAUH,MAAMI,mBAMvC7D,kBACSV,WAAapC,KAAKoC,eAClBI,SAASoE,aAAa5G,KAAKoC,WAC5BpC,KAAKoC,eACAyE,cAEAC,OAObD,eAEUE,YAAcC,OAAOC,YAAc,EACnCC,YAAcF,OAAOG,WAAa,EAElC1C,MAAQ,CACV2C,SAAU,QACVC,OAAQ,OACRC,SAAU,OACVC,OAAQ,QACRC,MAAO,QACPhB,cAAQO,YAAc,UACtBL,eAASQ,YAAc,WAE3B5B,OAAOmC,OAAOzH,KAAKxB,QAAQiG,MAAOA,YAE7B1E,WAAWC,KAAKzB,UAAUsD,OAAO4C,MAAM8C,OAAS,YAChDxH,WAAWC,KAAKzB,UAAUgB,KAAKkF,MAAM8C,OAAS,YAE9C5E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAM1D+E,OACkB,CACV,WACA,SACA,WACA,MACA,OACA,SACA,SAEErG,SACFiH,MAAQ1H,KAAKxB,QAAQiG,MAAMkD,eAAeD,aAEzC/E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAQ1DY,kBAAkBnE,UACbA,QAAQyB,UAAWzB,QAAQ0C,QAAQiD,KAAO,CAAC3F,QAAQ0C,QAAQiD,IAAK3F,QAAQyB"}
\ No newline at end of file
diff --git a/lib/amd/src/local/reactive/debugpanel.js b/lib/amd/src/local/reactive/debugpanel.js
index 738ad6bbad385..f9c3c58909ee3 100644
--- a/lib/amd/src/local/reactive/debugpanel.js
+++ b/lib/amd/src/local/reactive/debugpanel.js
@@ -266,7 +266,7 @@ class DebugInstanceSubpanel extends BaseComponent {
this.addEventListener(
this.getElement(this.selectors.STATE),
'keyup',
- debounce(this._checkJSON, 500)
+ debounce(this._checkJSON.bind(this), 500)
);
this.addEventListener(
diff --git a/lib/classes/component.php b/lib/classes/component.php
index e7f3eb4b324ff..0c6063c9ecaaf 100644
--- a/lib/classes/component.php
+++ b/lib/classes/component.php
@@ -390,6 +390,9 @@ protected static function is_cache_valid(array $cache): bool {
$keyclasses = [
\core\exception\moodle_exception::class,
\core\output\bootstrap_renderer::class,
+ \core\lang_string::class,
+ \renderable::class,
+ \core\url::class,
];
foreach ($keyclasses as $classname) {
if (!array_key_exists($classname, $cache['classmap'])) {
@@ -727,14 +730,13 @@ protected static function fill_classmap_cache() {
self::$classmap = [];
self::load_classes('core', "$CFG->dirroot/lib/classes");
- self::load_legacy_classes($CFG->libdir);
+ self::load_legacy_classes($CFG->libdir, true);
foreach (self::$subsystems as $subsystem => $fulldir) {
if (!$fulldir) {
continue;
}
self::load_classes('core_' . $subsystem, "$fulldir/classes");
- self::load_legacy_classes($fulldir);
}
foreach (self::$plugins as $plugintype => $plugins) {
@@ -1448,8 +1450,12 @@ protected static function load_renamed_classes(?string $fulldir) {
* and the value is the path to the class file within the relative ../classes/ directory.
*
* @param string|null $fulldir The directory to the legacy classes.
+ * @param bool $allowsubsystems Whether to allow the specification of alternative subsystems for this path.
*/
- protected static function load_legacy_classes(?string $fulldir): void {
+ protected static function load_legacy_classes(
+ ?string $fulldir,
+ bool $allowsubsystems = false,
+ ): void {
if (is_null($fulldir)) {
return;
}
@@ -1460,7 +1466,32 @@ protected static function load_legacy_classes(?string $fulldir): void {
require($file);
if (is_array($legacyclasses)) {
foreach ($legacyclasses as $classname => $path) {
- self::$classmap[$classname] = "{$fulldir}/classes/{$path}";
+ if (is_array($path)) {
+ if (!$allowsubsystems) {
+ throw new \Exception(
+ "Invalid legacy classes path entry for {$classname}. " .
+ "Only files within the component can be specified.",
+ );
+ }
+ if (count($path) !== 2) {
+ throw new \Exception(
+ "Invalid legacy classes path entry for {$classname}. " .
+ "Entries must be in the format [subsystem, path].",
+ );
+ }
+ [$subsystem, $path] = $path;
+ $subsystem = substr($subsystem, 5);
+ if (!array_key_exists($subsystem, self::$subsystems)) {
+ throw new \Exception(
+ "Unknown subsystem '{$subsystem}' for legacy classes entry of '{$classname}'",
+ );
+ }
+
+ $subsystemfulldir = self::$subsystems[$subsystem];
+ self::$classmap[$classname] = "{$subsystemfulldir}/classes/{$path}";
+ } else {
+ self::$classmap[$classname] = "{$fulldir}/classes/{$path}";
+ }
}
}
}
diff --git a/lib/classes/emoticon_manager.php b/lib/classes/emoticon_manager.php
new file mode 100644
index 0000000000000..44351c022bd2d
--- /dev/null
+++ b/lib/classes/emoticon_manager.php
@@ -0,0 +1,191 @@
+.
+
+namespace core;
+
+use pix_emoticon;
+use stdClass;
+
+/**
+ * Provides core support for plugins that have to deal with emoticons (like HTML editor or emoticon filter).
+ *
+ * Whenever this manager mentiones 'emoticon object', the following data structure is expected:
+ * stdClass with properties text, imagename, imagecomponent, altidentifier and altcomponent
+ *
+ * @see \admin_setting_emoticons
+ *
+ * @package core
+ * @copyright 2010 David Mudrak
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class emoticon_manager {
+
+ /**
+ * Returns the currently enabled emoticons
+ *
+ * @param bool $selectable If true, only return emoticons that should be selectable from a list
+ * @return stdClass[] array of emoticon objects
+ */
+ public function get_emoticons(
+ bool $selectable = false,
+ ): array {
+ global $CFG;
+
+ $notselectable = ['martin', 'egg'];
+
+ if (empty($CFG->emoticons)) {
+ return [];
+ }
+
+ $emoticons = $this->decode_stored_config($CFG->emoticons);
+
+ if (!is_array($emoticons)) {
+ // Something is wrong with the format of stored setting.
+ debugging('Invalid format of emoticons setting, please resave the emoticons settings form', DEBUG_NORMAL);
+ return [];
+ }
+
+ if ($selectable) {
+ foreach ($emoticons as $index => $emote) {
+ if (in_array($emote->altidentifier, $notselectable)) {
+ // Skip this one.
+ unset($emoticons[$index]);
+ }
+ }
+ }
+
+ return $emoticons;
+ }
+
+ /**
+ * Converts emoticon object into renderable pix_emoticon object
+ *
+ * @param stdClass $emoticon emoticon object
+ * @param array $attributes explicit HTML attributes to set
+ * @return pix_emoticon
+ */
+ public function prepare_renderable_emoticon(
+ stdClass $emoticon,
+ array $attributes = [],
+ ): pix_emoticon {
+ $stringmanager = get_string_manager();
+ if ($stringmanager->string_exists($emoticon->altidentifier, $emoticon->altcomponent)) {
+ $alt = get_string($emoticon->altidentifier, $emoticon->altcomponent);
+ } else {
+ $alt = s($emoticon->text);
+ }
+ return new pix_emoticon($emoticon->imagename, $alt, $emoticon->imagecomponent, $attributes);
+ }
+
+ /**
+ * Encodes the array of emoticon objects into a string storable in config table
+ *
+ * @param stdClass[] $emoticons array of emoticon objects
+ * @return string
+ */
+ public function encode_stored_config(
+ array $emoticons,
+ ): string {
+ return json_encode($emoticons);
+ }
+
+ /**
+ * Decodes the string into an array of emoticon objects
+ *
+ * @param string $encoded
+ * @return ?array
+ */
+ public function decode_stored_config(
+ string $encoded,
+ ): ?array {
+ $decoded = json_decode($encoded);
+ if (!is_array($decoded)) {
+ return null;
+ }
+ return $decoded;
+ }
+
+ /**
+ * Returns default set of emoticons supported by Moodle
+ *
+ * @return stdClass[] array of emoticon objects
+ */
+ public function default_emoticons(): array {
+ return [
+ $this->prepare_emoticon_object(":-)", 's/smiley', 'smiley'),
+ $this->prepare_emoticon_object(":)", 's/smiley', 'smiley'),
+ $this->prepare_emoticon_object(":-D", 's/biggrin', 'biggrin'),
+ $this->prepare_emoticon_object(";-)", 's/wink', 'wink'),
+ $this->prepare_emoticon_object(":-/", 's/mixed', 'mixed'),
+ $this->prepare_emoticon_object("V-.", 's/thoughtful', 'thoughtful'),
+ $this->prepare_emoticon_object(":-P", 's/tongueout', 'tongueout'),
+ $this->prepare_emoticon_object(":-p", 's/tongueout', 'tongueout'),
+ $this->prepare_emoticon_object("B-)", 's/cool', 'cool'),
+ $this->prepare_emoticon_object("^-)", 's/approve', 'approve'),
+ $this->prepare_emoticon_object("8-)", 's/wideeyes', 'wideeyes'),
+ $this->prepare_emoticon_object(":o)", 's/clown', 'clown'),
+ $this->prepare_emoticon_object(":-(", 's/sad', 'sad'),
+ $this->prepare_emoticon_object(":(", 's/sad', 'sad'),
+ $this->prepare_emoticon_object("8-.", 's/shy', 'shy'),
+ $this->prepare_emoticon_object(":-I", 's/blush', 'blush'),
+ $this->prepare_emoticon_object(":-X", 's/kiss', 'kiss'),
+ $this->prepare_emoticon_object("8-o", 's/surprise', 'surprise'),
+ $this->prepare_emoticon_object("P-|", 's/blackeye', 'blackeye'),
+ $this->prepare_emoticon_object("8-[", 's/angry', 'angry'),
+ $this->prepare_emoticon_object("(grr)", 's/angry', 'angry'),
+ $this->prepare_emoticon_object("xx-P", 's/dead', 'dead'),
+ $this->prepare_emoticon_object("|-.", 's/sleepy', 'sleepy'),
+ $this->prepare_emoticon_object("}-]", 's/evil', 'evil'),
+ $this->prepare_emoticon_object("(h)", 's/heart', 'heart'),
+ $this->prepare_emoticon_object("(heart)", 's/heart', 'heart'),
+ $this->prepare_emoticon_object("(y)", 's/yes', 'yes', 'core'),
+ $this->prepare_emoticon_object("(n)", 's/no', 'no', 'core'),
+ $this->prepare_emoticon_object("(martin)", 's/martin', 'martin'),
+ $this->prepare_emoticon_object("( )", 's/egg', 'egg'),
+ ];
+ }
+
+ /**
+ * Helper method preparing an emoticon object
+ *
+ * @param string|string[] $text
+ * @param string $imagename to be used by {@see pix_emoticon}
+ * @param ?string $altidentifier alternative string identifier, null for no alt
+ * @param string $altcomponent where the alternative string is defined
+ * @param string $imagecomponent to be used by {@see pix_emoticon}
+ * @return stdClass
+ */
+ protected function prepare_emoticon_object(
+ string|array $text,
+ string $imagename,
+ ?string $altidentifier = null,
+ string $altcomponent = 'core_pix',
+ string $imagecomponent = 'core',
+ ): stdClass {
+ return (object) [
+ 'text' => $text,
+ 'imagename' => $imagename,
+ 'altidentifier' => $altidentifier,
+ 'altcomponent' => $altcomponent,
+ 'imagecomponent' => $imagecomponent,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(emoticon_manager::class, \emoticon_manager::class);
diff --git a/lib/classes/hook/navigation/secondary_extend.php b/lib/classes/hook/navigation/secondary_extend.php
new file mode 100644
index 0000000000000..ea25c2d14f6ad
--- /dev/null
+++ b/lib/classes/hook/navigation/secondary_extend.php
@@ -0,0 +1,55 @@
+.
+
+namespace core\hook\navigation;
+use core\hook\stoppable_trait;
+use core\navigation\views\secondary;
+
+/**
+ * Allows plugins to insert nodes into site secondary navigation
+ *
+ * @package core
+ * @author Sumaiya Javed
+ * @copyright 2024 Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins to insert nodes into site secondary navigation')]
+#[\core\attribute\tags('navigation')]
+final class secondary_extend {
+ use stoppable_trait;
+
+ /**
+ * Creates new hook.
+ *
+ * @param secondary $secondaryview secondary navigation view
+ */
+ public function __construct(
+ /**
+ * @var secondary $secondaryview secondary navigation view
+ */
+ public readonly secondary $secondaryview,
+ ) {
+ }
+
+ /**
+ * secondary navigation view
+ *
+ * @return secondary
+ */
+ public function get_secondaryview(): secondary {
+ return $this->secondaryview;
+ }
+}
diff --git a/lib/classes/lang_string.php b/lib/classes/lang_string.php
new file mode 100644
index 0000000000000..5f09a9b5cb86d
--- /dev/null
+++ b/lib/classes/lang_string.php
@@ -0,0 +1,280 @@
+.
+
+namespace core;
+
+use core\exception\coding_exception;
+use stdClass;
+
+/**
+ * The lang_string class
+ *
+ * This special class is used to create an object representation of a string request.
+ * It is special because processing doesn't occur until the object is first used.
+ * The class was created especially to aid performance in areas where strings were
+ * required to be generated but were not necessarily used.
+ * As an example the admin tree when generated uses over 1500 strings, of which
+ * normally only 1/3 are ever actually printed at any time.
+ * The performance advantage is achieved by not actually processing strings that
+ * aren't being used, as such reducing the processing required for the page.
+ *
+ * How to use the lang_string class?
+ * There are two methods of using the lang_string class, first through the
+ * forth argument of the get_string function, and secondly directly.
+ * The following are examples of both.
+ * 1. Through get_string calls e.g.
+ * $string = get_string($identifier, $component, $a, true);
+ * $string = get_string('yes', 'moodle', null, true);
+ * 2. Direct instantiation
+ * $string = new lang_string($identifier, $component, $a, $lang);
+ * $string = new lang_string('yes');
+ *
+ * How do I use a lang_string object?
+ * The lang_string object makes use of a magic __toString method so that you
+ * are able to use the object exactly as you would use a string in most cases.
+ * This means you are able to collect it into a variable and then directly
+ * echo it, or concatenate it into another string, or similar.
+ * The other thing you can do is manually get the string by calling the
+ * lang_strings out method e.g.
+ * $string = new lang_string('yes');
+ * $string->out();
+ * Also worth noting is that the out method can take one argument, $lang which
+ * allows the developer to change the language on the fly.
+ *
+ * When should I use a lang_string object?
+ * The lang_string object is designed to be used in any situation where a
+ * string may not be needed, but needs to be generated.
+ * The admin tree is a good example of where lang_string objects should be
+ * used.
+ * A more practical example would be any class that requires strings that may
+ * not be printed (after all classes get rendered by renderers and who knows
+ * what they will do ;))
+ *
+ * When should I not use a lang_string object?
+ * Don't use lang_strings when you are going to use a string immediately.
+ * There is no need as it will be processed immediately and there will be no
+ * advantage, and in fact perhaps a negative hit as a class has to be
+ * instantiated for a lang_string object, however get_string won't require
+ * that.
+ *
+ * Limitations:
+ * 1. You cannot use a lang_string object as an array offset. Doing so will
+ * result in PHP throwing an error. (You can use it as an object property!)
+ *
+ * @package core
+ * @copyright 2011 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class lang_string {
+
+ /** @var string The strings component. Default '' */
+ protected ?string $component = '';
+
+ /** @var array|stdClass Any arguments required for the string. Default null */
+ protected mixed $a = null;
+
+ /** @var string The processed string (once processed) */
+ protected ?string $string = null;
+
+ /**
+ * A special boolean. If set to true then the object has been woken up and
+ * cannot be regenerated. If this is set then $this->string MUST be used.
+ * @var bool
+ */
+ protected bool $forcedstring = false;
+
+ /**
+ * Constructs a lang_string object
+ *
+ * This function should do as little processing as possible to ensure the best
+ * performance for strings that won't be used.
+ *
+ * @param string $identifier The strings identifier
+ * @param string|null $component The strings component
+ * @param mixed $a Any arguments the string requires
+ * @param string|null $lang The language to use when processing the string.
+ * @throws coding_exception
+ */
+ public function __construct(
+ /** @var string The strings identifier */
+ protected readonly string $identifier,
+ ?string $component = '',
+ mixed $a = null,
+ /** @var string The language to use when processing the string*/
+ protected readonly ?string $lang = null,
+ ) {
+ if (empty($component)) {
+ $component = 'moodle';
+ }
+
+ $this->component = $component;
+
+ // We MUST duplicate $a to ensure that it if it changes by reference those
+ // changes are not carried across.
+ // To do this we always ensure $a or its properties/values are strings
+ // and that any properties/values that arn't convertable are forgotten.
+ if ($a !== null) {
+ if (is_scalar($a)) {
+ $this->a = $a;
+ } else if ($a instanceof lang_string) {
+ $this->a = $a->out();
+ } else if (is_object($a) || is_array($a)) {
+ $a = (array)$a;
+ $this->a = [];
+ foreach ($a as $key => $value) {
+ // Make sure conversion errors don't get displayed (results in '').
+ if (is_array($value)) {
+ $this->a[$key] = '';
+ } else if (is_object($value)) {
+ if (method_exists($value, '__toString')) {
+ $this->a[$key] = $value->__toString();
+ } else {
+ $this->a[$key] = '';
+ }
+ } else {
+ $this->a[$key] = (string)$value;
+ }
+ }
+ }
+ }
+
+ if (debugging(false, DEBUG_DEVELOPER)) {
+ if (clean_param($this->identifier, PARAM_STRINGID) == '') {
+ throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of ' .
+ 'the string identifier. Please check your string definition');
+ }
+ if (!empty($this->component) && clean_param($this->component, PARAM_COMPONENT) == '') {
+ throw new coding_exception('Invalid string compontent. Please check your string definition');
+ }
+ if (!get_string_manager()->string_exists($this->identifier, $this->component)) {
+ debugging('String does not exist. Please check your string definition for '.$this->identifier.'/'.$this->component,
+ DEBUG_DEVELOPER);
+ }
+ }
+ }
+
+ /**
+ * Processes the string.
+ *
+ * This function actually processes the string, stores it in the string property
+ * and then returns it.
+ * You will notice that this function is VERY similar to the get_string method.
+ * That is because it is pretty much doing the same thing.
+ * However as this function is an upgrade it isn't as tolerant to backwards
+ * compatibility.
+ *
+ * @return string
+ * @throws coding_exception
+ */
+ protected function get_string(): string {
+ global $CFG;
+
+ // Check if we need to process the string.
+ if ($this->string === null) {
+ // Check the quality of the identifier.
+ if ($CFG->debugdeveloper && clean_param($this->identifier, PARAM_STRINGID) === '') {
+ throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of ' .
+ 'the string identifier. Please check your string definition', DEBUG_DEVELOPER);
+ }
+
+ // Process the string.
+ $this->string = get_string_manager()->get_string($this->identifier, $this->component, $this->a, $this->lang);
+ // Debugging feature lets you display string identifier and component.
+ if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
+ $this->string .= ' {' . $this->identifier . '/' . $this->component . '}';
+ }
+ }
+ // Return the string.
+ return $this->string;
+ }
+
+ /**
+ * Returns the string
+ *
+ * @param string $lang The langauge to use when processing the string
+ * @return string
+ */
+ public function out($lang = null): string {
+ if ($lang !== null && $lang != $this->lang && ($this->lang == null && $lang != current_language())) {
+ if ($this->forcedstring) {
+ debugging('lang_string objects that have been used cannot be printed in another language. ('.$this->lang.' used)',
+ DEBUG_DEVELOPER);
+ return $this->get_string();
+ }
+ $translatedstring = new lang_string($this->identifier, $this->component, $this->a, $lang);
+ return $translatedstring->out();
+ }
+ return $this->get_string();
+ }
+
+ /**
+ * Magic __toString method for printing a string
+ *
+ * @return string
+ */
+ public function __toString() {
+ return $this->get_string();
+ }
+
+ /**
+ * Magic __set_state method used for var_export
+ *
+ * @param array $array
+ * @return self
+ */
+ public static function __set_state(array $array): self {
+ $tmp = new lang_string($array['identifier'], $array['component'], $array['a'], $array['lang']);
+ $tmp->string = $array['string'];
+ $tmp->forcedstring = $array['forcedstring'];
+ return $tmp;
+ }
+
+ /**
+ * Prepares the lang_string for sleep and stores only the forcedstring and
+ * string properties... the string cannot be regenerated so we need to ensure
+ * it is generated for this.
+ *
+ * @return array
+ */
+ public function __sleep() {
+ $this->get_string();
+ $this->forcedstring = true;
+ return ['forcedstring', 'string', 'lang'];
+ }
+
+ /**
+ * Returns the identifier.
+ *
+ * @return string
+ */
+ public function get_identifier(): string {
+ return $this->identifier;
+ }
+
+ /**
+ * Returns the component.
+ *
+ * @return string
+ */
+ public function get_component(): string {
+ return $this->component;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(lang_string::class, \lang_string::class);
diff --git a/lib/classes/navigation/views/secondary.php b/lib/classes/navigation/views/secondary.php
index d9461681165a4..431af85d37d19 100644
--- a/lib/classes/navigation/views/secondary.php
+++ b/lib/classes/navigation/views/secondary.php
@@ -432,6 +432,10 @@ protected function load_course_navigation(?navigation_node $rootnode = null): vo
self::TYPE_COURSE, null, 'coursehome'), reset($nodekeys)
);
}
+
+ // Allow plugins to add nodes to the secondary navigation.
+ $hook = new \core\hook\navigation\secondary_extend($this);
+ \core\di::get(\core\hook\manager::class)->dispatch($hook);
}
/**
diff --git a/lib/classes/output/action_link.php b/lib/classes/output/action_link.php
new file mode 100644
index 0000000000000..c34d69ef17a8e
--- /dev/null
+++ b/lib/classes/output/action_link.php
@@ -0,0 +1,168 @@
+.
+
+namespace core\output;
+
+use core\output\actions\component_action;
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure describing html link with special action attached.
+ *
+ * @copyright 2010 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class action_link implements renderable {
+ /**
+ * @var moodle_url Href url
+ */
+ public $url;
+
+ /**
+ * @var string Link text HTML fragment
+ */
+ public $text;
+
+ /**
+ * @var array HTML attributes
+ */
+ public $attributes;
+
+ /**
+ * @var array List of actions attached to link
+ */
+ public $actions;
+
+ /**
+ * @var pix_icon Optional pix icon to render with the link
+ */
+ public $icon;
+
+ /**
+ * Constructor
+ * @param moodle_url $url
+ * @param string $text HTML fragment
+ * @param null|component_action $action
+ * @param null|array $attributes associative array of html link attributes + disabled
+ * @param null|pix_icon $icon optional pix_icon to render with the link text
+ */
+ public function __construct(
+ moodle_url $url,
+ $text,
+ ?component_action $action = null,
+ ?array $attributes = null,
+ ?pix_icon $icon = null
+ ) {
+ $this->url = clone($url);
+ $this->text = $text;
+ if (empty($attributes['id'])) {
+ $attributes['id'] = html_writer::random_id('action_link');
+ }
+ $this->attributes = (array)$attributes;
+ if ($action) {
+ $this->add_action($action);
+ }
+ $this->icon = $icon;
+ }
+
+ /**
+ * Add action to the link.
+ *
+ * @param component_action $action
+ */
+ public function add_action(component_action $action) {
+ $this->actions[] = $action;
+ }
+
+ /**
+ * Adds a CSS class to this action link object
+ * @param string $class
+ */
+ public function add_class($class) {
+ if (empty($this->attributes['class'])) {
+ $this->attributes['class'] = $class;
+ } else {
+ $this->attributes['class'] .= ' ' . $class;
+ }
+ }
+
+ /**
+ * Returns true if the specified class has been added to this link.
+ * @param string $class
+ * @return bool
+ */
+ public function has_class($class) {
+ return strpos(' ' . $this->attributes['class'] . ' ', ' ' . $class . ' ') !== false;
+ }
+
+ /**
+ * Return the rendered HTML for the icon. Useful for rendering action links in a template.
+ * @return string
+ */
+ public function get_icon_html() {
+ global $OUTPUT;
+ if (!$this->icon) {
+ return '';
+ }
+ return $OUTPUT->render($this->icon);
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $data = new stdClass();
+ $attributes = $this->attributes;
+
+ $data->id = $attributes['id'];
+ unset($attributes['id']);
+
+ $data->disabled = !empty($attributes['disabled']);
+ unset($attributes['disabled']);
+
+ $data->text = $this->text instanceof renderable ? $output->render($this->text) : (string) $this->text;
+ $data->url = $this->url ? $this->url->out(false) : '';
+ $data->icon = $this->icon ? $this->icon->export_for_pix() : null;
+ $data->classes = isset($attributes['class']) ? $attributes['class'] : '';
+ unset($attributes['class']);
+
+ $data->attributes = array_map(function ($key, $value) {
+ return [
+ 'name' => $key,
+ 'value' => $value,
+ ];
+ }, array_keys($attributes), $attributes);
+
+ $data->actions = array_map(function ($action) use ($output) {
+ return $action->export_for_template($output);
+ }, !empty($this->actions) ? $this->actions : []);
+ $data->hasactions = !empty($this->actions);
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(action_link::class, \action_link::class);
diff --git a/lib/classes/output/action_menu.php b/lib/classes/output/action_menu.php
new file mode 100644
index 0000000000000..261054f1f9665
--- /dev/null
+++ b/lib/classes/output/action_menu.php
@@ -0,0 +1,681 @@
+.
+
+namespace core\output;
+
+use core\exception\coding_exception;
+use core\lang_string;
+use core\output\local\action_menu\subpanel;
+use core\output\action_menu\link as action_menu_link;
+use core\output\action_menu\filler as action_menu_filler;
+use moodle_page;
+use stdClass;
+
+/**
+ * An action menu.
+ *
+ * This action menu component takes a series of primary and secondary actions.
+ * The primary actions are displayed permanently and the secondary attributes are displayed within a drop
+ * down menu.
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class action_menu implements renderable, templatable {
+ /**
+ * Top right alignment.
+ */
+ const TL = 1;
+
+ /**
+ * Top right alignment.
+ */
+ const TR = 2;
+
+ /**
+ * Top right alignment.
+ */
+ const BL = 3;
+
+ /**
+ * Top right alignment.
+ */
+ const BR = 4;
+
+ /**
+ * The instance number. This is unique to this instance of the action menu.
+ * @var int
+ */
+ protected $instance = 0;
+
+ /**
+ * An array of primary actions. Please use {@see action_menu::add_primary_action()} to add actions.
+ * @var array
+ */
+ protected $primaryactions = [];
+
+ /**
+ * An array of secondary actions. Please use {@see action_menu::add_secondary_action()} to add actions.
+ * @var array
+ */
+ protected $secondaryactions = [];
+
+ /**
+ * An array of attributes added to the container of the action menu.
+ * Initialised with defaults during construction.
+ * @var array
+ */
+ public $attributes = [];
+ /**
+ * An array of attributes added to the container of the primary actions.
+ * Initialised with defaults during construction.
+ * @var array
+ */
+ public $attributesprimary = [];
+ /**
+ * An array of attributes added to the container of the secondary actions.
+ * Initialised with defaults during construction.
+ * @var array
+ */
+ public $attributessecondary = [];
+
+ /**
+ * The string to use next to the icon for the action icon relating to the secondary (dropdown) menu.
+ * @var array
+ */
+ public $actiontext = null;
+
+ /**
+ * The string to use for the accessible label for the menu.
+ * @var array
+ */
+ public $actionlabel = null;
+
+ /**
+ * An icon to use for the toggling the secondary menu (dropdown).
+ * @var pix_icon
+ */
+ public $actionicon;
+
+ /**
+ * Any text to use for the toggling the secondary menu (dropdown).
+ * @var string
+ */
+ public $menutrigger = '';
+
+ /**
+ * An array of attributes added to the trigger element of the secondary menu.
+ * @var array
+ */
+ public $triggerattributes = [];
+
+ /**
+ * Any extra classes for toggling to the secondary menu.
+ * @var string
+ */
+ public $triggerextraclasses = '';
+
+ /**
+ * Place the action menu before all other actions.
+ * @var bool
+ */
+ public $prioritise = false;
+
+ /**
+ * Dropdown menu alignment class.
+ * @var string
+ */
+ public $dropdownalignment = '';
+
+ /**
+ * Constructs the action menu with the given items.
+ *
+ * @param array $actions An array of actions (action_menu_link|pix_icon|string).
+ */
+ public function __construct(array $actions = []) {
+ static $initialised = 0;
+ $this->instance = $initialised;
+ $initialised++;
+
+ $this->attributes = [
+ 'id' => 'action-menu-' . $this->instance,
+ 'class' => 'moodle-actionmenu',
+ 'data-enhance' => 'moodle-core-actionmenu',
+ ];
+ $this->attributesprimary = [
+ 'id' => 'action-menu-' . $this->instance . '-menubar',
+ 'class' => 'menubar',
+ ];
+ $this->attributessecondary = [
+ 'id' => 'action-menu-' . $this->instance . '-menu',
+ 'class' => 'menu',
+ 'data-rel' => 'menu-content',
+ 'aria-labelledby' => 'action-menu-toggle-' . $this->instance,
+ 'role' => 'menu',
+ ];
+ $this->dropdownalignment = 'dropdown-menu-right';
+ foreach ($actions as $action) {
+ $this->add($action);
+ }
+ }
+
+ /**
+ * Sets the label for the menu trigger.
+ *
+ * @param string $label The text
+ */
+ public function set_action_label($label) {
+ $this->actionlabel = $label;
+ }
+
+ /**
+ * Sets the menu trigger text.
+ *
+ * @param string $trigger The text
+ * @param string $extraclasses Extra classes to style the secondary menu toggle.
+ */
+ public function set_menu_trigger($trigger, $extraclasses = '') {
+ $this->menutrigger = $trigger;
+ $this->triggerextraclasses = $extraclasses;
+ }
+
+ /**
+ * Classes for the trigger menu
+ */
+ const DEFAULT_KEBAB_TRIGGER_CLASSES = 'btn btn-icon d-flex align-items-center justify-content-center no-caret';
+
+ /**
+ * Setup trigger as in the kebab menu.
+ *
+ * @param string|null $triggername
+ * @param core_renderer|null $output
+ * @param string|null $extraclasses extra classes for the trigger {@see self::set_menu_trigger()}
+ * @throws coding_exception
+ */
+ public function set_kebab_trigger(
+ ?string $triggername = null,
+ ?core_renderer $output = null,
+ ?string $extraclasses = ''
+ ) {
+ global $OUTPUT;
+ if (empty($output)) {
+ $output = $OUTPUT;
+ }
+ $label = $triggername ?? get_string('actions');
+ $triggerclasses = self::DEFAULT_KEBAB_TRIGGER_CLASSES . ' ' . $extraclasses;
+ $icon = $output->pix_icon('i/menu', $label);
+ $this->set_menu_trigger($icon, $triggerclasses);
+ }
+
+ /**
+ * Return true if there is at least one visible link in the menu.
+ *
+ * @return bool
+ */
+ public function is_empty() {
+ return !count($this->primaryactions) && !count($this->secondaryactions);
+ }
+
+ /**
+ * Initialises JS required fore the action menu.
+ * The JS is only required once as it manages all action menu's on the page.
+ *
+ * @param moodle_page $page
+ */
+ public function initialise_js(moodle_page $page) {
+ static $initialised = false;
+ if (!$initialised) {
+ $page->requires->yui_module('moodle-core-actionmenu', 'M.core.actionmenu.init');
+ $initialised = true;
+ }
+ }
+
+ /**
+ * Adds an action to this action menu.
+ *
+ * @param action_link|pix_icon|subpanel|string $action
+ */
+ public function add($action) {
+
+ if ($action instanceof subpanel) {
+ $this->add_secondary_subpanel($action);
+ } else if ($action instanceof action_link) {
+ if ($action->primary) {
+ $this->add_primary_action($action);
+ } else {
+ $this->add_secondary_action($action);
+ }
+ } else if ($action instanceof pix_icon) {
+ $this->add_primary_action($action);
+ } else {
+ $this->add_secondary_action($action);
+ }
+ }
+
+ /**
+ * Adds a secondary subpanel.
+ * @param subpanel $subpanel
+ */
+ public function add_secondary_subpanel(subpanel $subpanel) {
+ $this->secondaryactions[] = $subpanel;
+ }
+
+ /**
+ * Adds a primary action to the action menu.
+ *
+ * @param action_menu_link|action_link|pix_icon|string $action
+ */
+ public function add_primary_action($action) {
+ if ($action instanceof action_link || $action instanceof pix_icon) {
+ $action->attributes['role'] = 'menuitem';
+ $action->attributes['tabindex'] = '-1';
+ if ($action instanceof action_menu_link) {
+ $action->actionmenu = $this;
+ }
+ }
+ $this->primaryactions[] = $action;
+ }
+
+ /**
+ * Adds a secondary action to the action menu.
+ *
+ * @param action_link|pix_icon|string $action
+ */
+ public function add_secondary_action($action) {
+ if ($action instanceof action_link || $action instanceof pix_icon) {
+ $action->attributes['role'] = 'menuitem';
+ $action->attributes['tabindex'] = '-1';
+ if ($action instanceof action_menu_link) {
+ $action->actionmenu = $this;
+ }
+ }
+ $this->secondaryactions[] = $action;
+ }
+
+ /**
+ * Returns the primary actions ready to be rendered.
+ *
+ * @param null|core_renderer $output The renderer to use for getting icons.
+ * @return array
+ */
+ public function get_primary_actions(?core_renderer $output = null) {
+ global $OUTPUT;
+ if ($output === null) {
+ $output = $OUTPUT;
+ }
+ $pixicon = $this->actionicon;
+ $linkclasses = ['toggle-display'];
+
+ $title = '';
+ if (!empty($this->menutrigger)) {
+ $pixicon = '';
+ $linkclasses[] = 'textmenu';
+ } else {
+ $title = new lang_string('actionsmenu', 'moodle');
+ $this->actionicon = new pix_icon(
+ 't/edit_menu',
+ '',
+ 'moodle',
+ ['class' => 'iconsmall actionmenu', 'title' => '']
+ );
+ $pixicon = $this->actionicon;
+ }
+ if ($pixicon instanceof renderable) {
+ $pixicon = $output->render($pixicon);
+ if ($pixicon instanceof pix_icon && isset($pixicon->attributes['alt'])) {
+ $title = $pixicon->attributes['alt'];
+ }
+ }
+ $string = '';
+ if ($this->actiontext) {
+ $string = $this->actiontext;
+ }
+ $label = '';
+ if ($this->actionlabel) {
+ $label = $this->actionlabel;
+ } else {
+ $label = $title;
+ }
+ $actions = $this->primaryactions;
+ $attributes = [
+ 'class' => implode(' ', $linkclasses),
+ 'title' => $title,
+ 'aria-label' => $label,
+ 'id' => 'action-menu-toggle-' . $this->instance,
+ 'role' => 'menuitem',
+ 'tabindex' => '-1',
+ ];
+ $link = html_writer::link('#', $string . $this->menutrigger . $pixicon, $attributes);
+ if ($this->prioritise) {
+ array_unshift($actions, $link);
+ } else {
+ $actions[] = $link;
+ }
+ return $actions;
+ }
+
+ /**
+ * Returns the secondary actions ready to be rendered.
+ * @return array
+ */
+ public function get_secondary_actions() {
+ return $this->secondaryactions;
+ }
+
+ /**
+ * Sets the selector that should be used to find the owning node of this menu.
+ * @param string $selector A CSS/YUI selector to identify the owner of the menu.
+ */
+ public function set_owner_selector($selector) {
+ $this->attributes['data-owner'] = $selector;
+ }
+
+ /**
+ * Sets the alignment of the dialogue in relation to button used to toggle it.
+ *
+ * @deprecated since Moodle 4.0
+ *
+ * @param int $dialogue One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
+ * @param int $button One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
+ */
+ public function set_alignment($dialogue, $button) {
+ debugging('The method action_menu::set_alignment() is deprecated, use action_menu::set_menu_left()', DEBUG_DEVELOPER);
+ if (isset($this->attributessecondary['data-align'])) {
+ // We've already got one set, lets remove the old class so as to avoid troubles.
+ $class = $this->attributessecondary['class'];
+ $search = 'align-' . $this->attributessecondary['data-align'];
+ $this->attributessecondary['class'] = str_replace($search, '', $class);
+ }
+ $align = $this->get_align_string($dialogue) . '-' . $this->get_align_string($button);
+ $this->attributessecondary['data-align'] = $align;
+ $this->attributessecondary['class'] .= ' align-' . $align;
+ }
+
+ /**
+ * Returns a string to describe the alignment.
+ *
+ * @param int $align One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
+ * @return string
+ */
+ protected function get_align_string($align) {
+ switch ($align) {
+ case self::TL:
+ return 'tl';
+ case self::TR:
+ return 'tr';
+ case self::BL:
+ return 'bl';
+ case self::BR:
+ return 'br';
+ default:
+ return 'tl';
+ }
+ }
+
+ /**
+ * Aligns the left corner of the dropdown.
+ *
+ */
+ public function set_menu_left() {
+ $this->dropdownalignment = 'dropdown-menu-left';
+ }
+
+ /**
+ * Sets a constraint for the dialogue.
+ *
+ * The constraint is applied when the dialogue is shown and limits the display of the dialogue to within the
+ * element the constraint identifies.
+ *
+ * This is required whenever the action menu is displayed inside any CSS element with the .no-overflow class
+ * (flexible_table and any of it's child classes are a likely candidate).
+ *
+ * @deprecated since Moodle 4.3
+ * @param string $ancestorselector A snippet of CSS used to identify the ancestor to contrain the dialogue to.
+ */
+ public function set_constraint($ancestorselector) {
+ debugging('The method set_constraint() is deprecated. Please use the set_boundary() method instead.', DEBUG_DEVELOPER);
+ $this->set_boundary('window');
+ }
+
+ /**
+ * Set the overflow constraint boundary of the dropdown menu.
+ * @see https://getbootstrap.com/docs/4.6/components/dropdowns/#options The 'boundary' option in the Bootstrap documentation
+ *
+ * @param string $boundary Accepts the values of 'viewport', 'window', or 'scrollParent'.
+ * @throws coding_exception
+ */
+ public function set_boundary(string $boundary) {
+ if (!in_array($boundary, ['viewport', 'window', 'scrollParent'])) {
+ throw new coding_exception("HTMLElement reference boundaries are not supported." .
+ "Accepted boundaries are 'viewport', 'window', or 'scrollParent'.", DEBUG_DEVELOPER);
+ }
+
+ $this->triggerattributes['data-boundary'] = $boundary;
+ }
+
+ /**
+ * If you call this method the action menu will be displayed but will not be enhanced.
+ *
+ * By not displaying the menu enhanced all items will be displayed in a single row.
+ *
+ * @deprecated since Moodle 3.2
+ */
+ public function do_not_enhance() {
+ debugging('The method action_menu::do_not_enhance() is deprecated, use a list of action_icon instead.', DEBUG_DEVELOPER);
+ }
+
+ /**
+ * Returns true if this action menu will be enhanced.
+ *
+ * @return bool
+ */
+ public function will_be_enhanced() {
+ return isset($this->attributes['data-enhance']);
+ }
+
+ /**
+ * Sets nowrap on items. If true menu items should not wrap lines if they are longer than the available space.
+ *
+ * This property can be useful when the action menu is displayed within a parent element that is either floated
+ * or relatively positioned.
+ * In that situation the width of the menu is determined by the width of the parent element which may not be large
+ * enough for the menu items without them wrapping.
+ * This disables the wrapping so that the menu takes on the width of the longest item.
+ *
+ * @param bool $value If true nowrap gets set, if false it gets removed. Defaults to true.
+ */
+ public function set_nowrap_on_items($value = true) {
+ $class = 'nowrap-items';
+ if (!empty($this->attributes['class'])) {
+ $pos = strpos($this->attributes['class'], $class);
+ if ($value === true && $pos === false) {
+ // The value is true and the class has not been set yet. Add it.
+ $this->attributes['class'] .= ' ' . $class;
+ } else if ($value === false && $pos !== false) {
+ // The value is false and the class has been set. Remove it.
+ $this->attributes['class'] = substr($this->attributes['class'], $pos, strlen($class));
+ }
+ } else if ($value) {
+ // The value is true and the class has not been set yet. Add it.
+ $this->attributes['class'] = $class;
+ }
+ }
+
+ /**
+ * Add classes to the action menu for an easier styling.
+ *
+ * @param string $class The class to add to attributes.
+ */
+ public function set_additional_classes(string $class = '') {
+ if (!empty($this->attributes['class'])) {
+ $this->attributes['class'] .= " " . $class;
+ } else {
+ $this->attributes['class'] = $class;
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $data = new stdClass();
+ // Assign a role of menubar to this action menu when:
+ // - it contains 2 or more primary actions; or
+ // - if it contains a primary action and secondary actions.
+ if (count($this->primaryactions) > 1 || (!empty($this->primaryactions) && !empty($this->secondaryactions))) {
+ $this->attributes['role'] = 'menubar';
+ }
+ $attributes = $this->attributes;
+
+ $data->instance = $this->instance;
+
+ $data->classes = isset($attributes['class']) ? $attributes['class'] : '';
+ unset($attributes['class']);
+
+ $data->attributes = array_map(function ($key, $value) {
+ return [ 'name' => $key, 'value' => $value ];
+ }, array_keys($attributes), $attributes);
+
+ $data->primary = $this->export_primary_actions_for_template($output);
+ $data->secondary = $this->export_secondary_actions_for_template($output);
+ $data->dropdownalignment = $this->dropdownalignment;
+
+ return $data;
+ }
+
+ /**
+ * Export the primary actions for the template.
+ * @param renderer_base $output
+ * @return stdClass
+ */
+ protected function export_primary_actions_for_template(renderer_base $output): stdClass {
+ $attributes = $this->attributes;
+ $attributesprimary = $this->attributesprimary;
+
+ $primary = new stdClass();
+ $primary->title = '';
+ $primary->prioritise = $this->prioritise;
+
+ $primary->classes = isset($attributesprimary['class']) ? $attributesprimary['class'] : '';
+ unset($attributesprimary['class']);
+
+ $primary->attributes = array_map(function ($key, $value) {
+ return ['name' => $key, 'value' => $value];
+ }, array_keys($attributesprimary), $attributesprimary);
+ $primary->triggerattributes = array_map(function ($key, $value) {
+ return ['name' => $key, 'value' => $value];
+ }, array_keys($this->triggerattributes), $this->triggerattributes);
+
+ $actionicon = $this->actionicon;
+ if (!empty($this->menutrigger)) {
+ $primary->menutrigger = $this->menutrigger;
+ $primary->triggerextraclasses = $this->triggerextraclasses;
+ if ($this->actionlabel) {
+ $primary->title = $this->actionlabel;
+ } else if ($this->actiontext) {
+ $primary->title = $this->actiontext;
+ } else {
+ $primary->title = strip_tags($this->menutrigger);
+ }
+ } else {
+ $primary->title = get_string('actionsmenu');
+ $iconattributes = ['class' => 'iconsmall actionmenu', 'title' => $primary->title];
+ $actionicon = new pix_icon('t/edit_menu', '', 'moodle', $iconattributes);
+ }
+
+ // If the menu trigger is within the menubar, assign a role of menuitem. Otherwise, assign as a button.
+ $primary->triggerrole = 'button';
+ if (isset($attributes['role']) && $attributes['role'] === 'menubar') {
+ $primary->triggerrole = 'menuitem';
+ }
+
+ if ($actionicon instanceof pix_icon) {
+ $primary->icon = $actionicon->export_for_pix();
+ if (!empty($actionicon->attributes['alt'])) {
+ $primary->title = $actionicon->attributes['alt'];
+ }
+ } else {
+ $primary->iconraw = $actionicon ? $output->render($actionicon) : '';
+ }
+
+ $primary->actiontext = $this->actiontext ? (string) $this->actiontext : '';
+ $primary->items = array_map(function ($item) use ($output) {
+ $data = (object) [];
+ if ($item instanceof action_menu_link) {
+ $data->actionmenulink = $item->export_for_template($output);
+ } else if ($item instanceof action_menu_filler) {
+ $data->actionmenufiller = $item->export_for_template($output);
+ } else if ($item instanceof action_link) {
+ $data->actionlink = $item->export_for_template($output);
+ } else if ($item instanceof pix_icon) {
+ $data->pixicon = $item->export_for_template($output);
+ } else {
+ $data->rawhtml = ($item instanceof renderable) ? $output->render($item) : $item;
+ }
+ return $data;
+ }, $this->primaryactions);
+ return $primary;
+ }
+
+ /**
+ * Export the secondary actions for the template.
+ * @param renderer_base $output
+ * @return stdClass
+ */
+ protected function export_secondary_actions_for_template(renderer_base $output): stdClass {
+ $attributessecondary = $this->attributessecondary;
+ $secondary = new stdClass();
+ $secondary->classes = isset($attributessecondary['class']) ? $attributessecondary['class'] : '';
+ unset($attributessecondary['class']);
+
+ $secondary->attributes = array_map(function ($key, $value) {
+ return ['name' => $key, 'value' => $value];
+ }, array_keys($attributessecondary), $attributessecondary);
+ $secondary->items = array_map(function ($item) use ($output) {
+ $data = (object) [
+ 'simpleitem' => true,
+ ];
+ if ($item instanceof action_menu_link) {
+ $data->actionmenulink = $item->export_for_template($output);
+ $data->simpleitem = false;
+ } else if ($item instanceof action_menu_filler) {
+ $data->actionmenufiller = $item->export_for_template($output);
+ $data->simpleitem = false;
+ } else if ($item instanceof subpanel) {
+ $data->subpanel = $item->export_for_template($output);
+ $data->simpleitem = false;
+ } else if ($item instanceof action_link) {
+ $data->actionlink = $item->export_for_template($output);
+ } else if ($item instanceof pix_icon) {
+ $data->pixicon = $item->export_for_template($output);
+ } else {
+ $data->rawhtml = ($item instanceof renderable) ? $output->render($item) : $item;
+ }
+ return $data;
+ }, $this->secondaryactions);
+ return $secondary;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(action_menu::class, \action_menu::class);
diff --git a/lib/classes/output/action_menu/filler.php b/lib/classes/output/action_menu/filler.php
new file mode 100644
index 0000000000000..1d8863ebb87b0
--- /dev/null
+++ b/lib/classes/output/action_menu/filler.php
@@ -0,0 +1,49 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\action_link;
+use core\output\html_writer;
+use core\output\renderable;
+
+/**
+ * An action menu filler
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class filler extends action_link implements renderable {
+ /**
+ * True if this is a primary action. False if not.
+ * @var bool
+ */
+ public $primary = true;
+
+ /**
+ * Constructs the object.
+ */
+ public function __construct() {
+ $this->attributes['id'] = html_writer::random_id('action_link');
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(filler::class, \action_menu_filler::class);
diff --git a/lib/classes/output/action_menu/link.php b/lib/classes/output/action_menu/link.php
new file mode 100644
index 0000000000000..ea6b2da25f2f9
--- /dev/null
+++ b/lib/classes/output/action_menu/link.php
@@ -0,0 +1,120 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\action_menu;
+use core\output\action_link;
+use core\output\pix_icon;
+use core\output\renderable;
+use core\output\renderer_base;
+use moodle_url;
+use stdClass;
+
+/**
+ * An action menu action
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class link extends action_link implements renderable {
+ /**
+ * True if this is a primary action. False if not.
+ * @var bool
+ */
+ public $primary = true;
+
+ /**
+ * The action menu this link has been added to.
+ * @var action_menu
+ */
+ public $actionmenu = null;
+
+ /**
+ * The number of instances of this action menu link (and its subclasses).
+ *
+ * @var int
+ * @deprecated since Moodle 4.4.
+ */
+ protected static $instance = 1;
+
+ /**
+ * Constructs the object.
+ *
+ * @param moodle_url $url The URL for the action.
+ * @param pix_icon|null $icon The icon to represent the action.
+ * @param string $text The text to represent the action.
+ * @param bool $primary Whether this is a primary action or not.
+ * @param array $attributes Any attribtues associated with the action.
+ */
+ public function __construct(moodle_url $url, ?pix_icon $icon, $text, $primary = true, array $attributes = []) {
+ parent::__construct($url, $text, null, $attributes, $icon);
+ $this->primary = (bool)$primary;
+ $this->add_class('menu-action');
+ $this->attributes['role'] = 'menuitem';
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $data = parent::export_for_template($output);
+
+ // Ignore what the parent did with the attributes, except for ID and class.
+ $data->attributes = [];
+ $attributes = $this->attributes;
+ unset($attributes['id']);
+ unset($attributes['class']);
+
+ // Handle text being a renderable.
+ if ($this->text instanceof renderable) {
+ $data->text = $this->render($this->text);
+ }
+
+ $data->showtext = (!$this->icon || $this->primary === false);
+
+ $data->icon = null;
+ if ($this->icon) {
+ $icon = $this->icon;
+ if ($this->primary || !$this->actionmenu->will_be_enhanced()) {
+ $attributes['title'] = $data->text;
+ }
+ $data->icon = $icon ? $icon->export_for_pix() : null;
+ }
+
+ $data->disabled = !empty($attributes['disabled']);
+ unset($attributes['disabled']);
+
+ $data->attributes = array_map(function ($key, $value) {
+ return [
+ 'name' => $key,
+ 'value' => $value,
+ ];
+ }, array_keys($attributes), $attributes);
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(link::class, \action_menu_link::class);
diff --git a/lib/classes/output/action_menu/link_primary.php b/lib/classes/output/action_menu/link_primary.php
new file mode 100644
index 0000000000000..c7d314b98ce24
--- /dev/null
+++ b/lib/classes/output/action_menu/link_primary.php
@@ -0,0 +1,47 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\pix_icon;
+use moodle_url;
+
+/**
+ * A primary action menu action
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class link_primary extends link {
+ /**
+ * Constructs the object.
+ *
+ * @param moodle_url $url
+ * @param pix_icon|null $icon
+ * @param string $text
+ * @param array $attributes
+ */
+ public function __construct(moodle_url $url, ?pix_icon $icon, $text, array $attributes = []) {
+ parent::__construct($url, $icon, $text, true, $attributes);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(link_primary::class, \action_menu_link_primary::class);
diff --git a/lib/classes/output/action_menu/link_secondary.php b/lib/classes/output/action_menu/link_secondary.php
new file mode 100644
index 0000000000000..dac7767f2ef58
--- /dev/null
+++ b/lib/classes/output/action_menu/link_secondary.php
@@ -0,0 +1,47 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\pix_icon;
+use moodle_url;
+
+/**
+ * A secondary action menu action
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class link_secondary extends link {
+ /**
+ * Constructs the object.
+ *
+ * @param moodle_url $url
+ * @param pix_icon|null $icon
+ * @param string $text
+ * @param array $attributes
+ */
+ public function __construct(moodle_url $url, ?pix_icon $icon, $text, array $attributes = []) {
+ parent::__construct($url, $icon, $text, false, $attributes);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(link_secondary::class, \action_menu_link_secondary::class);
diff --git a/lib/classes/output/local/action_menu/subpanel.php b/lib/classes/output/action_menu/subpanel.php
similarity index 86%
rename from lib/classes/output/local/action_menu/subpanel.php
rename to lib/classes/output/action_menu/subpanel.php
index cfcca6d6bb191..94257d2a097d0 100644
--- a/lib/classes/output/local/action_menu/subpanel.php
+++ b/lib/classes/output/action_menu/subpanel.php
@@ -14,17 +14,17 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -80,3 +80,8 @@ public function export_for_template(\renderer_base $output): stdClass {
return $data;
}
}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(subpanel::class, \core\output\local\action_menu\subpanel::class);
diff --git a/lib/classes/output/actions/component_action.php b/lib/classes/output/actions/component_action.php
new file mode 100644
index 0000000000000..e8af7e60dbfc2
--- /dev/null
+++ b/lib/classes/output/actions/component_action.php
@@ -0,0 +1,90 @@
+.
+
+namespace core\output\actions;
+
+use core\exception\coding_exception;
+use core\output\renderer_base;
+use core\output\templatable;
+use stdClass;
+
+/**
+ * Helper class used by other components that involve an action on the page (URL or JS).
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class component_action implements templatable {
+ /**
+ * @var string $event The DOM event that will trigger this action when caught
+ */
+ public $event;
+
+ /**
+ * @var string A function name to call when the button is clicked
+ * The JS function you create must have two arguments:
+ * 1. The event object
+ * 2. An object/array of arguments ($jsfunctionargs)
+ */
+ public $jsfunction = false;
+
+ /**
+ * @var array An array of arguments to pass to the JS function
+ */
+ public $jsfunctionargs = [];
+
+ /**
+ * Constructor
+ * @param string $event DOM event
+ * @param string $jsfunction An optional JS function. Required if jsfunctionargs is given
+ * @param array $jsfunctionargs An array of arguments to pass to the jsfunction
+ */
+ public function __construct($event, $jsfunction, $jsfunctionargs = []) {
+ $this->event = $event;
+
+ $this->jsfunction = $jsfunction;
+ $this->jsfunctionargs = $jsfunctionargs;
+
+ if (!empty($this->jsfunctionargs)) {
+ if (empty($this->jsfunction)) {
+ throw new coding_exception('The component_action object needs a jsfunction value to pass the jsfunctionargs to.');
+ }
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $args = !empty($this->jsfunctionargs) ? json_encode($this->jsfunctionargs) : false;
+ return (object) [
+ 'event' => $this->event,
+ 'jsfunction' => $this->jsfunction,
+ 'jsfunctionargs' => $args,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(component_action::class, \component_action::class);
diff --git a/lib/classes/output/actions/confirm_action.php b/lib/classes/output/actions/confirm_action.php
new file mode 100644
index 0000000000000..f18ce1c1fbdcc
--- /dev/null
+++ b/lib/classes/output/actions/confirm_action.php
@@ -0,0 +1,58 @@
+.
+
+namespace core\output\actions;
+
+/**
+ * Confirm action
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class confirm_action extends component_action {
+ /**
+ * Constructs the confirm action object
+ *
+ * @param string $message The message to display to the user when they are shown
+ * the confirm dialogue.
+ * @param string $callback Deprecated since 2.7
+ * @param string $continuelabel The string to use for he continue button
+ * @param string $cancellabel The string to use for the cancel button
+ */
+ public function __construct($message, $callback = null, $continuelabel = null, $cancellabel = null) {
+ if ($callback !== null) {
+ debugging(
+ 'The callback argument to new confirm_action() has been deprecated.' .
+ ' If you need to use a callback, please write Javascript to use moodle-core-notification-confirmation ' .
+ 'and attach to the provided events.',
+ DEBUG_DEVELOPER,
+ );
+ }
+ parent::__construct('click', 'M.util.show_confirm_dialog', [
+ 'message' => $message,
+ 'continuelabel' => $continuelabel,
+ 'cancellabel' => $cancellabel,
+ ]);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(confirm_action::class, \confirm_action::class);
diff --git a/lib/classes/output/actions/popup_action.php b/lib/classes/output/actions/popup_action.php
new file mode 100644
index 0000000000000..9dcd3291f0a98
--- /dev/null
+++ b/lib/classes/output/actions/popup_action.php
@@ -0,0 +1,120 @@
+.
+
+namespace core\output\actions;
+
+use core\exception\coding_exception;
+use moodle_url;
+
+/**
+ * Component action for a popup window.
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class popup_action extends component_action {
+ /**
+ * @var string The JS function to call for the popup
+ */
+ public $jsfunction = 'openpopup';
+
+ /**
+ * @var array An array of parameters that will be passed to the openpopup JS function
+ */
+ public $params = [
+ 'height' => 400,
+ 'width' => 500,
+ 'top' => 0,
+ 'left' => 0,
+ 'menubar' => false,
+ 'location' => false,
+ 'scrollbars' => true,
+ 'resizable' => true,
+ 'toolbar' => true,
+ 'status' => true,
+ 'directories' => false,
+ 'fullscreen' => false,
+ 'dependent' => true,
+ ];
+
+ /**
+ * Constructor
+ *
+ * @param string $event DOM event
+ * @param moodle_url|string $url A moodle_url object, required if no jsfunction is given
+ * @param string $name The JS function to call for the popup (default 'popup')
+ * @param array $params An array of popup parameters
+ */
+ public function __construct($event, $url, $name = 'popup', $params = []) {
+ global $CFG;
+
+ $url = new moodle_url($url);
+
+ if ($name) {
+ $checkname = $name;
+ if (($checkname = preg_replace("/\s/", '_', $checkname)) != $name) {
+ throw new coding_exception(
+ "The {$name} of a popup window shouldn't contain spaces - string modified. {$name} changed to {$checkname}",
+ );
+ $name = $checkname;
+ }
+ } else {
+ $name = 'popup';
+ }
+
+ foreach ($this->params as $var => $val) {
+ if (array_key_exists($var, $params)) {
+ $this->params[$var] = $params[$var];
+ }
+ }
+
+ $attributes = ['url' => $url->out(false), 'name' => $name, 'options' => $this->get_js_options($params)];
+ if (!empty($params['fullscreen'])) {
+ $attributes['fullscreen'] = 1;
+ }
+ parent::__construct($event, $this->jsfunction, $attributes);
+ }
+
+ /**
+ * Returns a string of concatenated option->value pairs used by JS to call the popup window,
+ * based on this object's variables
+ *
+ * @return string String of option->value pairs for JS popup function.
+ */
+ public function get_js_options() {
+ $jsoptions = '';
+
+ foreach ($this->params as $var => $val) {
+ if (is_string($val) || is_int($val)) {
+ $jsoptions .= "$var=$val,";
+ } else if (is_bool($val)) {
+ $jsoptions .= ($val) ? "$var," : "$var=0,";
+ }
+ }
+
+ $jsoptions = substr($jsoptions, 0, strlen($jsoptions) - 1);
+
+ return $jsoptions;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(popup_action::class, \popup_action::class);
diff --git a/lib/classes/output/activity_header.php b/lib/classes/output/activity_header.php
index b2fa9522db1ef..01bfd47093192 100644
--- a/lib/classes/output/activity_header.php
+++ b/lib/classes/output/activity_header.php
@@ -17,8 +17,6 @@
namespace core\output;
use moodle_page;
-use renderer_base;
-use url_select;
/**
* Data structure representing standard components displayed on the activity header.
@@ -31,7 +29,7 @@
* @package core
* @category output
*/
-class activity_header implements \renderable, \templatable {
+class activity_header implements renderable, templatable {
/** @var moodle_page $page The current page we are looking at */
protected $page;
/** @var string $title The title to be displayed in the header. Defaults to activityrecord name. */
@@ -66,8 +64,10 @@ public function __construct(moodle_page $page, \stdClass $user) {
$this->title = format_string($page->activityrecord->name);
}
- if (empty($layoutoptions['nodescription']) && !empty($page->activityrecord->intro) &&
- trim($page->activityrecord->intro)) {
+ if (
+ empty($layoutoptions['nodescription']) && !empty($page->activityrecord->intro) &&
+ trim($page->activityrecord->intro)
+ ) {
$this->description = format_module_intro($this->page->activityname, $page->activityrecord, $page->cm->id);
}
}
diff --git a/lib/classes/output/checkbox_toggleall.php b/lib/classes/output/checkbox_toggleall.php
index 5a900b89101a0..3484de9101587 100644
--- a/lib/classes/output/checkbox_toggleall.php
+++ b/lib/classes/output/checkbox_toggleall.php
@@ -23,12 +23,8 @@
*/
namespace core\output;
-defined('MOODLE_INTERNAL') || die();
-use renderable;
-use renderer_base;
use stdClass;
-use templatable;
/**
* The checkbox-toggleall renderable class.
@@ -38,7 +34,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class checkbox_toggleall implements renderable, templatable {
-
/** @var string The name of the group of checkboxes to be toggled. */
protected $togglegroup;
diff --git a/lib/classes/output/choicelist.php b/lib/classes/output/choicelist.php
index e01d949badb5e..65a47919a541c 100644
--- a/lib/classes/output/choicelist.php
+++ b/lib/classes/output/choicelist.php
@@ -16,10 +16,6 @@
namespace core\output;
-use renderable;
-use renderer_base;
-use core\output\named_templatable;
-
/**
* A generic user choice output class.
*
@@ -30,8 +26,7 @@
* @copyright 2023 Ferran Recio
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class choicelist implements renderable, named_templatable {
-
+class choicelist implements named_templatable, renderable {
/** @var object[] The user choices. */
protected $options = [];
@@ -102,13 +97,13 @@ public function count_options(): int {
* @return \stdClass[]
*/
public function get_selectable_options(): array {
- $selectableOptions = [];
+ $selectableoptions = [];
foreach ($this->options as $option) {
if ($option['value'] !== $this->selected && !$option['disabled']) {
- $selectableOptions[] = (object) $option;
+ $selectableoptions[] = (object) $option;
}
}
- return $selectableOptions;
+ return $selectableoptions;
}
/**
diff --git a/lib/classes/output/chooser.php b/lib/classes/output/chooser.php
index d63831fe4d004..0f7c86df65aa4 100644
--- a/lib/classes/output/chooser.php
+++ b/lib/classes/output/chooser.php
@@ -23,14 +23,10 @@
*/
namespace core\output;
-defined('MOODLE_INTERNAL') || die();
use lang_string;
use moodle_url;
-use renderer_base;
-use renderable;
use stdClass;
-use templatable;
/**
* The chooser renderable class.
@@ -40,7 +36,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class chooser implements renderable, templatable {
-
/** @var moodle_url The form action URL. */
public $actionurl;
/** @var lang_string The instructions to display. */
@@ -85,7 +80,7 @@ public function add_param($name, $value, $id = null) {
$this->params[] = [
'name' => $name,
'value' => $value,
- 'id' => $id
+ 'id' => $id,
];
}
@@ -124,11 +119,10 @@ public function export_for_template(renderer_base $output) {
$data->sesskey = sesskey();
$data->title = (string) $this->title;
- $data->sections = array_map(function($section) use ($output) {
+ $data->sections = array_map(function ($section) use ($output) {
return $section->export_for_template($output);
}, $this->sections);
return $data;
}
-
}
diff --git a/lib/classes/output/chooser_item.php b/lib/classes/output/chooser_item.php
index d6392c52b96af..c90d6f115b881 100644
--- a/lib/classes/output/chooser_item.php
+++ b/lib/classes/output/chooser_item.php
@@ -24,13 +24,9 @@
namespace core\output;
-use coding_exception;
-use context;
-use pix_icon;
-use renderer_base;
-use renderable;
+use core\exception\coding_exception;
+use core\context;
use stdClass;
-use templatable;
/**
* The chooser_item renderable class.
@@ -40,7 +36,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class chooser_item implements renderable, templatable {
-
/** @var string An identifier for the item. */
public $id;
/** @var string The label of this item. */
@@ -93,11 +88,17 @@ public function export_for_template(renderer_base $output) {
$data->description = '';
if (!empty($this->description)) {
- list($data->description) = \core_external\util::format_text((string) $this->description, FORMAT_MARKDOWN,
- $this->context->id, null, null, null, $options);
+ [$data->description] = \core_external\util::format_text(
+ (string) $this->description,
+ FORMAT_MARKDOWN,
+ $this->context->id,
+ null,
+ null,
+ null,
+ $options
+ );
}
return $data;
}
-
}
diff --git a/lib/classes/output/chooser_section.php b/lib/classes/output/chooser_section.php
index ec2f270c33fe4..b4e85d245812b 100644
--- a/lib/classes/output/chooser_section.php
+++ b/lib/classes/output/chooser_section.php
@@ -23,13 +23,9 @@
*/
namespace core\output;
-defined('MOODLE_INTERNAL') || die();
use lang_string;
-use renderer_base;
-use renderable;
use stdClass;
-use templatable;
/**
* The chooser_section renderable class.
@@ -39,7 +35,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class chooser_section implements renderable, templatable {
-
/** @var string $id An identifier for the section. */
public $id;
/** @var lang_string $label The label of the section. */
@@ -70,10 +65,9 @@ public function export_for_template(renderer_base $output) {
$data = new stdClass();
$data->id = $this->id;
$data->label = (string) $this->label;
- $data->items = array_map(function($item) use ($output) {
+ $data->items = array_map(function ($item) use ($output) {
return $item->export_for_template($output);
}, array_values($this->items));
return $data;
}
-
}
diff --git a/lib/classes/output/comboboxsearch.php b/lib/classes/output/comboboxsearch.php
index 0f9a18025339a..f0120c8874a89 100644
--- a/lib/classes/output/comboboxsearch.php
+++ b/lib/classes/output/comboboxsearch.php
@@ -16,20 +16,16 @@
namespace core\output;
-use moodle_exception;
-use renderable;
-use renderer_base;
-use templatable;
+use core\exception\moodle_exception;
/**
* Renderable class for the comboboxsearch.
*
- * @package core_output
+ * @package core
* @copyright 2022 Mathew May
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class comboboxsearch implements renderable, templatable {
-
/** @var bool $renderlater Should the dropdown render straightaway? We sometimes need to output the component without all of the
* data and leave the rendering of any defaults and actual data to the caller. We will give you a basic placeholder that can
* then be easily replaced.*/
@@ -53,7 +49,7 @@ class comboboxsearch implements renderable, templatable {
/** @var null|string $buttonheader If the button item in the tertiary nav needs an extra top header for context. */
protected $buttonheader;
- /** @var boolean $usesbutton Whether to provide a A11y button. */
+ /** @var bool $usesbutton Whether to provide a A11y button. */
protected $usesbutton;
/** @var null|string $label The label of the combobox. */
@@ -99,15 +95,16 @@ public function __construct(
throw new moodle_exception(
'incorrectdropdownvars',
'core',
- '', null,
+ '',
+ null,
'Dropdown content must be set to render later.'
);
}
if ($usebutton && !$label) {
debugging(
- 'You have requested to use the button but have not provided a label for the combobox.',
- DEBUG_DEVELOPER
+ 'You have requested to use the button but have not provided a label for the combobox.',
+ DEBUG_DEVELOPER
);
}
@@ -140,7 +137,7 @@ public function __construct(
public function export_for_template(renderer_base $output): array {
return [
'renderlater' => $this->renderlater,
- 'buttoncontent' => $this->buttoncontent ,
+ 'buttoncontent' => $this->buttoncontent,
'dropdowncontent' => $this->dropdowncontent,
'parentclasses' => $this->parentclasses,
'buttonclasses' => $this->buttonclasses,
diff --git a/lib/classes/output/context_header.php b/lib/classes/output/context_header.php
new file mode 100644
index 0000000000000..b3030ced3afcd
--- /dev/null
+++ b/lib/classes/output/context_header.php
@@ -0,0 +1,151 @@
+.
+
+namespace core\output;
+
+/**
+ * Renderable for the main page header.
+ *
+ * @package core
+ * @category output
+ * @since 2.9
+ * @copyright 2015 Adrian Greeve
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class context_header implements renderable, templatable {
+ /** @var string $heading Main heading */
+ public $heading;
+
+ /** @var int $headinglevel Main heading 'h' tag level */
+ public $headinglevel;
+
+ /** @var string|null $imagedata HTML code for the picture in the page header */
+ public $imagedata;
+
+ /**
+ * @var array $additionalbuttons Additional buttons for the header e.g. Messaging button for the user header.
+ * array elements - title => alternate text for the image, or if no image is available the button text.
+ * url => Link for the button to head to. Should be a moodle_url.
+ * image => location to the image, or name of the image in /pix/t/{image name}.
+ * linkattributes => additional attributes for the element.
+ * page => page object. Don't include if the image is an external image.
+ */
+ public $additionalbuttons;
+
+ /** @var string $prefix A string that is before the title */
+ public $prefix;
+
+ /**
+ * Constructor.
+ *
+ * @param string $heading Main heading data.
+ * @param int $headinglevel Main heading 'h' tag level.
+ * @param string|null $imagedata HTML code for the picture in the page header.
+ * @param string $additionalbuttons Buttons for the header e.g. Messaging button for the user header.
+ * @param string $prefix Text that precedes the heading.
+ */
+ public function __construct($heading = null, $headinglevel = 1, $imagedata = null, $additionalbuttons = null, $prefix = null) {
+ $this->heading = $heading;
+ $this->headinglevel = $headinglevel;
+ $this->imagedata = $imagedata;
+ $this->additionalbuttons = $additionalbuttons;
+ // If we have buttons then format them.
+ if (isset($this->additionalbuttons)) {
+ $this->format_button_images();
+ }
+ $this->prefix = $prefix;
+ }
+
+ /**
+ * Adds an array element for a formatted image.
+ */
+ protected function format_button_images() {
+
+ foreach ($this->additionalbuttons as $buttontype => $button) {
+ $page = $button['page'];
+ // If no image is provided then just use the title.
+ if (!isset($button['image'])) {
+ $this->additionalbuttons[$buttontype]['formattedimage'] = $button['title'];
+ } else {
+ // Check to see if this is an internal Moodle icon.
+ $internalimage = $page->theme->resolve_image_location('t/' . $button['image'], 'moodle');
+ if ($internalimage) {
+ $this->additionalbuttons[$buttontype]['formattedimage'] = 't/' . $button['image'];
+ } else {
+ // Treat as an external image.
+ $this->additionalbuttons[$buttontype]['formattedimage'] = $button['image'];
+ }
+ }
+
+ if (isset($button['linkattributes']['class'])) {
+ $class = $button['linkattributes']['class'] . ' btn';
+ } else {
+ $class = 'btn';
+ }
+ // Add the bootstrap 'btn' class for formatting.
+ $this->additionalbuttons[$buttontype]['linkattributes'] = array_merge(
+ $button['linkattributes'],
+ ['class' => $class]
+ );
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output Renderer.
+ * @return array
+ */
+ public function export_for_template(renderer_base $output): array {
+ // Heading.
+ $headingtext = isset($this->heading) ? $this->heading : $output->get_page()->heading;
+ $heading = $output->heading($headingtext, $this->headinglevel, "h2 mb-0");
+
+ // Buttons.
+ if (isset($this->additionalbuttons)) {
+ $additionalbuttons = [];
+ foreach ($this->additionalbuttons as $button) {
+ if (!isset($button->page)) {
+ // Include js for messaging.
+ if ($button['buttontype'] === 'togglecontact') {
+ \core_message\helper::togglecontact_requirejs();
+ }
+ if ($button['buttontype'] === 'message') {
+ \core_message\helper::messageuser_requirejs();
+ }
+ }
+ foreach ($button['linkattributes'] as $key => $value) {
+ $button['attributes'][] = ['name' => $key, 'value' => $value];
+ }
+ $additionalbuttons[] = $button;
+ }
+ }
+
+ return [
+ 'heading' => $heading,
+ 'headinglevel' => $this->headinglevel,
+ 'imagedata' => $this->imagedata,
+ 'prefix' => $this->prefix,
+ 'hasadditionalbuttons' => !empty($additionalbuttons),
+ 'additionalbuttons' => $additionalbuttons ?? [],
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(context_header::class, \context_header::class);
diff --git a/lib/classes/output/core_renderer.php b/lib/classes/output/core_renderer.php
new file mode 100644
index 0000000000000..27d63344b7bb7
--- /dev/null
+++ b/lib/classes/output/core_renderer.php
@@ -0,0 +1,4893 @@
+.
+
+namespace core\output;
+
+use breadcrumb_navigation_node;
+use cm_info;
+use core_block\output\block_contents;
+use core_block\output\block_move_target;
+use core_completion\cm_completion_details;
+use core\context;
+use core_course\output\activity_information;
+use core_tag\output\taglist;
+use core_text;
+use core_useragent;
+use core\check\check as check_check;
+use core\check\result as check_result;
+use core\context\system as context_system;
+use core\context\course as context_course;
+use core\di;
+use core\exception\coding_exception;
+use core\hook\manager as hook_manager;
+use core\hook\output\after_standard_main_region_html_generation;
+use core\hook\output\before_footer_html_generation;
+use core\hook\output\before_html_attributes;
+use core\hook\output\before_http_headers;
+use core\hook\output\before_standard_footer_html_generation;
+use core\hook\output\before_standard_top_of_body_html_generation;
+use core\output\action_menu\link as action_menu_link;
+use core\output\action_menu\link_primary as action_menu_link_primary;
+use core\output\actions\component_action;
+use core\output\actions\popup_action;
+use core\output\action_menu\filler as action_menu_filler;
+use core\plugin_manager;
+use core\output\action_menu\link_secondary as action_menu_link_secondary;
+use moodleform;
+use moodle_page;
+use moodle_url;
+use navigation_node;
+use rating;
+use rating_manager;
+use stdClass;
+use HTML_QuickForm_element;
+
+/**
+ * The standard implementation of the core_renderer interface.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class core_renderer extends renderer_base {
+ /**
+ * Do NOT use, please use main_content() ?>
+ * in layout files instead.
+ * @deprecated
+ * @var string used in {@see core_renderer::header()}.
+ */
+ const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
+
+ /**
+ * @var string Used to pass information from {@see core_renderer::doctype()} to
+ * @see core_renderer::standard_head_html()
+ */
+ protected $contenttype;
+
+ /**
+ * @var string Used by {@see core_renderer::redirect_message()} method to communicate
+ * with {@see core_renderer::header()}.
+ */
+ protected $metarefreshtag = '';
+
+ /**
+ * @var string Unique token for the closing HTML
+ */
+ protected $unique_end_html_token; // phpcs:ignore moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+ /**
+ * @var string Unique token for performance information
+ */
+ protected $unique_performance_info_token; // phpcs:ignore moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+ /**
+ * @var string Unique token for the main content.
+ */
+ protected $unique_main_content_token; // phpcs:ignore moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+ /** @var custom_menu_item language The language menu if created */
+ protected $language = null;
+
+ /** @var string The current selector for an element being streamed into */
+ protected $currentselector = '';
+
+ /** @var string The current element tag which is being streamed into */
+ protected $currentelement = '';
+
+ /**
+ * Constructor
+ *
+ * @param moodle_page $page the page we are doing output for.
+ * @param string $target one of rendering target constants
+ */
+ public function __construct(moodle_page $page, $target) {
+ $this->opencontainers = $page->opencontainers;
+ $this->page = $page;
+ $this->target = $target;
+
+ $this->unique_end_html_token = '%%ENDHTML-' . sesskey() . '%%';
+ $this->unique_performance_info_token = '%%PERFORMANCEINFO-' . sesskey() . '%%';
+ $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - ' . sesskey() . ']';
+ }
+
+ /**
+ * Get the DOCTYPE declaration that should be used with this page. Designed to
+ * be called in theme layout.php files.
+ *
+ * @return string the DOCTYPE declaration that should be used.
+ */
+ public function doctype() {
+ if ($this->page->theme->doctype === 'html5') {
+ $this->contenttype = 'text/html; charset=utf-8';
+ return "\n";
+ } else if ($this->page->theme->doctype === 'xhtml5') {
+ $this->contenttype = 'application/xhtml+xml; charset=utf-8';
+ return "\n";
+ } else {
+ // legacy xhtml 1.0
+ $this->contenttype = 'text/html; charset=utf-8';
+ return ('' . "\n");
+ }
+ }
+
+ /**
+ * The attributes that should be added to the tag. Designed to
+ * be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function htmlattributes() {
+ $return = get_html_lang(true);
+
+ $hook = new before_html_attributes($this);
+
+ if ($this->page->theme->doctype !== 'html5') {
+ $hook->add_attribute('xmlns', 'http://www.w3.org/1999/xhtml');
+ }
+
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+
+ foreach ($hook->get_attributes() as $key => $val) {
+ $val = s($val);
+ $return .= " $key=\"$val\"";
+ }
+
+ return $return;
+ }
+
+ /**
+ * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
+ * that should be included in the tag. Designed to be called in theme
+ * layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_head_html() {
+ global $CFG, $SESSION, $SITE;
+
+ // Before we output any content, we need to ensure that certain
+ // page components are set up.
+
+ // Blocks must be set up early as they may require javascript which
+ // has to be included in the page header before output is created.
+ foreach ($this->page->blocks->get_regions() as $region) {
+ $this->page->blocks->ensure_content_created($region, $this);
+ }
+
+ // Give plugins an opportunity to add any head elements. The callback
+ // must always return a string containing valid html head content.
+
+ $hook = new \core\hook\output\before_standard_head_html_generation($this);
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+
+ // Allow a url_rewrite plugin to setup any dynamic head content.
+ if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
+ $class = $CFG->urlrewriteclass;
+ $hook->add_html($class::html_head_setup());
+ }
+
+ $hook->add_html('' . "\n");
+ $hook->add_html('' . "\n");
+ // This is only set by the {@see redirect()} method
+ $hook->add_html($this->metarefreshtag);
+
+ // Check if a periodic refresh delay has been set and make sure we arn't
+ // already meta refreshing
+ if ($this->metarefreshtag == '' && $this->page->periodicrefreshdelay !== null) {
+ $hook->add_html(
+ html_writer::empty_tag('meta', [
+ 'http-equiv' => 'refresh',
+ 'content' => $this->page->periodicrefreshdelay . ';url=' . $this->page->url->out(),
+ ]),
+ );
+ }
+
+ $output = $hook->get_output();
+
+ // Set up help link popups for all links with the helptooltip class
+ $this->page->requires->js_init_call('M.util.help_popups.setup');
+
+ $focus = $this->page->focuscontrol;
+ if (!empty($focus)) {
+ if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
+ // This is a horrifically bad way to handle focus but it is passed in
+ // through messy formslib::moodleform
+ $this->page->requires->js_function_call('old_onload_focus', [$matches[1], $matches[2]]);
+ } else if (strpos($focus, '.') !== false) {
+ // Old style of focus, bad way to do it
+ debugging('This code is using the old style focus event, Please update this code to focus on an element id or the moodleform focus method.', DEBUG_DEVELOPER);
+ $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
+ } else {
+ // Focus element with given id
+ $this->page->requires->js_function_call('focuscontrol', [$focus]);
+ }
+ }
+
+ // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
+ // any other custom CSS can not be overridden via themes and is highly discouraged
+ $urls = $this->page->theme->css_urls($this->page);
+ foreach ($urls as $url) {
+ $this->page->requires->css_theme($url);
+ }
+
+ // Get the theme javascript head and footer
+ if ($jsurl = $this->page->theme->javascript_url(true)) {
+ $this->page->requires->js($jsurl, true);
+ }
+ if ($jsurl = $this->page->theme->javascript_url(false)) {
+ $this->page->requires->js($jsurl);
+ }
+
+ // Get any HTML from the page_requirements_manager.
+ $output .= $this->page->requires->get_head_code($this->page, $this);
+
+ // List alternate versions.
+ foreach ($this->page->alternateversions as $type => $alt) {
+ $output .= html_writer::empty_tag('link', [
+ 'rel' => 'alternate',
+ 'type' => $type,
+ 'title' => $alt->title,
+ 'href' => $alt->url,
+ ]);
+ }
+
+ // Add noindex tag if relevant page and setting applied.
+ $allowindexing = isset($CFG->allowindexing) ? $CFG->allowindexing : 0;
+ $loginpages = ['login-index', 'login-signup'];
+ if ($allowindexing == 2 || ($allowindexing == 0 && in_array($this->page->pagetype, $loginpages))) {
+ if (!isset($CFG->additionalhtmlhead)) {
+ $CFG->additionalhtmlhead = '';
+ }
+ $CFG->additionalhtmlhead .= '';
+ }
+
+ if (!empty($CFG->additionalhtmlhead)) {
+ $output .= "\n" . $CFG->additionalhtmlhead;
+ }
+
+ if ($this->page->pagelayout == 'frontpage') {
+ $summary = s(strip_tags(format_text($SITE->summary, FORMAT_HTML)));
+ if (!empty($summary)) {
+ $output .= "\n";
+ }
+ }
+
+ return $output;
+ }
+
+ /**
+ * The standard tags (typically skip links) that should be output just inside
+ * the start of the tag. Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_top_of_body_html() {
+ global $CFG;
+ $output = $this->page->requires->get_top_of_body_code($this);
+ if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmltopofbody)) {
+ $output .= "\n" . $CFG->additionalhtmltopofbody;
+ }
+
+ // Allow components to add content to the top of the body.
+ $hook = new before_standard_top_of_body_html_generation($this, $output);
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+ $output = $hook->get_output();
+
+ $output .= $this->maintenance_warning();
+
+ return $output;
+ }
+
+ /**
+ * Scheduled maintenance warning message.
+ *
+ * Note: This is a nasty hack to display maintenance notice, this should be moved
+ * to some general notification area once we have it.
+ *
+ * @return string
+ */
+ public function maintenance_warning() {
+ global $CFG;
+
+ $output = '';
+ if (isset($CFG->maintenance_later) and $CFG->maintenance_later > time()) {
+ $timeleft = $CFG->maintenance_later - time();
+ // If timeleft less than 30 sec, set the class on block to error to highlight.
+ $errorclass = ($timeleft < 30) ? 'alert-error alert-danger' : 'alert-warning';
+ $output .= $this->box_start($errorclass . ' moodle-has-zindex maintenancewarning m-3 alert');
+ $a = new stdClass();
+ $a->hour = (int)($timeleft / 3600);
+ $a->min = (int)(floor($timeleft / 60) % 60);
+ $a->sec = (int)($timeleft % 60);
+ if ($a->hour > 0) {
+ $output .= get_string('maintenancemodeisscheduledlong', 'admin', $a);
+ } else {
+ $output .= get_string('maintenancemodeisscheduled', 'admin', $a);
+ }
+
+ $output .= $this->box_end();
+ $this->page->requires->yui_module(
+ 'moodle-core-maintenancemodetimer',
+ 'M.core.maintenancemodetimer',
+ [['timeleftinsec' => $timeleft]]
+ );
+ $this->page->requires->strings_for_js(
+ ['maintenancemodeisscheduled', 'maintenancemodeisscheduledlong', 'sitemaintenance'],
+ 'admin'
+ );
+ }
+ return $output;
+ }
+
+ /**
+ * content that should be output in the footer area
+ * of the page. Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_footer_html() {
+ if (during_initial_install()) {
+ // Debugging info can not work before install is finished,
+ // in any case we do not want any links during installation!
+ return '';
+ }
+
+ $hook = new before_standard_footer_html_generation($this);
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+ $output = $hook->get_output();
+
+ if ($this->page->devicetypeinuse == 'legacy') {
+ // The legacy theme is in use print the notification
+ $output .= html_writer::tag('div', get_string('legacythemeinuse'), ['class' => 'legacythemeinuse']);
+ }
+
+ // Get links to switch device types (only shown for users not on a default device)
+ $output .= $this->theme_switch_links();
+
+ return $output;
+ }
+
+ /**
+ * Performance information and validation links for debugging.
+ *
+ * @return string HTML fragment.
+ */
+ public function debug_footer_html() {
+ global $CFG, $SCRIPT;
+ $output = '';
+
+ if (during_initial_install()) {
+ // Debugging info can not work before install is finished.
+ return $output;
+ }
+
+ // This function is normally called from a layout.php file
+ // but some of the content won't be known until later, so we return a placeholder
+ // for now. This will be replaced with the real content in the footer.
+ $output .= $this->unique_performance_info_token;
+
+ if (!empty($CFG->debugpageinfo)) {
+ $output .= '' . get_string(
+ 'pageinfodebugsummary',
+ 'core_admin',
+ $this->page->debug_summary()
+ ) . '';
+ }
+ if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) { // Only in developer mode
+ // Add link to profiling report if necessary
+ if (function_exists('profiling_is_running') && profiling_is_running()) {
+ $txt = get_string('profiledscript', 'admin');
+ $title = get_string('profiledscriptview', 'admin');
+ $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
+ $link = '' . $txt . '';
+ $output .= '';
+ }
+ $purgeurl = new moodle_url('/admin/purgecaches.php', [
+ 'confirm' => 1,
+ 'sesskey' => sesskey(),
+ 'returnurl' => $this->page->url->out_as_local_url(false),
+ ]);
+ $output .= '' .
+ html_writer::link($purgeurl, get_string('purgecaches', 'admin')) . '';
+
+ // Reactive module debug panel.
+ $output .= $this->render_from_template('core/local/reactive/debugpanel', []);
+ }
+ if (!empty($CFG->debugvalidators)) {
+ $siteurl = qualified_me();
+ $nuurl = new moodle_url('https://validator.w3.org/nu/', ['doc' => $siteurl, 'showsource' => 'yes']);
+ $waveurl = new moodle_url('https://wave.webaim.org/report#/' . urlencode($siteurl));
+ $validatorlinks = [
+ html_writer::link($nuurl, get_string('validatehtml')),
+ html_writer::link($waveurl, get_string('wcagcheck')),
+ ];
+ $validatorlinkslist = html_writer::alist($validatorlinks, ['class' => 'list-unstyled ml-1']);
+ $output .= html_writer::div($validatorlinkslist, 'validators');
+ }
+ return $output;
+ }
+
+ /**
+ * Returns standard main content placeholder.
+ * Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function main_content() {
+ // This is here because it is the only place we can inject the "main" role over the entire main content area
+ // without requiring all theme's to manually do it, and without creating yet another thing people need to
+ // remember in the theme.
+ // This is an unfortunate hack. DO NO EVER add anything more here.
+ // DO NOT add classes.
+ // DO NOT add an id.
+ return '' . $this->unique_main_content_token . '';
+ }
+
+ /**
+ * Returns information about an activity.
+ *
+ * @deprecated since Moodle 4.3 MDL-78744
+ * @todo MDL-78926 This method will be deleted in Moodle 4.7
+ * @param cm_info $cminfo The course module information.
+ * @param cm_completion_details $completiondetails The completion details for this activity module.
+ * @param array $activitydates The dates for this activity module.
+ * @return string the activity information HTML.
+ * @throws coding_exception
+ */
+ public function activity_information(cm_info $cminfo, cm_completion_details $completiondetails, array $activitydates): string {
+ debugging('activity_information method is deprecated.', DEBUG_DEVELOPER);
+ if (!$completiondetails->has_completion() && empty($activitydates)) {
+ // No need to render the activity information when there's no completion info and activity dates to show.
+ return '';
+ }
+ $activityinfo = new activity_information($cminfo, $completiondetails, $activitydates);
+ $renderer = $this->page->get_renderer('core', 'course');
+ return $renderer->render($activityinfo);
+ }
+
+ /**
+ * Returns standard navigation between activities in a course.
+ *
+ * @return string the navigation HTML.
+ */
+ public function activity_navigation() {
+ // First we should check if we want to add navigation.
+ $context = $this->page->context;
+ if (
+ ($this->page->pagelayout !== 'incourse' && $this->page->pagelayout !== 'frametop')
+ || $context->contextlevel != CONTEXT_MODULE
+ ) {
+ return '';
+ }
+
+ // If the activity is in stealth mode, show no links.
+ if ($this->page->cm->is_stealth()) {
+ return '';
+ }
+
+ $course = $this->page->cm->get_course();
+ $courseformat = course_get_format($course);
+
+ // If the theme implements course index and the current course format uses course index and the current
+ // page layout is not 'frametop' (this layout does not support course index), show no links.
+ if (
+ $this->page->theme->usescourseindex && $courseformat->uses_course_index() &&
+ $this->page->pagelayout !== 'frametop'
+ ) {
+ return '';
+ }
+
+ // Get a list of all the activities in the course.
+ $modules = get_fast_modinfo($course->id)->get_cms();
+
+ // Put the modules into an array in order by the position they are shown in the course.
+ $mods = [];
+ $activitylist = [];
+ foreach ($modules as $module) {
+ // Only add activities the user can access, aren't in stealth mode and have a url (eg. mod_label does not).
+ if (!$module->uservisible || $module->is_stealth() || empty($module->url)) {
+ continue;
+ }
+ $mods[$module->id] = $module;
+
+ // No need to add the current module to the list for the activity dropdown menu.
+ if ($module->id == $this->page->cm->id) {
+ continue;
+ }
+ // Module name.
+ $modname = $module->get_formatted_name();
+ // Display the hidden text if necessary.
+ if (!$module->visible) {
+ $modname .= ' ' . get_string('hiddenwithbrackets');
+ }
+ // Module URL.
+ $linkurl = new moodle_url($module->url, ['forceview' => 1]);
+ // Add module URL (as key) and name (as value) to the activity list array.
+ $activitylist[$linkurl->out(false)] = $modname;
+ }
+
+ $nummods = count($mods);
+
+ // If there is only one mod then do nothing.
+ if ($nummods == 1) {
+ return '';
+ }
+
+ // Get an array of just the course module ids used to get the cmid value based on their position in the course.
+ $modids = array_keys($mods);
+
+ // Get the position in the array of the course module we are viewing.
+ $position = array_search($this->page->cm->id, $modids);
+
+ $prevmod = null;
+ $nextmod = null;
+
+ // Check if we have a previous mod to show.
+ if ($position > 0) {
+ $prevmod = $mods[$modids[$position - 1]];
+ }
+
+ // Check if we have a next mod to show.
+ if ($position < ($nummods - 1)) {
+ $nextmod = $mods[$modids[$position + 1]];
+ }
+
+ $activitynav = new \core_course\output\activity_navigation($prevmod, $nextmod, $activitylist);
+ $renderer = $this->page->get_renderer('core', 'course');
+ return $renderer->render($activitynav);
+ }
+
+ /**
+ * The standard tags (typically script tags that are not needed earlier) that
+ * should be output after everything else. Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_end_of_body_html() {
+ global $CFG;
+
+ // This function is normally called from a layout.php file in {@see core_renderer::header()}
+ // but some of the content won't be known until later, so we return a placeholder
+ // for now. This will be replaced with the real content in {@see core_renderer::footer()}.
+ $output = '';
+ if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlfooter)) {
+ $output .= "\n" . $CFG->additionalhtmlfooter;
+ }
+ $output .= $this->unique_end_html_token;
+ return $output;
+ }
+
+ /**
+ * The standard HTML that should be output just before the
+
+EOD;
+ }
+ $html .= '';
+ return $html;
+ }
+
+ /**
+ * @deprecated since Moodle 3.2
+ */
+ public function update_module_button() {
+ throw new coding_exception('core_renderer::update_module_button() can not be used anymore. Activity ' .
+ 'modules should not add the edit module button, the link is already available in the Administration block. ' .
+ 'Themes can choose to display the link in the buttons row consistently for all module types.');
+ }
+
+ /**
+ * Returns HTML to display a "Turn editing on/off" button in a form.
+ *
+ * @param moodle_url $url The URL + params to send through when clicking the button
+ * @param string $method
+ * @return ?string HTML the button
+ */
+ public function edit_button(moodle_url $url, string $method = 'post') {
+
+ if ($this->page->theme->haseditswitch == true) {
+ return;
+ }
+ $url->param('sesskey', sesskey());
+ if ($this->page->user_is_editing()) {
+ $url->param('edit', 'off');
+ $editstring = get_string('turneditingoff');
+ } else {
+ $url->param('edit', 'on');
+ $editstring = get_string('turneditingon');
+ }
+
+ return $this->single_button($url, $editstring, $method);
+ }
+
+ /**
+ * Create a navbar switch for toggling editing mode.
+ *
+ * @return ?string Html containing the edit switch
+ */
+ public function edit_switch() {
+ if ($this->page->user_allowed_editing()) {
+ $temp = (object) [
+ 'legacyseturl' => (new moodle_url('/editmode.php'))->out(false),
+ 'pagecontextid' => $this->page->context->id,
+ 'pageurl' => $this->page->url,
+ 'sesskey' => sesskey(),
+ ];
+ if ($this->page->user_is_editing()) {
+ $temp->checked = true;
+ }
+ return $this->render_from_template('core/editswitch', $temp);
+ }
+ }
+
+ /**
+ * Returns HTML to display a simple button to close a window
+ *
+ * @param string $text The lang string for the button's label (already output from get_string())
+ * @return string html fragment
+ */
+ public function close_window_button($text = '') {
+ if (empty($text)) {
+ $text = get_string('closewindow');
+ }
+ $button = new single_button(new moodle_url('#'), $text, 'get');
+ $button->add_action(new component_action('click', 'close_window'));
+
+ return $this->container($this->render($button), 'closewindow');
+ }
+
+ /**
+ * Output an error message. By default wraps the error message in .
+ * If the error message is blank, nothing is output.
+ *
+ * @param string $message the error message.
+ * @return string the HTML to output.
+ */
+ public function error_text($message) {
+ if (empty($message)) {
+ return '';
+ }
+ $message = $this->pix_icon('i/warning', get_string('error'), '', ['class' => 'icon', 'title' => '']) . $message;
+ return html_writer::tag('span', $message, ['class' => 'error']);
+ }
+
+ /**
+ * Do not call this function directly.
+ *
+ * To terminate the current script with a fatal error, throw an exception.
+ * Doing this will then call this function to display the error, before terminating the execution.
+ *
+ * @param string $message The message to output
+ * @param string $moreinfourl URL where more info can be found about the error
+ * @param string $link Link for the Continue button
+ * @param array $backtrace The execution backtrace
+ * @param null|string $debuginfo Debugging information
+ * @param string $errorcode
+ * @return string the HTML to output.
+ */
+ public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
+ global $CFG;
+
+ $output = '';
+ $obbuffer = '';
+
+ if ($this->has_started()) {
+ // we can not always recover properly here, we have problems with output buffering,
+ // html tables, etc.
+ $output .= $this->opencontainers->pop_all_but_last();
+ } else {
+ // It is really bad if library code throws exception when output buffering is on,
+ // because the buffered text would be printed before our start of page.
+ // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
+ error_reporting(0); // disable notices from gzip compression, etc.
+ while (ob_get_level() > 0) {
+ $buff = ob_get_clean();
+ if ($buff === false) {
+ break;
+ }
+ $obbuffer .= $buff;
+ }
+ error_reporting($CFG->debug);
+
+ // Output not yet started.
+ $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
+ if (empty($_SERVER['HTTP_RANGE'])) {
+ @header($protocol . ' 404 Not Found');
+ } else if (core_useragent::check_safari_ios_version(602) && !empty($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) {
+ // Coax iOS 10 into sending the session cookie.
+ @header($protocol . ' 403 Forbidden');
+ } else {
+ // Must stop byteserving attempts somehow,
+ // this is weird but Chrome PDF viewer can be stopped only with 407!
+ @header($protocol . ' 407 Proxy Authentication Required');
+ }
+
+ $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
+ $this->page->set_url('/'); // no url
+ // $this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
+ $this->page->set_title(get_string('error'));
+ $this->page->set_heading($this->page->course->fullname);
+ // No need to display the activity header when encountering an error.
+ $this->page->activityheader->disable();
+ $output .= $this->header();
+ }
+
+ $message = '' .
+ '' .
+ get_string('moreinformation') . '
';
+ if (empty($CFG->rolesactive)) {
+ $message .= '';
+ // It is usually not possible to recover from errors triggered during installation, you may need to create a new database or use a different database prefix for new installation.
+ }
+ $output .= $this->box($message, 'errorbox alert alert-danger', null, ['data-rel' => 'fatalerror']);
+
+ if ($CFG->debugdeveloper) {
+ $labelsep = get_string('labelsep', 'langconfig');
+ if (!empty($debuginfo)) {
+ $debuginfo = s($debuginfo); // removes all nasty JS
+ $debuginfo = str_replace("\n", '
', $debuginfo); // keep newlines
+ $label = get_string('debuginfo', 'debug') . $labelsep;
+ $output .= $this->notification("$label " . $debuginfo, 'notifytiny');
+ }
+ if (!empty($backtrace)) {
+ $label = get_string('stacktrace', 'debug') . $labelsep;
+ $output .= $this->notification("$label " . format_backtrace($backtrace), 'notifytiny');
+ }
+ if ($obbuffer !== '') {
+ $label = get_string('outputbuffer', 'debug') . $labelsep;
+ $output .= $this->notification("$label " . s($obbuffer), 'notifytiny');
+ }
+ }
+
+ if (empty($CFG->rolesactive)) {
+ // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
+ } else if (!empty($link)) {
+ $output .= $this->continue_button($link);
+ }
+
+ $output .= $this->footer();
+
+ // Padding to encourage IE to display our error page, rather than its own.
+ $output .= str_repeat(' ', 512);
+
+ return $output;
+ }
+
+ /**
+ * Output a notification (that is, a status message about something that has just happened).
+ *
+ * Note: \core\notification::add() may be more suitable for your usage.
+ *
+ * @param string $message The message to print out.
+ * @param ?string $type The type of notification. See constants on notification.
+ * @param bool $closebutton Whether to show a close icon to remove the notification (default true).
+ * @return string the HTML to output.
+ */
+ public function notification($message, $type = null, $closebutton = true) {
+ $typemappings = [
+ // Valid types.
+ 'success' => notification::NOTIFY_SUCCESS,
+ 'info' => notification::NOTIFY_INFO,
+ 'warning' => notification::NOTIFY_WARNING,
+ 'error' => notification::NOTIFY_ERROR,
+
+ // Legacy types mapped to current types.
+ 'notifyproblem' => notification::NOTIFY_ERROR,
+ 'notifytiny' => notification::NOTIFY_ERROR,
+ 'notifyerror' => notification::NOTIFY_ERROR,
+ 'notifysuccess' => notification::NOTIFY_SUCCESS,
+ 'notifymessage' => notification::NOTIFY_INFO,
+ 'notifyredirect' => notification::NOTIFY_INFO,
+ 'redirectmessage' => notification::NOTIFY_INFO,
+ ];
+
+ $extraclasses = [];
+
+ if ($type) {
+ if (strpos($type, ' ') === false) {
+ // No spaces in the list of classes, therefore no need to loop over and determine the class.
+ if (isset($typemappings[$type])) {
+ $type = $typemappings[$type];
+ } else {
+ // The value provided did not match a known type. It must be an extra class.
+ $extraclasses = [$type];
+ }
+ } else {
+ // Identify what type of notification this is.
+ $classarray = explode(' ', self::prepare_classes($type));
+
+ // Separate out the type of notification from the extra classes.
+ foreach ($classarray as $class) {
+ if (isset($typemappings[$class])) {
+ $type = $typemappings[$class];
+ } else {
+ $extraclasses[] = $class;
+ }
+ }
+ }
+ }
+
+ $notification = new notification($message, $type, $closebutton);
+ if (count($extraclasses)) {
+ $notification->set_extra_classes($extraclasses);
+ }
+
+ // Return the rendered template.
+ return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
+ }
+
+ /**
+ * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
+ */
+ public function notify_problem() {
+ throw new coding_exception('core_renderer::notify_problem() can not be used any more, ' .
+ 'please use \core\notification::add(), or \core\output\notification as required.');
+ }
+
+ /**
+ * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
+ */
+ public function notify_success() {
+ throw new coding_exception('core_renderer::notify_success() can not be used any more, ' .
+ 'please use \core\notification::add(), or \core\output\notification as required.');
+ }
+
+ /**
+ * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
+ */
+ public function notify_message() {
+ throw new coding_exception('core_renderer::notify_message() can not be used any more, ' .
+ 'please use \core\notification::add(), or \core\output\notification as required.');
+ }
+
+ /**
+ * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
+ */
+ public function notify_redirect() {
+ throw new coding_exception('core_renderer::notify_redirect() can not be used any more, ' .
+ 'please use \core\notification::add(), or \core\output\notification as required.');
+ }
+
+ /**
+ * Render a notification (that is, a status message about something that has
+ * just happened).
+ *
+ * @param notification $notification the notification to print out
+ * @return string the HTML to output.
+ */
+ protected function render_notification(notification $notification) {
+ return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
+ }
+
+ /**
+ * Returns HTML to display a continue button that goes to a particular URL.
+ *
+ * @param string|moodle_url $url The url the button goes to.
+ * @return string the HTML to output.
+ */
+ public function continue_button($url) {
+ if (!($url instanceof moodle_url)) {
+ $url = new moodle_url($url);
+ }
+ $button = new single_button($url, get_string('continue'), 'get', single_button::BUTTON_PRIMARY);
+ $button->class = 'continuebutton';
+
+ return $this->render($button);
+ }
+
+ /**
+ * Returns HTML to display a single paging bar to provide access to other pages (usually in a search)
+ *
+ * Theme developers: DO NOT OVERRIDE! Please override function
+ * {@see core_renderer::render_paging_bar()} instead.
+ *
+ * @param int $totalcount The total number of entries available to be paged through
+ * @param int $page The page you are currently viewing
+ * @param int $perpage The number of entries that should be shown per page
+ * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
+ * @param string $pagevar name of page parameter that holds the page number
+ * @return string the HTML to output.
+ */
+ public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
+ $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
+ return $this->render($pb);
+ }
+
+ /**
+ * Returns HTML to display the paging bar.
+ *
+ * @param paging_bar $pagingbar
+ * @return string the HTML to output.
+ */
+ protected function render_paging_bar(paging_bar $pagingbar) {
+ // Any more than 10 is not usable and causes weird wrapping of the pagination.
+ $pagingbar->maxdisplay = 10;
+ return $this->render_from_template('core/paging_bar', $pagingbar->export_for_template($this));
+ }
+
+ /**
+ * Returns HTML to display initials bar to provide access to other pages (usually in a search)
+ *
+ * @param string $current the currently selected letter.
+ * @param string $class class name to add to this initial bar.
+ * @param string $title the name to put in front of this initial bar.
+ * @param string $urlvar URL parameter name for this initial.
+ * @param string $url URL object.
+ * @param array $alpha of letters in the alphabet.
+ * @param bool $minirender Return a trimmed down view of the initials bar.
+ * @return string the HTML to output.
+ */
+ public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null, bool $minirender = false) {
+ $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha, $minirender);
+ return $this->render($ib);
+ }
+
+ /**
+ * Internal implementation of initials bar rendering.
+ *
+ * @param initials_bar $initialsbar
+ * @return string
+ */
+ protected function render_initials_bar(initials_bar $initialsbar) {
+ return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this));
+ }
+
+ /**
+ * Output the place a skip link goes to.
+ *
+ * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
+ * @return string the HTML to output.
+ */
+ public function skip_link_target($id = null) {
+ return html_writer::span('', '', ['id' => $id]);
+ }
+
+ /**
+ * Outputs a heading
+ *
+ * @param string $text The text of the heading
+ * @param int $level The level of importance of the heading. Defaulting to 2
+ * @param string $classes A space-separated list of CSS classes. Defaulting to null
+ * @param string $id An optional ID
+ * @return string the HTML to output.
+ */
+ public function heading($text, $level = 2, $classes = null, $id = null) {
+ $level = (int) $level;
+ if ($level < 1 or $level > 6) {
+ throw new coding_exception('Heading level must be an integer between 1 and 6.');
+ }
+ return html_writer::tag('h' . $level, $text, ['id' => $id, 'class' => renderer_base::prepare_classes($classes)]);
+ }
+
+ /**
+ * Outputs a box.
+ *
+ * @param string $contents The contents of the box
+ * @param string $classes A space-separated list of CSS classes
+ * @param string $id An optional ID
+ * @param array $attributes An array of other attributes to give the box.
+ * @return string the HTML to output.
+ */
+ public function box($contents, $classes = 'generalbox', $id = null, $attributes = []) {
+ return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
+ }
+
+ /**
+ * Outputs the opening section of a box.
+ *
+ * @param string $classes A space-separated list of CSS classes
+ * @param string $id An optional ID
+ * @param array $attributes An array of other attributes to give the box.
+ * @return string the HTML to output.
+ */
+ public function box_start($classes = 'generalbox', $id = null, $attributes = []) {
+ $this->opencontainers->push('box', html_writer::end_tag('div'));
+ $attributes['id'] = $id;
+ $attributes['class'] = 'box py-3 ' . renderer_base::prepare_classes($classes);
+ return html_writer::start_tag('div', $attributes);
+ }
+
+ /**
+ * Outputs the closing section of a box.
+ *
+ * @return string the HTML to output.
+ */
+ public function box_end() {
+ return $this->opencontainers->pop('box');
+ }
+
+ /**
+ * Outputs a paragraph.
+ *
+ * @param string $contents The contents of the paragraph
+ * @param string|null $classes A space-separated list of CSS classes
+ * @param string|null $id An optional ID
+ * @return string the HTML to output.
+ */
+ public function paragraph(string $contents, ?string $classes = null, ?string $id = null): string {
+ return html_writer::tag(
+ 'p',
+ $contents,
+ ['id' => $id, 'class' => renderer_base::prepare_classes($classes)]
+ );
+ }
+
+ /**
+ * Outputs a screen reader only inline text.
+ *
+ * @param string $contents The contents of the paragraph
+ * @return string the HTML to output.
+ */
+ public function sr_text(string $contents): string {
+ return html_writer::tag(
+ 'span',
+ $contents,
+ ['class' => 'sr-only']
+ ) . ' ';
+ }
+
+ /**
+ * Outputs a container.
+ *
+ * @param string $contents The contents of the box
+ * @param string $classes A space-separated list of CSS classes
+ * @param string $id An optional ID
+ * @param array $attributes Optional other attributes as array
+ * @return string the HTML to output.
+ */
+ public function container($contents, $classes = null, $id = null, $attributes = []) {
+ return $this->container_start($classes, $id, $attributes) . $contents . $this->container_end();
+ }
+
+ /**
+ * Outputs the opening section of a container.
+ *
+ * @param string $classes A space-separated list of CSS classes
+ * @param string $id An optional ID
+ * @param array $attributes Optional other attributes as array
+ * @return string the HTML to output.
+ */
+ public function container_start($classes = null, $id = null, $attributes = []) {
+ $this->opencontainers->push('container', html_writer::end_tag('div'));
+ $attributes = array_merge(['id' => $id, 'class' => renderer_base::prepare_classes($classes)], $attributes);
+ return html_writer::start_tag('div', $attributes);
+ }
+
+ /**
+ * Outputs the closing section of a container.
+ *
+ * @return string the HTML to output.
+ */
+ public function container_end() {
+ return $this->opencontainers->pop('container');
+ }
+
+ /**
+ * Make nested HTML lists out of the items
+ *
+ * The resulting list will look something like this:
+ *
+ *
+ * <
>
+ * <- >(item contents)
+ * <
+ * <- >(item contents)<
>
+ * <
>
+ * < >
+ * <
>
+ *
+ *
+ * @param array $items
+ * @param array $attrs html attributes passed to the top ofs the list
+ * @return string HTML
+ */
+ public function tree_block_contents($items, $attrs = []) {
+ // exit if empty, we don't want an empty ul element
+ if (empty($items)) {
+ return '';
+ }
+ // array of nested li elements
+ $lis = [];
+ foreach ($items as $item) {
+ // this applies to the li item which contains all child lists too
+ $content = $item->content($this);
+ $liclasses = [$item->get_css_type()];
+ if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count() == 0 && $item->nodetype == navigation_node::NODETYPE_BRANCH)) {
+ $liclasses[] = 'collapsed';
+ }
+ if ($item->isactive === true) {
+ $liclasses[] = 'current_branch';
+ }
+ $liattr = ['class' => join(' ', $liclasses)];
+ // class attribute on the div item which only contains the item content
+ $divclasses = ['tree_item'];
+ if ($item->children->count() > 0 || $item->nodetype == navigation_node::NODETYPE_BRANCH) {
+ $divclasses[] = 'branch';
+ } else {
+ $divclasses[] = 'leaf';
+ }
+ if (!empty($item->classes) && count($item->classes) > 0) {
+ $divclasses[] = join(' ', $item->classes);
+ }
+ $divattr = ['class' => join(' ', $divclasses)];
+ if (!empty($item->id)) {
+ $divattr['id'] = $item->id;
+ }
+ $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
+ if (!empty($item->preceedwithhr) && $item->preceedwithhr === true) {
+ $content = html_writer::empty_tag('hr') . $content;
+ }
+ $content = html_writer::tag('li', $content, $liattr);
+ $lis[] = $content;
+ }
+ return html_writer::tag('ul', implode("\n", $lis), $attrs);
+ }
+
+ /**
+ * Returns a search box.
+ *
+ * @param string $id The search box wrapper div id, defaults to an autogenerated one.
+ * @return string HTML with the search form hidden by default.
+ */
+ public function search_box($id = false) {
+ global $CFG;
+
+ // Accessing $CFG directly as using \core_search::is_global_search_enabled would
+ // result in an extra included file for each site, even the ones where global search
+ // is disabled.
+ if (empty($CFG->enableglobalsearch) || !has_capability('moodle/search:query', context_system::instance())) {
+ return '';
+ }
+
+ $data = [
+ 'action' => new moodle_url('/search/index.php'),
+ 'hiddenfields' => (object) ['name' => 'context', 'value' => $this->page->context->id],
+ 'inputname' => 'q',
+ 'searchstring' => get_string('search'),
+ ];
+ return $this->render_from_template('core/search_input_navbar', $data);
+ }
+
+ /**
+ * Allow plugins to provide some content to be rendered in the navbar.
+ * The plugin must define a PLUGIN_render_navbar_output function that returns
+ * the HTML they wish to add to the navbar.
+ *
+ * @return string HTML for the navbar
+ */
+ public function navbar_plugin_output() {
+ $output = '';
+
+ // Give subsystems an opportunity to inject extra html content. The callback
+ // must always return a string containing valid html.
+ foreach (\core_component::get_core_subsystems() as $name => $path) {
+ if ($path) {
+ $output .= component_callback($name, 'render_navbar_output', [$this], '');
+ }
+ }
+
+ if ($pluginsfunction = get_plugins_with_function('render_navbar_output')) {
+ foreach ($pluginsfunction as $plugintype => $plugins) {
+ foreach ($plugins as $pluginfunction) {
+ $output .= $pluginfunction($this);
+ }
+ }
+ }
+
+ return $output;
+ }
+
+ /**
+ * Construct a user menu, returning HTML that can be echoed out by a
+ * layout file.
+ *
+ * @param stdClass $user A user object, usually $USER.
+ * @param bool $withlinks true if a dropdown should be built.
+ * @return string HTML fragment.
+ */
+ public function user_menu($user = null, $withlinks = null) {
+ global $USER, $CFG;
+ require_once($CFG->dirroot . '/user/lib.php');
+
+ if (is_null($user)) {
+ $user = $USER;
+ }
+
+ // Note: this behaviour is intended to match that of core_renderer::login_info,
+ // but should not be considered to be good practice; layout options are
+ // intended to be theme-specific. Please don't copy this snippet anywhere else.
+ if (is_null($withlinks)) {
+ $withlinks = empty($this->page->layout_options['nologinlinks']);
+ }
+
+ // Add a class for when $withlinks is false.
+ $usermenuclasses = 'usermenu';
+ if (!$withlinks) {
+ $usermenuclasses .= ' withoutlinks';
+ }
+
+ $returnstr = "";
+
+ // If during initial install, return the empty return string.
+ if (during_initial_install()) {
+ return $returnstr;
+ }
+
+ $loginpage = $this->is_login_page();
+ $loginurl = get_login_url();
+
+ // Get some navigation opts.
+ $opts = user_get_user_navigation_info($user, $this->page);
+
+ if (!empty($opts->unauthenticateduser)) {
+ $returnstr = get_string($opts->unauthenticateduser['content'], 'moodle');
+ // If not logged in, show the typical not-logged-in string.
+ if (!$loginpage && (!$opts->unauthenticateduser['guest'] || $withlinks)) {
+ $returnstr .= " (" . get_string('login') . ')';
+ }
+
+ return html_writer::div(
+ html_writer::span(
+ $returnstr,
+ 'login nav-link'
+ ),
+ $usermenuclasses
+ );
+ }
+
+ $avatarclasses = "avatars";
+ $avatarcontents = html_writer::span($opts->metadata['useravatar'], 'avatar current');
+ $usertextcontents = $opts->metadata['userfullname'];
+
+ // Other user.
+ if (!empty($opts->metadata['asotheruser'])) {
+ $avatarcontents .= html_writer::span(
+ $opts->metadata['realuseravatar'],
+ 'avatar realuser'
+ );
+ $usertextcontents = $opts->metadata['realuserfullname'];
+ $usertextcontents .= html_writer::tag(
+ 'span',
+ get_string(
+ 'loggedinas',
+ 'moodle',
+ html_writer::span(
+ $opts->metadata['userfullname'],
+ 'value'
+ )
+ ),
+ ['class' => 'meta viewingas']
+ );
+ }
+
+ // Role.
+ if (!empty($opts->metadata['asotherrole'])) {
+ $role = core_text::strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['rolename'])));
+ $usertextcontents .= html_writer::span(
+ $opts->metadata['rolename'],
+ 'meta role role-' . $role
+ );
+ }
+
+ // User login failures.
+ if (!empty($opts->metadata['userloginfail'])) {
+ $usertextcontents .= html_writer::span(
+ $opts->metadata['userloginfail'],
+ 'meta loginfailures'
+ );
+ }
+
+ // MNet.
+ if (!empty($opts->metadata['asmnetuser'])) {
+ $mnet = strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['mnetidprovidername'])));
+ $usertextcontents .= html_writer::span(
+ $opts->metadata['mnetidprovidername'],
+ 'meta mnet mnet-' . $mnet
+ );
+ }
+
+ $returnstr .= html_writer::span(
+ html_writer::span($usertextcontents, 'usertext mr-1') .
+ html_writer::span($avatarcontents, $avatarclasses),
+ 'userbutton'
+ );
+
+ // Create a divider (well, a filler).
+ $divider = new action_menu_filler();
+ $divider->primary = false;
+
+ $am = new action_menu();
+ $am->set_menu_trigger(
+ $returnstr,
+ 'nav-link'
+ );
+ $am->set_action_label(get_string('usermenu'));
+ $am->set_nowrap_on_items();
+ if ($withlinks) {
+ $navitemcount = count($opts->navitems);
+ $idx = 0;
+ foreach ($opts->navitems as $key => $value) {
+ switch ($value->itemtype) {
+ case 'divider':
+ // If the nav item is a divider, add one and skip link processing.
+ $am->add($divider);
+ break;
+
+ case 'invalid':
+ // Silently skip invalid entries (should we post a notification?).
+ break;
+
+ case 'link':
+ // Process this as a link item.
+ $pix = null;
+ if (isset($value->pix) && !empty($value->pix)) {
+ $pix = new pix_icon($value->pix, '', null, ['class' => 'iconsmall']);
+ } else if (isset($value->imgsrc) && !empty($value->imgsrc)) {
+ $value->title = html_writer::img(
+ $value->imgsrc,
+ $value->title,
+ ['class' => 'iconsmall']
+ ) . $value->title;
+ }
+
+ $al = new action_menu_link_secondary(
+ $value->url,
+ $pix,
+ $value->title,
+ ['class' => 'icon']
+ );
+ if (!empty($value->titleidentifier)) {
+ $al->attributes['data-title'] = $value->titleidentifier;
+ }
+ $am->add($al);
+ break;
+ }
+
+ $idx++;
+
+ // Add dividers after the first item and before the last item.
+ if ($idx == 1 || $idx == $navitemcount - 1) {
+ $am->add($divider);
+ }
+ }
+ }
+
+ return html_writer::div(
+ $this->render($am),
+ $usermenuclasses
+ );
+ }
+
+ /**
+ * Secure layout login info.
+ *
+ * @return string
+ */
+ public function secure_layout_login_info() {
+ if (get_config('core', 'logininfoinsecurelayout')) {
+ return $this->login_info(false);
+ } else {
+ return '';
+ }
+ }
+
+ /**
+ * Returns the language menu in the secure layout.
+ *
+ * No custom menu items are passed though, such that it will render only the language selection.
+ *
+ * @return string
+ */
+ public function secure_layout_language_menu() {
+ if (get_config('core', 'langmenuinsecurelayout')) {
+ $custommenu = new custom_menu('', current_language());
+ return $this->render_custom_menu($custommenu);
+ } else {
+ return '';
+ }
+ }
+
+ /**
+ * This renders the navbar.
+ * Uses bootstrap compatible html.
+ */
+ public function navbar() {
+ return $this->render_from_template('core/navbar', $this->page->navbar);
+ }
+
+ /**
+ * Renders a breadcrumb navigation node object.
+ *
+ * @param breadcrumb_navigation_node $item The navigation node to render.
+ * @return string HTML fragment
+ */
+ protected function render_breadcrumb_navigation_node(breadcrumb_navigation_node $item) {
+
+ if ($item->action instanceof moodle_url) {
+ $content = $item->get_content();
+ $title = $item->get_title();
+ $attributes = [];
+ $attributes['itemprop'] = 'url';
+ if ($title !== '') {
+ $attributes['title'] = $title;
+ }
+ if ($item->hidden) {
+ $attributes['class'] = 'dimmed_text';
+ }
+ if ($item->is_last()) {
+ $attributes['aria-current'] = 'page';
+ }
+ $content = html_writer::tag('span', $content, ['itemprop' => 'title']);
+ $content = html_writer::link($item->action, $content, $attributes);
+
+ $attributes = [];
+ $attributes['itemscope'] = '';
+ $attributes['itemtype'] = 'http://data-vocabulary.org/Breadcrumb';
+ $content = html_writer::tag('span', $content, $attributes);
+ } else {
+ $content = $this->render_navigation_node($item);
+ }
+ return $content;
+ }
+
+ /**
+ * Renders a navigation node object.
+ *
+ * @param navigation_node $item The navigation node to render.
+ * @return string HTML fragment
+ */
+ protected function render_navigation_node(navigation_node $item) {
+ $content = $item->get_content();
+ $title = $item->get_title();
+ if ($item->icon instanceof renderable && !$item->hideicon) {
+ $icon = $this->render($item->icon);
+ $content = $icon . $content; // use CSS for spacing of icons
+ }
+ if ($item->helpbutton !== null) {
+ $content = trim($item->helpbutton) . html_writer::tag('span', $content, ['class' => 'clearhelpbutton', 'tabindex' => '0']);
+ }
+ if ($content === '') {
+ return '';
+ }
+ if ($item->action instanceof action_link) {
+ $link = $item->action;
+ if ($item->hidden) {
+ $link->add_class('dimmed');
+ }
+ if (!empty($content)) {
+ // Providing there is content we will use that for the link content.
+ $link->text = $content;
+ }
+ $content = $this->render($link);
+ } else if ($item->action instanceof moodle_url) {
+ $attributes = [];
+ if ($title !== '') {
+ $attributes['title'] = $title;
+ }
+ if ($item->hidden) {
+ $attributes['class'] = 'dimmed_text';
+ }
+ $content = html_writer::link($item->action, $content, $attributes);
+ } else if (is_string($item->action) || empty($item->action)) {
+ $attributes = ['tabindex' => '0']; // add tab support to span but still maintain character stream sequence.
+ if ($title !== '') {
+ $attributes['title'] = $title;
+ }
+ if ($item->hidden) {
+ $attributes['class'] = 'dimmed_text';
+ }
+ $content = html_writer::tag('span', $content, $attributes);
+ }
+ return $content;
+ }
+
+ /**
+ * Accessibility: Right arrow-like character is
+ * used in the breadcrumb trail, course navigation menu
+ * (previous/next activity), calendar, and search forum block.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically. Please DO NOT
+ * use < > » - these are confusing for blind users.
+ *
+ * @return string
+ */
+ public function rarrow() {
+ return $this->page->theme->rarrow;
+ }
+
+ /**
+ * Accessibility: Left arrow-like character is
+ * used in the breadcrumb trail, course navigation menu
+ * (previous/next activity), calendar, and search forum block.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically. Please DO NOT
+ * use < > » - these are confusing for blind users.
+ *
+ * @return string
+ */
+ public function larrow() {
+ return $this->page->theme->larrow;
+ }
+
+ /**
+ * Accessibility: Up arrow-like character is used in
+ * the book heirarchical navigation.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically. Please DO NOT
+ * use ^ - this is confusing for blind users.
+ *
+ * @return string
+ */
+ public function uarrow() {
+ return $this->page->theme->uarrow;
+ }
+
+ /**
+ * Accessibility: Down arrow-like character.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically.
+ *
+ * @return string
+ */
+ public function darrow() {
+ return $this->page->theme->darrow;
+ }
+
+ /**
+ * Returns the custom menu if one has been set
+ *
+ * A custom menu can be configured by browsing to a theme's settings page
+ * and then configuring the custommenu config setting as described.
+ *
+ * Theme developers: DO NOT OVERRIDE! Please override function
+ * {@see core_renderer::render_custom_menu()} instead.
+ *
+ * @param string $custommenuitems - custom menuitems set by theme instead of global theme settings
+ * @return string
+ */
+ public function custom_menu($custommenuitems = '') {
+ global $CFG;
+
+ if (empty($custommenuitems) && !empty($CFG->custommenuitems)) {
+ $custommenuitems = $CFG->custommenuitems;
+ }
+ $custommenu = new custom_menu($custommenuitems, current_language());
+ return $this->render_custom_menu($custommenu);
+ }
+
+ /**
+ * We want to show the custom menus as a list of links in the footer on small screens.
+ * Just return the menu object exported so we can render it differently.
+ */
+ public function custom_menu_flat() {
+ global $CFG;
+ $custommenuitems = '';
+
+ if (empty($custommenuitems) && !empty($CFG->custommenuitems)) {
+ $custommenuitems = $CFG->custommenuitems;
+ }
+ $custommenu = new custom_menu($custommenuitems, current_language());
+ $langs = get_string_manager()->get_list_of_translations();
+ $haslangmenu = $this->lang_menu() != '';
+
+ if ($haslangmenu) {
+ $strlang = get_string('language');
+ $currentlang = current_language();
+ if (isset($langs[$currentlang])) {
+ $currentlang = $langs[$currentlang];
+ } else {
+ $currentlang = $strlang;
+ }
+ $this->language = $custommenu->add($currentlang, new moodle_url('#'), $strlang, 10000);
+ foreach ($langs as $langtype => $langname) {
+ $this->language->add($langname, new moodle_url($this->page->url, ['lang' => $langtype]), $langname);
+ }
+ }
+
+ return $custommenu->export_for_template($this);
+ }
+
+ /**
+ * Renders a custom menu object (located in outputcomponents.php)
+ *
+ * The custom menu this method produces makes use of the YUI3 menunav widget
+ * and requires very specific html elements and classes.
+ *
+ * @staticvar int $menucount
+ * @param custom_menu $menu
+ * @return string
+ */
+ protected function render_custom_menu(custom_menu $menu) {
+ global $CFG;
+
+ $langs = get_string_manager()->get_list_of_translations();
+ $haslangmenu = $this->lang_menu() != '';
+
+ if (!$menu->has_children() && !$haslangmenu) {
+ return '';
+ }
+
+ if ($haslangmenu) {
+ $strlang = get_string('language');
+ $currentlang = current_language();
+ if (isset($langs[$currentlang])) {
+ $currentlangstr = $langs[$currentlang];
+ } else {
+ $currentlangstr = $strlang;
+ }
+ $this->language = $menu->add($currentlangstr, new moodle_url('#'), $strlang, 10000);
+ foreach ($langs as $langtype => $langname) {
+ $attributes = [];
+ // Set the lang attribute for languages different from the page's current language.
+ if ($langtype !== $currentlang) {
+ $attributes[] = [
+ 'key' => 'lang',
+ 'value' => get_html_lang_attribute_value($langtype),
+ ];
+ }
+ $this->language->add($langname, new moodle_url($this->page->url, ['lang' => $langtype]), null, null, $attributes);
+ }
+ }
+
+ $content = '';
+ foreach ($menu->get_children() as $item) {
+ $context = $item->export_for_template($this);
+ $content .= $this->render_from_template('core/custom_menu_item', $context);
+ }
+
+ return $content;
+ }
+
+ /**
+ * Renders a custom menu node as part of a submenu
+ *
+ * The custom menu this method produces makes use of the YUI3 menunav widget
+ * and requires very specific html elements and classes.
+ *
+ * @see core:renderer::render_custom_menu()
+ *
+ * @staticvar int $submenucount
+ * @param custom_menu_item $menunode
+ * @return string
+ */
+ protected function render_custom_menu_item(custom_menu_item $menunode) {
+ // Required to ensure we get unique trackable id's
+ static $submenucount = 0;
+ if ($menunode->has_children()) {
+ // If the child has menus render it as a sub menu
+ $submenucount++;
+ $content = html_writer::start_tag('li');
+ if ($menunode->get_url() !== null) {
+ $url = $menunode->get_url();
+ } else {
+ $url = '#cm_submenu_' . $submenucount;
+ }
+ $content .= html_writer::link($url, $menunode->get_text(), ['class' => 'yui3-menu-label', 'title' => $menunode->get_title()]);
+ $content .= html_writer::start_tag('div', ['id' => 'cm_submenu_' . $submenucount, 'class' => 'yui3-menu custom_menu_submenu']);
+ $content .= html_writer::start_tag('div', ['class' => 'yui3-menu-content']);
+ $content .= html_writer::start_tag('ul');
+ foreach ($menunode->get_children() as $menunode) {
+ $content .= $this->render_custom_menu_item($menunode);
+ }
+ $content .= html_writer::end_tag('ul');
+ $content .= html_writer::end_tag('div');
+ $content .= html_writer::end_tag('div');
+ $content .= html_writer::end_tag('li');
+ } else {
+ // The node doesn't have children so produce a final menuitem.
+ // Also, if the node's text matches '####', add a class so we can treat it as a divider.
+ $content = '';
+ if (preg_match("/^#+$/", $menunode->get_text())) {
+ // This is a divider.
+ $content = html_writer::start_tag('li', ['class' => 'yui3-menuitem divider']);
+ } else {
+ $content = html_writer::start_tag(
+ 'li',
+ [
+ 'class' => 'yui3-menuitem',
+ ]
+ );
+ if ($menunode->get_url() !== null) {
+ $url = $menunode->get_url();
+ } else {
+ $url = '#';
+ }
+ $content .= html_writer::link(
+ $url,
+ $menunode->get_text(),
+ ['class' => 'yui3-menuitem-content', 'title' => $menunode->get_title()]
+ );
+ }
+ $content .= html_writer::end_tag('li');
+ }
+ // Return the sub menu
+ return $content;
+ }
+
+ /**
+ * Renders theme links for switching between default and other themes.
+ *
+ * @return string
+ */
+ protected function theme_switch_links() {
+
+ $actualdevice = core_useragent::get_device_type();
+ $currentdevice = $this->page->devicetypeinuse;
+ $switched = ($actualdevice != $currentdevice);
+
+ if (!$switched && $currentdevice == 'default' && $actualdevice == 'default') {
+ // The user is using the a default device and hasn't switched so don't shown the switch
+ // device links.
+ return '';
+ }
+
+ if ($switched) {
+ $linktext = get_string('switchdevicerecommended');
+ $devicetype = $actualdevice;
+ } else {
+ $linktext = get_string('switchdevicedefault');
+ $devicetype = 'default';
+ }
+ $linkurl = new moodle_url('/theme/switchdevice.php', ['url' => $this->page->url, 'device' => $devicetype, 'sesskey' => sesskey()]);
+
+ $content = html_writer::start_tag('div', ['id' => 'theme_switch_link']);
+ $content .= html_writer::link($linkurl, $linktext, ['rel' => 'nofollow']);
+ $content .= html_writer::end_tag('div');
+
+ return $content;
+ }
+
+ /**
+ * Renders tabs
+ *
+ * This function replaces print_tabs() used before Moodle 2.5 but with slightly different arguments
+ *
+ * Theme developers: In order to change how tabs are displayed please override functions
+ * {@see core_renderer::render_tabtree()} and/or {@see core_renderer::render_tabobject()}
+ *
+ * @param array $tabs array of tabs, each of them may have it's own ->subtree
+ * @param string|null $selected which tab to mark as selected, all parent tabs will
+ * automatically be marked as activated
+ * @param array|string|null $inactive list of ids of inactive tabs, regardless of
+ * their level. Note that you can as weel specify tabobject::$inactive for separate instances
+ * @return string
+ */
+ final public function tabtree($tabs, $selected = null, $inactive = null) {
+ return $this->render(new tabtree($tabs, $selected, $inactive));
+ }
+
+ /**
+ * Renders tabtree
+ *
+ * @param tabtree $tabtree
+ * @return string
+ */
+ protected function render_tabtree(tabtree $tabtree) {
+ if (empty($tabtree->subtree)) {
+ return '';
+ }
+ $data = $tabtree->export_for_template($this);
+ return $this->render_from_template('core/tabtree', $data);
+ }
+
+ /**
+ * Renders tabobject (part of tabtree)
+ *
+ * This function is called from {@see core_renderer::render_tabtree()}
+ * and also it calls itself when printing the $tabobject subtree recursively.
+ *
+ * Property $tabobject->level indicates the number of row of tabs.
+ *
+ * @param tabobject $tabobject
+ * @return string HTML fragment
+ */
+ protected function render_tabobject(tabobject $tabobject) {
+ $str = '';
+
+ // Print name of the current tab.
+ if ($tabobject instanceof tabtree) {
+ // No name for tabtree root.
+ } else if ($tabobject->inactive || $tabobject->activated || ($tabobject->selected && !$tabobject->linkedwhenselected)) {
+ // Tab name without a link. The tag is used for styling.
+ $str .= html_writer::tag('a', html_writer::span($tabobject->text), ['class' => 'nolink moodle-has-zindex']);
+ } else {
+ // Tab name with a link.
+ if (!($tabobject->link instanceof moodle_url)) {
+ // backward compartibility when link was passed as quoted string
+ $str .= "link\" title=\"$tabobject->title\">$tabobject->text";
+ } else {
+ $str .= html_writer::link($tabobject->link, html_writer::span($tabobject->text), ['title' => $tabobject->title]);
+ }
+ }
+
+ if (empty($tabobject->subtree)) {
+ if ($tabobject->selected) {
+ $str .= html_writer::tag('div', ' ', ['class' => 'tabrow' . ($tabobject->level + 1) . ' empty']);
+ }
+ return $str;
+ }
+
+ // Print subtree.
+ if ($tabobject->level == 0 || $tabobject->selected || $tabobject->activated) {
+ $str .= html_writer::start_tag('ul', ['class' => 'tabrow' . $tabobject->level]);
+ $cnt = 0;
+ foreach ($tabobject->subtree as $tab) {
+ $liclass = '';
+ if (!$cnt) {
+ $liclass .= ' first';
+ }
+ if ($cnt == count($tabobject->subtree) - 1) {
+ $liclass .= ' last';
+ }
+ if ((empty($tab->subtree)) && (!empty($tab->selected))) {
+ $liclass .= ' onerow';
+ }
+
+ if ($tab->selected) {
+ $liclass .= ' here selected';
+ } else if ($tab->activated) {
+ $liclass .= ' here active';
+ }
+
+ // This will recursively call function render_tabobject() for each item in subtree.
+ $str .= html_writer::tag('li', $this->render($tab), ['class' => trim($liclass)]);
+ $cnt++;
+ }
+ $str .= html_writer::end_tag('ul');
+ }
+
+ return $str;
+ }
+
+ /**
+ * Get the HTML for blocks in the given region.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @param string $region The region to get HTML for.
+ * @param array $classes Wrapping tag classes.
+ * @param string $tag Wrapping tag.
+ * @param boolean $fakeblocksonly Include fake blocks only.
+ * @return string HTML.
+ */
+ public function blocks($region, $classes = [], $tag = 'aside', $fakeblocksonly = false) {
+ $displayregion = $this->page->apply_theme_region_manipulations($region);
+ $classes = (array)$classes;
+ $classes[] = 'block-region';
+ $attributes = [
+ 'id' => 'block-region-' . preg_replace('#[^a-zA-Z0-9_\-]+#', '-', $displayregion),
+ 'class' => join(' ', $classes),
+ 'data-blockregion' => $displayregion,
+ 'data-droptarget' => '1',
+ ];
+ if ($this->page->blocks->region_has_content($displayregion, $this)) {
+ $content = html_writer::tag('h2', get_string('blocks'), ['class' => 'sr-only']) .
+ $this->blocks_for_region($displayregion, $fakeblocksonly);
+ } else {
+ $content = html_writer::tag('h2', get_string('blocks'), ['class' => 'sr-only']);
+ }
+ return html_writer::tag($tag, $content, $attributes);
+ }
+
+ /**
+ * Renders a custom block region.
+ *
+ * Use this method if you want to add an additional block region to the content of the page.
+ * Please note this should only be used in special situations.
+ * We want to leave the theme is control where ever possible!
+ *
+ * This method must use the same method that the theme uses within its layout file.
+ * As such it asks the theme what method it is using.
+ * It can be one of two values, blocks or blocks_for_region (deprecated).
+ *
+ * @param string $regionname The name of the custom region to add.
+ * @return string HTML for the block region.
+ */
+ public function custom_block_region($regionname) {
+ if ($this->page->theme->get_block_render_method() === 'blocks') {
+ return $this->blocks($regionname);
+ } else {
+ return $this->blocks_for_region($regionname);
+ }
+ }
+
+ /**
+ * Returns the CSS classes to apply to the body tag.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @param array $additionalclasses Any additional classes to apply.
+ * @return string
+ */
+ public function body_css_classes(array $additionalclasses = []) {
+ return $this->page->bodyclasses . ' ' . implode(' ', $additionalclasses);
+ }
+
+ /**
+ * The ID attribute to apply to the body tag.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @return string
+ */
+ public function body_id() {
+ return $this->page->bodyid;
+ }
+
+ /**
+ * Returns HTML attributes to use within the body tag. This includes an ID and classes.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @param string|array $additionalclasses Any additional classes to give the body tag,
+ * @return string
+ */
+ public function body_attributes($additionalclasses = []) {
+ if (!is_array($additionalclasses)) {
+ $additionalclasses = explode(' ', $additionalclasses);
+ }
+ return ' id="' . $this->body_id() . '" class="' . $this->body_css_classes($additionalclasses) . '"';
+ }
+
+ /**
+ * Gets HTML for the page heading.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @param string $tag The tag to encase the heading in. h1 by default.
+ * @return string HTML.
+ */
+ public function page_heading($tag = 'h1') {
+ return html_writer::tag($tag, $this->page->heading);
+ }
+
+ /**
+ * Gets the HTML for the page heading button.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @return string HTML.
+ */
+ public function page_heading_button() {
+ return $this->page->button;
+ }
+
+ /**
+ * Returns the Moodle docs link to use for this page.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @param string $text
+ * @return string
+ */
+ public function page_doc_link($text = null) {
+ if ($text === null) {
+ $text = get_string('moodledocslink');
+ }
+ $path = page_get_doc_link_path($this->page);
+ if (!$path) {
+ return '';
+ }
+ return $this->doc_link($path, $text);
+ }
+
+ /**
+ * Returns the HTML for the site support email link
+ *
+ * @param array $customattribs Array of custom attributes for the support email anchor tag.
+ * @param bool $embed Set to true if you want to embed the link in other inline content.
+ * @return string The html code for the support email link.
+ */
+ public function supportemail(array $customattribs = [], bool $embed = false): string {
+ global $CFG;
+
+ // Do not provide a link to contact site support if it is unavailable to this user. This would be where the site has
+ // disabled support, or limited it to authenticated users and the current user is a guest or not logged in.
+ if (
+ !isset($CFG->supportavailability) ||
+ $CFG->supportavailability == CONTACT_SUPPORT_DISABLED ||
+ ($CFG->supportavailability == CONTACT_SUPPORT_AUTHENTICATED && (!isloggedin() || isguestuser()))
+ ) {
+ return '';
+ }
+
+ $label = get_string('contactsitesupport', 'admin');
+ $icon = $this->pix_icon('t/email', '');
+
+ if (!$embed) {
+ $content = $icon . $label;
+ } else {
+ $content = $label;
+ }
+
+ if (!empty($CFG->supportpage)) {
+ $attributes = ['href' => $CFG->supportpage, 'target' => 'blank'];
+ $content .= $this->pix_icon('i/externallink', '', 'moodle', ['class' => 'ml-1']);
+ } else {
+ $attributes = ['href' => $CFG->wwwroot . '/user/contactsitesupport.php'];
+ }
+
+ $attributes += $customattribs;
+
+ return html_writer::tag('a', $content, $attributes);
+ }
+
+ /**
+ * Returns the services and support link for the help pop-up.
+ *
+ * @return string
+ */
+ public function services_support_link(): string {
+ global $CFG;
+
+ if (
+ during_initial_install() ||
+ (isset($CFG->showservicesandsupportcontent) && $CFG->showservicesandsupportcontent == false) ||
+ !is_siteadmin()
+ ) {
+ return '';
+ }
+
+ $liferingicon = $this->pix_icon('t/life-ring', '', 'moodle', ['class' => 'fa fa-life-ring']);
+ $newwindowicon = $this->pix_icon('i/externallink', get_string('opensinnewwindow'), 'moodle', ['class' => 'ml-1']);
+ $link = !empty($CFG->servicespage)
+ ? $CFG->servicespage
+ : 'https://moodle.com/help/?utm_source=CTA-banner&utm_medium=platform&utm_campaign=name~Moodle4+cat~lms+mp~no';
+ $content = $liferingicon . get_string('moodleservicesandsupport') . $newwindowicon;
+
+ return html_writer::tag('a', $content, ['target' => '_blank', 'href' => $link]);
+ }
+
+ /**
+ * Helper function to decide whether to show the help popover header or not.
+ *
+ * @return bool
+ */
+ public function has_popover_links(): bool {
+ return !empty($this->services_support_link()) || !empty($this->page_doc_link()) || !empty($this->supportemail());
+ }
+
+ /**
+ * Helper function to decide whether to show the communication link or not.
+ *
+ * @return bool
+ */
+ public function has_communication_links(): bool {
+ if (during_initial_install() || !\core_communication\api::is_available()) {
+ return false;
+ }
+ return !empty($this->communication_link());
+ }
+
+ /**
+ * Returns the communication link, complete with html.
+ *
+ * @return string
+ */
+ public function communication_link(): string {
+ $link = $this->communication_url() ?? '';
+ $commicon = $this->pix_icon('t/messages-o', '', 'moodle', ['class' => 'fa fa-comments']);
+ $newwindowicon = $this->pix_icon('i/externallink', get_string('opensinnewwindow'), 'moodle', ['class' => 'ml-1']);
+ $content = $commicon . get_string('communicationroomlink', 'course') . $newwindowicon;
+ $html = html_writer::tag('a', $content, ['target' => '_blank', 'href' => $link]);
+
+ return !empty($link) ? $html : '';
+ }
+
+ /**
+ * Returns the communication url for a given instance if it exists.
+ *
+ * @return string
+ */
+ public function communication_url(): string {
+ global $COURSE;
+ return \core_communication\helper::get_course_communication_url($COURSE);
+ }
+
+ /**
+ * Returns the page heading menu.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @return string HTML.
+ */
+ public function page_heading_menu() {
+ return $this->page->headingmenu;
+ }
+
+ /**
+ * Returns the title to use on the page.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @return string
+ */
+ public function page_title() {
+ return $this->page->title;
+ }
+
+ /**
+ * Returns the moodle_url for the favicon.
+ *
+ * @since Moodle 2.5.1 2.6
+ * @return moodle_url The moodle_url for the favicon
+ */
+ public function favicon() {
+ $logo = null;
+ if (!during_initial_install()) {
+ $logo = get_config('core_admin', 'favicon');
+ }
+ if (empty($logo)) {
+ return $this->image_url('favicon', 'theme');
+ }
+
+ // Use $CFG->themerev to prevent browser caching when the file changes.
+ return moodle_url::make_pluginfile_url(
+ context_system::instance()->id,
+ 'core_admin',
+ 'favicon',
+ '64x64/',
+ theme_get_revision(),
+ $logo
+ );
+ }
+
+ /**
+ * Renders preferences groups.
+ *
+ * @param preferences_groups $renderable The renderable
+ * @return string The output.
+ */
+ public function render_preferences_groups(preferences_groups $renderable) {
+ return $this->render_from_template('core/preferences_groups', $renderable);
+ }
+
+ /**
+ * Renders preferences group.
+ *
+ * @param preferences_group $renderable The renderable
+ * @return string The output.
+ */
+ public function render_preferences_group(preferences_group $renderable) {
+ $html = '';
+ $html .= html_writer::start_tag('div', ['class' => 'col-sm-4 preferences-group']);
+ $html .= $this->heading($renderable->title, 3);
+ $html .= html_writer::start_tag('ul');
+ foreach ($renderable->nodes as $node) {
+ if ($node->has_children()) {
+ debugging('Preferences nodes do not support children', DEBUG_DEVELOPER);
+ }
+ $html .= html_writer::tag('li', $this->render($node));
+ }
+ $html .= html_writer::end_tag('ul');
+ $html .= html_writer::end_tag('div');
+ return $html;
+ }
+
+ public function context_header($headerinfo = null, $headinglevel = 1) {
+ global $DB, $USER, $CFG, $SITE;
+ require_once($CFG->dirroot . '/user/lib.php');
+ $context = $this->page->context;
+ $heading = null;
+ $imagedata = null;
+ $subheader = null;
+ $userbuttons = null;
+
+ // Make sure to use the heading if it has been set.
+ if (isset($headerinfo['heading'])) {
+ $heading = $headerinfo['heading'];
+ } else {
+ $heading = $this->page->heading;
+ }
+
+ // The user context currently has images and buttons. Other contexts may follow.
+ if ((isset($headerinfo['user']) || $context->contextlevel == CONTEXT_USER) && $this->page->pagetype !== 'my-index') {
+ if (isset($headerinfo['user'])) {
+ $user = $headerinfo['user'];
+ } else {
+ // Look up the user information if it is not supplied.
+ $user = $DB->get_record('user', ['id' => $context->instanceid]);
+ }
+
+ // If the user context is set, then use that for capability checks.
+ if (isset($headerinfo['usercontext'])) {
+ $context = $headerinfo['usercontext'];
+ }
+
+ // Only provide user information if the user is the current user, or a user which the current user can view.
+ // When checking user_can_view_profile(), either:
+ // If the page context is course, check the course context (from the page object) or;
+ // If page context is NOT course, then check across all courses.
+ $course = ($this->page->context->contextlevel == CONTEXT_COURSE) ? $this->page->course : null;
+
+ if (user_can_view_profile($user, $course)) {
+ // Use the user's full name if the heading isn't set.
+ if (empty($heading)) {
+ $heading = fullname($user);
+ }
+
+ $imagedata = $this->user_picture($user, ['size' => 100]);
+
+ // Check to see if we should be displaying a message button.
+ if (!empty($CFG->messaging) && has_capability('moodle/site:sendmessage', $context)) {
+ $userbuttons = [
+ 'messages' => [
+ 'buttontype' => 'message',
+ 'title' => get_string('message', 'message'),
+ 'url' => new moodle_url('/message/index.php', ['id' => $user->id]),
+ 'image' => 'message',
+ 'linkattributes' => \core_message\helper::messageuser_link_params($user->id),
+ 'page' => $this->page,
+ ],
+ ];
+
+ if ($USER->id != $user->id) {
+ $iscontact = \core_message\api::is_contact($USER->id, $user->id);
+ $isrequested = \core_message\api::get_contact_requests_between_users($USER->id, $user->id);
+ $contacturlaction = '';
+ $linkattributes = \core_message\helper::togglecontact_link_params(
+ $user,
+ $iscontact,
+ true,
+ !empty($isrequested),
+ );
+ // If the user is not a contact.
+ if (!$iscontact) {
+ if ($isrequested) {
+ // We just need the first request.
+ $requests = array_shift($isrequested);
+ if ($requests->userid == $USER->id) {
+ // If the user has requested to be a contact.
+ $contacttitle = 'contactrequestsent';
+ } else {
+ // If the user has been requested to be a contact.
+ $contacttitle = 'waitingforcontactaccept';
+ }
+ $linkattributes = array_merge($linkattributes, [
+ 'class' => 'disabled',
+ 'tabindex' => '-1',
+ ]);
+ } else {
+ // If the user is not a contact and has not requested to be a contact.
+ $contacttitle = 'addtoyourcontacts';
+ $contacturlaction = 'addcontact';
+ }
+ $contactimage = 'addcontact';
+ } else {
+ // If the user is a contact.
+ $contacttitle = 'removefromyourcontacts';
+ $contacturlaction = 'removecontact';
+ $contactimage = 'removecontact';
+ }
+ $userbuttons['togglecontact'] = [
+ 'buttontype' => 'togglecontact',
+ 'title' => get_string($contacttitle, 'message'),
+ 'url' => new moodle_url('/message/index.php', [
+ 'user1' => $USER->id,
+ 'user2' => $user->id,
+ $contacturlaction => $user->id,
+ 'sesskey' => sesskey(),
+ ]),
+ 'image' => $contactimage,
+ 'linkattributes' => $linkattributes,
+ 'page' => $this->page,
+ ];
+ }
+ }
+ } else {
+ $heading = null;
+ }
+ }
+
+ // Return the heading wrapped in an sr-only element so it is only visible to screen-readers for nocontextheader layouts.
+ if (!empty($this->page->layout_options['nocontextheader'])) {
+ return html_writer::div($heading, 'sr-only');
+ }
+
+ $contextheader = new context_header($heading, $headinglevel, $imagedata, $userbuttons);
+ return $this->render($contextheader);
+ }
+
+ /**
+ * Renders the header bar.
+ *
+ * @param context_header $contextheader Header bar object.
+ * @return string HTML for the header bar.
+ * @deprecated since 4.5 Please use core_renderer::render($contextheader) instead
+ * @todo MDL-82163 This will be deleted in Moodle 6.0.
+ */
+ #[\core\attribute\deprecated('core_renderer::render($contextheader)', since: '4.5', mdl: 'MDL-82160')]
+ protected function render_context_header(context_header $contextheader) {
+ $context = $contextheader->export_for_template($this);
+ return $this->render_from_template('core/context_header', $context);
+ }
+
+ /**
+ * Renders the skip links for the page.
+ *
+ * @param array $links List of skip links.
+ * @return string HTML for the skip links.
+ */
+ public function render_skip_links($links) {
+ $context = [ 'links' => []];
+
+ foreach ($links as $url => $text) {
+ $context['links'][] = [ 'url' => $url, 'text' => $text];
+ }
+
+ return $this->render_from_template('core/skip_links', $context);
+ }
+
+ /**
+ * Wrapper for header elements.
+ *
+ * @return string HTML to display the main header.
+ */
+ public function full_header() {
+ $pagetype = $this->page->pagetype;
+ $homepage = get_home_page();
+ $homepagetype = null;
+ // Add a special case since /my/courses is a part of the /my subsystem.
+ if ($homepage == HOMEPAGE_MY || $homepage == HOMEPAGE_MYCOURSES) {
+ $homepagetype = 'my-index';
+ } else if ($homepage == HOMEPAGE_SITE) {
+ $homepagetype = 'site-index';
+ }
+ if (
+ $this->page->include_region_main_settings_in_header_actions() &&
+ !$this->page->blocks->is_block_present('settings')
+ ) {
+ // Only include the region main settings if the page has requested it and it doesn't already have
+ // the settings block on it. The region main settings are included in the settings block and
+ // duplicating the content causes behat failures.
+ $this->page->add_header_action(html_writer::div(
+ $this->region_main_settings_menu(),
+ 'd-print-none',
+ ['id' => 'region-main-settings-menu']
+ ));
+ }
+
+ $header = new stdClass();
+ $header->settingsmenu = $this->context_header_settings_menu();
+ $header->contextheader = $this->context_header();
+ $header->hasnavbar = empty($this->page->layout_options['nonavbar']);
+ $header->navbar = $this->navbar();
+ $header->pageheadingbutton = $this->page_heading_button();
+ $header->courseheader = $this->course_header();
+ $header->headeractions = $this->page->get_header_actions();
+ if (!empty($pagetype) && !empty($homepagetype) && $pagetype == $homepagetype) {
+ $header->welcomemessage = \core_user::welcome_message();
+ }
+ return $this->render_from_template('core/full_header', $header);
+ }
+
+ /**
+ * This is an optional menu that can be added to a layout by a theme. It contains the
+ * menu for the course administration, only on the course main page.
+ *
+ * @return string
+ */
+ public function context_header_settings_menu() {
+ $context = $this->page->context;
+ $menu = new action_menu();
+
+ $items = $this->page->navbar->get_items();
+ $currentnode = end($items);
+
+ $showcoursemenu = false;
+ $showfrontpagemenu = false;
+ $showusermenu = false;
+
+ // We are on the course home page.
+ if (
+ ($context->contextlevel == CONTEXT_COURSE) &&
+ !empty($currentnode) &&
+ ($currentnode->type == navigation_node::TYPE_COURSE || $currentnode->type == navigation_node::TYPE_SECTION)
+ ) {
+ $showcoursemenu = true;
+ }
+
+ $courseformat = course_get_format($this->page->course);
+ // This is a single activity course format, always show the course menu on the activity main page.
+ if (
+ $context->contextlevel == CONTEXT_MODULE &&
+ !$courseformat->has_view_page()
+ ) {
+ $this->page->navigation->initialise();
+ $activenode = $this->page->navigation->find_active_node();
+ // If the settings menu has been forced then show the menu.
+ if ($this->page->is_settings_menu_forced()) {
+ $showcoursemenu = true;
+ } else if (
+ !empty($activenode) && ($activenode->type == navigation_node::TYPE_ACTIVITY ||
+ $activenode->type == navigation_node::TYPE_RESOURCE)
+ ) {
+ // We only want to show the menu on the first page of the activity. This means
+ // the breadcrumb has no additional nodes.
+ if ($currentnode && ($currentnode->key == $activenode->key && $currentnode->type == $activenode->type)) {
+ $showcoursemenu = true;
+ }
+ }
+ }
+
+ // This is the site front page.
+ if (
+ $context->contextlevel == CONTEXT_COURSE &&
+ !empty($currentnode) &&
+ $currentnode->key === 'home'
+ ) {
+ $showfrontpagemenu = true;
+ }
+
+ // This is the user profile page.
+ if (
+ $context->contextlevel == CONTEXT_USER &&
+ !empty($currentnode) &&
+ ($currentnode->key === 'myprofile')
+ ) {
+ $showusermenu = true;
+ }
+
+ if ($showfrontpagemenu) {
+ $settingsnode = $this->page->settingsnav->find('frontpage', navigation_node::TYPE_SETTING);
+ if ($settingsnode) {
+ // Build an action menu based on the visible nodes from this navigation tree.
+ $skipped = $this->build_action_menu_from_navigation($menu, $settingsnode, false, true);
+
+ // We only add a list to the full settings menu if we didn't include every node in the short menu.
+ if ($skipped) {
+ $text = get_string('morenavigationlinks');
+ $url = new moodle_url('/course/admin.php', ['courseid' => $this->page->course->id]);
+ $link = new action_link($url, $text, null, null, new pix_icon('t/edit', $text));
+ $menu->add_secondary_action($link);
+ }
+ }
+ } else if ($showcoursemenu) {
+ $settingsnode = $this->page->settingsnav->find('courseadmin', navigation_node::TYPE_COURSE);
+ if ($settingsnode) {
+ // Build an action menu based on the visible nodes from this navigation tree.
+ $skipped = $this->build_action_menu_from_navigation($menu, $settingsnode, false, true);
+
+ // We only add a list to the full settings menu if we didn't include every node in the short menu.
+ if ($skipped) {
+ $text = get_string('morenavigationlinks');
+ $url = new moodle_url('/course/admin.php', ['courseid' => $this->page->course->id]);
+ $link = new action_link($url, $text, null, null, new pix_icon('t/edit', $text));
+ $menu->add_secondary_action($link);
+ }
+ }
+ } else if ($showusermenu) {
+ // Get the course admin node from the settings navigation.
+ $settingsnode = $this->page->settingsnav->find('useraccount', navigation_node::TYPE_CONTAINER);
+ if ($settingsnode) {
+ // Build an action menu based on the visible nodes from this navigation tree.
+ $this->build_action_menu_from_navigation($menu, $settingsnode);
+ }
+ }
+
+ return $this->render($menu);
+ }
+
+ /**
+ * Take a node in the nav tree and make an action menu out of it.
+ * The links are injected in the action menu.
+ *
+ * @param action_menu $menu
+ * @param navigation_node $node
+ * @param boolean $indent
+ * @param boolean $onlytopleafnodes
+ * @return boolean nodesskipped - True if nodes were skipped in building the menu
+ */
+ protected function build_action_menu_from_navigation(
+ action_menu $menu,
+ navigation_node $node,
+ $indent = false,
+ $onlytopleafnodes = false
+ ) {
+ $skipped = false;
+ // Build an action menu based on the visible nodes from this navigation tree.
+ foreach ($node->children as $menuitem) {
+ if ($menuitem->display) {
+ if ($onlytopleafnodes && $menuitem->children->count()) {
+ $skipped = true;
+ continue;
+ }
+ if ($menuitem->action) {
+ if ($menuitem->action instanceof action_link) {
+ $link = $menuitem->action;
+ // Give preference to setting icon over action icon.
+ if (!empty($menuitem->icon)) {
+ $link->icon = $menuitem->icon;
+ }
+ } else {
+ $link = new action_link($menuitem->action, $menuitem->text, null, null, $menuitem->icon);
+ }
+ } else {
+ if ($onlytopleafnodes) {
+ $skipped = true;
+ continue;
+ }
+ $link = new action_link(new moodle_url('#'), $menuitem->text, null, ['disabled' => true], $menuitem->icon);
+ }
+ if ($indent) {
+ $link->add_class('ml-4');
+ }
+ if (!empty($menuitem->classes)) {
+ $link->add_class(implode(" ", $menuitem->classes));
+ }
+
+ $menu->add_secondary_action($link);
+ $skipped = $skipped || $this->build_action_menu_from_navigation($menu, $menuitem, true);
+ }
+ }
+ return $skipped;
+ }
+
+ /**
+ * This is an optional menu that can be added to a layout by a theme. It contains the
+ * menu for the most specific thing from the settings block. E.g. Module administration.
+ *
+ * @return string
+ */
+ public function region_main_settings_menu() {
+ $context = $this->page->context;
+ $menu = new action_menu();
+
+ if ($context->contextlevel == CONTEXT_MODULE) {
+ $this->page->navigation->initialise();
+ $node = $this->page->navigation->find_active_node();
+ $buildmenu = false;
+ // If the settings menu has been forced then show the menu.
+ if ($this->page->is_settings_menu_forced()) {
+ $buildmenu = true;
+ } else if (
+ !empty($node) && ($node->type == navigation_node::TYPE_ACTIVITY ||
+ $node->type == navigation_node::TYPE_RESOURCE)
+ ) {
+ $items = $this->page->navbar->get_items();
+ $navbarnode = end($items);
+ // We only want to show the menu on the first page of the activity. This means
+ // the breadcrumb has no additional nodes.
+ if ($navbarnode && ($navbarnode->key === $node->key && $navbarnode->type == $node->type)) {
+ $buildmenu = true;
+ }
+ }
+ if ($buildmenu) {
+ // Get the course admin node from the settings navigation.
+ $node = $this->page->settingsnav->find('modulesettings', navigation_node::TYPE_SETTING);
+ if ($node) {
+ // Build an action menu based on the visible nodes from this navigation tree.
+ $this->build_action_menu_from_navigation($menu, $node);
+ }
+ }
+ } else if ($context->contextlevel == CONTEXT_COURSECAT) {
+ // For course category context, show category settings menu, if we're on the course category page.
+ if ($this->page->pagetype === 'course-index-category') {
+ $node = $this->page->settingsnav->find('categorysettings', navigation_node::TYPE_CONTAINER);
+ if ($node) {
+ // Build an action menu based on the visible nodes from this navigation tree.
+ $this->build_action_menu_from_navigation($menu, $node);
+ }
+ }
+ } else {
+ $items = $this->page->navbar->get_items();
+ $navbarnode = end($items);
+
+ if ($navbarnode && ($navbarnode->key === 'participants')) {
+ $node = $this->page->settingsnav->find('users', navigation_node::TYPE_CONTAINER);
+ if ($node) {
+ // Build an action menu based on the visible nodes from this navigation tree.
+ $this->build_action_menu_from_navigation($menu, $node);
+ }
+ }
+ }
+ return $this->render($menu);
+ }
+
+ /**
+ * Displays the list of tags associated with an entry
+ *
+ * @param array $tags list of instances of core_tag or stdClass
+ * @param string $label label to display in front, by default 'Tags' (get_string('tags')), set to null
+ * to use default, set to '' (empty string) to omit the label completely
+ * @param string $classes additional classes for the enclosing div element
+ * @param int $limit limit the number of tags to display, if size of $tags is more than this limit the "more" link
+ * will be appended to the end, JS will toggle the rest of the tags
+ * @param context $pagecontext specify if needed to overwrite the current page context for the view tag link
+ * @param bool $accesshidelabel if true, the label should have class="accesshide" added.
+ * @return string
+ */
+ public function tag_list(
+ $tags,
+ $label = null,
+ $classes = '',
+ $limit = 10,
+ $pagecontext = null,
+ $accesshidelabel = false
+ ) {
+ $list = new taglist($tags, $label, $classes, $limit, $pagecontext, $accesshidelabel);
+ return $this->render_from_template('core_tag/taglist', $list->export_for_template($this));
+ }
+
+ /**
+ * Renders element for inline editing of any value
+ *
+ * @param inplace_editable $element
+ * @return string
+ */
+ public function render_inplace_editable(inplace_editable $element) {
+ return $this->render_from_template('core/inplace_editable', $element->export_for_template($this));
+ }
+
+ /**
+ * Renders a bar chart.
+ *
+ * @param \core\chart_bar $chart The chart.
+ * @return string
+ */
+ public function render_chart_bar(\core\chart_bar $chart) {
+ return $this->render_chart($chart);
+ }
+
+ /**
+ * Renders a line chart.
+ *
+ * @param \core\chart_line $chart The chart.
+ * @return string
+ */
+ public function render_chart_line(\core\chart_line $chart) {
+ return $this->render_chart($chart);
+ }
+
+ /**
+ * Renders a pie chart.
+ *
+ * @param \core\chart_pie $chart The chart.
+ * @return string
+ */
+ public function render_chart_pie(\core\chart_pie $chart) {
+ return $this->render_chart($chart);
+ }
+
+ /**
+ * Renders a chart.
+ *
+ * @param \core\chart_base $chart The chart.
+ * @param bool $withtable Whether to include a data table with the chart.
+ * @return string
+ */
+ public function render_chart(\core\chart_base $chart, $withtable = true) {
+ $chartdata = json_encode($chart);
+ return $this->render_from_template('core/chart', (object) [
+ 'chartdata' => $chartdata,
+ 'withtable' => $withtable,
+ ]);
+ }
+
+ /**
+ * Renders the login form.
+ *
+ * @param \core_auth\output\login $form The renderable.
+ * @return string
+ */
+ public function render_login(\core_auth\output\login $form) {
+ global $CFG, $SITE;
+
+ $context = $form->export_for_template($this);
+
+ $context->errorformatted = $this->error_text($context->error);
+ $url = $this->get_logo_url();
+ if ($url) {
+ $url = $url->out(false);
+ }
+ $context->logourl = $url;
+ $context->sitename = format_string(
+ $SITE->fullname,
+ true,
+ ['context' => context_course::instance(SITEID), "escape" => false]
+ );
+
+ return $this->render_from_template('core/loginform', $context);
+ }
+
+ /**
+ * Renders an mform element from a template.
+ *
+ * @param HTML_QuickForm_element $element element
+ * @param bool $required if input is required field
+ * @param bool $advanced if input is an advanced field
+ * @param string $error error message to display
+ * @param bool $ingroup True if this element is rendered as part of a group
+ * @return mixed string|bool
+ */
+ public function mform_element($element, $required, $advanced, $error, $ingroup) {
+ $templatename = 'core_form/element-' . $element->getType();
+ if ($ingroup) {
+ $templatename .= "-inline";
+ }
+ try {
+ // We call this to generate a file not found exception if there is no template.
+ // We don't want to call export_for_template if there is no template.
+ mustache_template_finder::get_template_filepath($templatename);
+
+ if ($element instanceof templatable) {
+ $elementcontext = $element->export_for_template($this);
+
+ $helpbutton = '';
+ if (method_exists($element, 'getHelpButton')) {
+ $helpbutton = $element->getHelpButton();
+ }
+ $label = $element->getLabel();
+ $text = '';
+ if (method_exists($element, 'getText')) {
+ // There currently exists code that adds a form element with an empty label.
+ // If this is the case then set the label to the description.
+ if (empty($label)) {
+ $label = $element->getText();
+ } else {
+ $text = $element->getText();
+ }
+ }
+
+ // Generate the form element wrapper ids and names to pass to the template.
+ // This differs between group and non-group elements.
+ if ($element->getType() === 'group') {
+ // Group element.
+ // The id will be something like 'fgroup_id_NAME'. E.g. fgroup_id_mygroup.
+ $elementcontext['wrapperid'] = $elementcontext['id'];
+
+ // Ensure group elements pass through the group name as the element name.
+ $elementcontext['name'] = $elementcontext['groupname'];
+ } else {
+ // Non grouped element.
+ // Creates an id like 'fitem_id_NAME'. E.g. fitem_id_mytextelement.
+ $elementcontext['wrapperid'] = 'fitem_' . $elementcontext['id'];
+ }
+
+ $context = [
+ 'element' => $elementcontext,
+ 'label' => $label,
+ 'text' => $text,
+ 'required' => $required,
+ 'advanced' => $advanced,
+ 'helpbutton' => $helpbutton,
+ 'error' => $error,
+ ];
+ return $this->render_from_template($templatename, $context);
+ }
+ } catch (\Exception $e) {
+ // No template for this element.
+ return false;
+ }
+ }
+
+ /**
+ * Render the login signup form into a nice template for the theme.
+ *
+ * @param moodleform $form
+ * @return string
+ */
+ public function render_login_signup_form($form) {
+ global $SITE;
+
+ $context = $form->export_for_template($this);
+ $url = $this->get_logo_url();
+ if ($url) {
+ $url = $url->out(false);
+ }
+ $context['logourl'] = $url;
+ $context['sitename'] = format_string(
+ $SITE->fullname,
+ true,
+ ['context' => context_course::instance(SITEID), "escape" => false]
+ );
+
+ return $this->render_from_template('core/signup_form_layout', $context);
+ }
+
+ /**
+ * Render the verify age and location page into a nice template for the theme.
+ *
+ * @param \core_auth\output\verify_age_location_page $page The renderable
+ * @return string
+ */
+ protected function render_verify_age_location_page($page) {
+ $context = $page->export_for_template($this);
+
+ return $this->render_from_template('core/auth_verify_age_location_page', $context);
+ }
+
+ /**
+ * Render the digital minor contact information page into a nice template for the theme.
+ *
+ * @param \core_auth\output\digital_minor_page $page The renderable
+ * @return string
+ */
+ protected function render_digital_minor_page($page) {
+ $context = $page->export_for_template($this);
+
+ return $this->render_from_template('core/auth_digital_minor_page', $context);
+ }
+
+ /**
+ * Renders a progress bar.
+ *
+ * Do not use $OUTPUT->render($bar), instead use progress_bar::create().
+ *
+ * @param progress_bar $bar The bar.
+ * @return string HTML fragment
+ */
+ public function render_progress_bar(progress_bar $bar) {
+ $data = $bar->export_for_template($this);
+ return $this->render_from_template('core/progress_bar', $data);
+ }
+
+ /**
+ * Renders an update to a progress bar.
+ *
+ * Note: This does not cleanly map to a renderable class and should
+ * never be used directly.
+ *
+ * @param string $id
+ * @param float $percent
+ * @param string $msg Message
+ * @param string $estimate time remaining message
+ * @return string ascii fragment
+ */
+ public function render_progress_bar_update(string $id, float $percent, string $msg, string $estimate): string {
+ return html_writer::script(js_writer::function_call('updateProgressBar', [
+ $id,
+ round($percent, 1),
+ $msg,
+ $estimate,
+ ]));
+ }
+
+ /**
+ * Renders element for a toggle-all checkbox.
+ *
+ * @param checkbox_toggleall $element
+ * @return string
+ */
+ public function render_checkbox_toggleall(checkbox_toggleall $element) {
+ return $this->render_from_template($element->get_template(), $element->export_for_template($this));
+ }
+
+ /**
+ * Renders the tertiary nav for the participants page
+ *
+ * @param object $course The course we are operating within
+ * @param string|null $renderedbuttons Any additional buttons/content to be displayed in line with the nav
+ * @return string
+ */
+ public function render_participants_tertiary_nav(object $course, ?string $renderedbuttons = null) {
+ $actionbar = new participants_action_bar($course, $this->page, $renderedbuttons);
+ $content = $this->render_from_template('core_course/participants_actionbar', $actionbar->export_for_template($this));
+ return $content ?: "";
+ }
+
+ /**
+ * Renders release information in the footer popup
+ * @return ?string Moodle release info.
+ */
+ public function moodle_release() {
+ global $CFG;
+ if (!during_initial_install() && is_siteadmin()) {
+ return $CFG->release;
+ }
+ }
+
+ /**
+ * Generate the add block button when editing mode is turned on and the user can edit blocks.
+ *
+ * @param string $region where new blocks should be added.
+ * @return string html for the add block button.
+ */
+ public function addblockbutton($region = ''): string {
+ $addblockbutton = '';
+ $regions = $this->page->blocks->get_regions();
+ if (count($regions) == 0) {
+ return '';
+ }
+ if (
+ isset($this->page->theme->addblockposition) &&
+ $this->page->user_is_editing() &&
+ $this->page->user_can_edit_blocks() &&
+ $this->page->pagelayout !== 'mycourses'
+ ) {
+ $params = ['bui_addblock' => '', 'sesskey' => sesskey()];
+ if (!empty($region)) {
+ $params['bui_blockregion'] = $region;
+ }
+ $url = new moodle_url($this->page->url, $params);
+ $addblockbutton = $this->render_from_template(
+ 'core/add_block_button',
+ [
+ 'link' => $url->out(false),
+ 'escapedlink' => "?{$url->get_query_string(false)}",
+ 'pagehash' => $this->page->get_edited_page_hash(),
+ 'blockregion' => $region,
+ // The following parameters are not used since Moodle 4.2 but are
+ // still passed for backward-compatibility.
+ 'pageType' => $this->page->pagetype,
+ 'pageLayout' => $this->page->pagelayout,
+ 'subPage' => $this->page->subpage,
+ ]
+ );
+ }
+ return $addblockbutton;
+ }
+
+ /**
+ * Prepares an element for streaming output
+ *
+ * This must be used with NO_OUTPUT_BUFFERING set to true. After using this method
+ * any subsequent prints or echos to STDOUT result in the outputted content magically
+ * being appended inside that element rather than where the current html would be
+ * normally. This enables pages which take some time to render incremental content to
+ * first output a fully formed html page, including the footer, and to then stream
+ * into an element such as the main content div. This fixes a class of page layout
+ * bugs and reduces layout shift issues and was inspired by Facebook BigPipe.
+ *
+ * Some use cases such as a simple page which loads content via ajax could be swapped
+ * to this method wich saves another http request and its network latency resulting
+ * in both lower server load and better front end performance.
+ *
+ * You should consider giving the element you stream into a minimum height to further
+ * reduce layout shift as the content initally streams into the element.
+ *
+ * You can safely finish the output without closing the streamed element. You can also
+ * call this method again to swap the target of the streaming to a new element as
+ * often as you want.
+
+ * https://www.youtube.com/watch?v=LLRig4s1_yA&t=1022s
+ * Watch this video segment to explain how and why this 'One Weird Trick' works.
+ *
+ * @param string $selector where new content should be appended
+ * @param string $element which contains the streamed content
+ * @return string html to be written
+ */
+ public function select_element_for_append(string $selector = '#region-main [role=main]', string $element = 'div') {
+
+ if (!CLI_SCRIPT && !NO_OUTPUT_BUFFERING) {
+ throw new coding_exception(
+ 'select_element_for_append used in a non-CLI script without setting NO_OUTPUT_BUFFERING.',
+ DEBUG_DEVELOPER
+ );
+ }
+
+ // We are already streaming into this element so don't change anything.
+ if ($this->currentselector === $selector && $this->currentelement === $element) {
+ return;
+ }
+
+ // If we have a streaming element close it before starting a new one.
+ $html = $this->close_element_for_append();
+
+ $this->currentselector = $selector;
+ $this->currentelement = $element;
+
+ // Create an unclosed element for the streamed content to append into.
+ $id = uniqid();
+ $html .= html_writer::start_tag($element, ['id' => $id]);
+ $html .= html_writer::tag('script', "document.querySelector('$selector').append(document.getElementById('$id'))");
+ $html .= "\n";
+ return $html;
+ }
+
+ /**
+ * This closes any opened stream elements
+ *
+ * @return string html to be written
+ */
+ public function close_element_for_append() {
+ $html = '';
+ if ($this->currentselector !== '') {
+ $html .= html_writer::end_tag($this->currentelement);
+ $html .= "\n";
+ $this->currentelement = '';
+ }
+ return $html;
+ }
+
+ /**
+ * A companion method to select_element_for_append
+ *
+ * This must be used with NO_OUTPUT_BUFFERING set to true.
+ *
+ * This is similar but instead of appending into the element it replaces
+ * the content in the element. Depending on the 3rd argument it can replace
+ * the innerHTML or the outerHTML which can be useful to completely remove
+ * the element if needed.
+ *
+ * @param string $selector where new content should be replaced
+ * @param string $html A chunk of well formed html
+ * @param bool $outer Wether it replaces the innerHTML or the outerHTML
+ * @return string html to be written
+ */
+ public function select_element_for_replace(string $selector, string $html, bool $outer = false) {
+
+ if (!CLI_SCRIPT && !NO_OUTPUT_BUFFERING) {
+ throw new coding_exception(
+ 'select_element_for_replace used in a non-CLI script without setting NO_OUTPUT_BUFFERING.',
+ DEBUG_DEVELOPER
+ );
+ }
+
+ // Escape html for use inside a javascript string.
+ $html = addslashes_js($html);
+ $property = $outer ? 'outerHTML' : 'innerHTML';
+ $output = html_writer::tag('script', "document.querySelector('$selector').$property = '$html';");
+ $output .= "\n";
+ return $output;
+ }
+}
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(core_renderer::class, \core_renderer::class);
diff --git a/lib/classes/output/core_renderer_ajax.php b/lib/classes/output/core_renderer_ajax.php
new file mode 100644
index 0000000000000..41c9786c45429
--- /dev/null
+++ b/lib/classes/output/core_renderer_ajax.php
@@ -0,0 +1,154 @@
+.
+
+namespace core\output;
+
+use core_useragent;
+use moodle_url;
+use stdClass;
+
+/**
+ * A renderer that generates output for ajax scripts.
+ *
+ * This renderer prevents accidental sends back only json
+ * encoded error messages, all other output is ignored.
+ *
+ * @copyright 2010 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class core_renderer_ajax extends core_renderer {
+ /**
+ * Returns a template fragment representing a fatal error.
+ *
+ * @param string $message The message to output
+ * @param string $moreinfourl URL where more info can be found about the error
+ * @param string $link Link for the Continue button
+ * @param array $backtrace The execution backtrace
+ * @param null|string $debuginfo Debugging information
+ * @param string $errorcode
+ * @return string A template fragment for a fatal error
+ */
+ public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
+ global $CFG;
+
+ // Ugly hack - make sure page context is set to something, we do not want bogus warnings here.
+ $this->page->set_context(null);
+
+ $e = new stdClass();
+ $e->error = $message;
+ $e->errorcode = $errorcode;
+ $e->stacktrace = null;
+ $e->debuginfo = null;
+ $e->reproductionlink = null;
+ if (!empty($CFG->debug) && $CFG->debug >= DEBUG_DEVELOPER) {
+ $link = (string) $link;
+ if ($link) {
+ $e->reproductionlink = $link;
+ }
+ if (!empty($debuginfo)) {
+ $e->debuginfo = $debuginfo;
+ }
+ if (!empty($backtrace)) {
+ $e->stacktrace = format_backtrace($backtrace, true);
+ }
+ }
+ $this->header();
+ return json_encode($e);
+ }
+
+ /**
+ * Used to display a notification.
+ * For the AJAX notifications are discarded.
+ *
+ * @param string $message The message to print out.
+ * @param string $type The type of notification. See constants on \core\output\notification.
+ * @param bool $closebutton Whether to show a close icon to remove the notification (default true).
+ */
+ public function notification($message, $type = null, $closebutton = true) {
+ }
+
+ /**
+ * Used to display a redirection message.
+ * AJAX redirections should not occur and as such redirection messages
+ * are discarded.
+ *
+ * @param moodle_url|string $encodedurl
+ * @param string $message
+ * @param int $delay
+ * @param bool $debugdisableredirect
+ * @param string $messagetype The type of notification to show the message in.
+ * See constants on \core\output\notification.
+ */
+ public function redirect_message(
+ $encodedurl,
+ $message,
+ $delay,
+ $debugdisableredirect,
+ $messagetype = notification::NOTIFY_INFO,
+ ) {
+ }
+
+ /**
+ * Prepares the start of an AJAX output.
+ */
+ public function header() {
+ // Unfortunately YUI iframe upload does not support application/json.
+ if (!empty($_FILES)) {
+ @header('Content-type: text/plain; charset=utf-8');
+ if (!core_useragent::supports_json_contenttype()) {
+ @header('X-Content-Type-Options: nosniff');
+ }
+ } else if (!core_useragent::supports_json_contenttype()) {
+ @header('Content-type: text/plain; charset=utf-8');
+ @header('X-Content-Type-Options: nosniff');
+ } else {
+ @header('Content-type: application/json; charset=utf-8');
+ }
+
+ // Headers to make it not cacheable and json.
+ @header('Cache-Control: no-store, no-cache, must-revalidate');
+ @header('Cache-Control: post-check=0, pre-check=0', false);
+ @header('Pragma: no-cache');
+ @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
+ @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
+ @header('Accept-Ranges: none');
+ }
+
+ /**
+ * There is no footer for an AJAX request, however we must override the
+ * footer method to prevent the default footer.
+ */
+ public function footer() {
+ }
+
+ /**
+ * No need for headers in an AJAX request... this should never happen.
+ * @param string $text
+ * @param int $level
+ * @param string $classes
+ * @param string $id
+ */
+ public function heading($text, $level = 2, $classes = 'main', $id = null) {
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(core_renderer_ajax::class, \core_renderer_ajax::class);
diff --git a/lib/classes/output/core_renderer_cli.php b/lib/classes/output/core_renderer_cli.php
new file mode 100644
index 0000000000000..d277966bd2a44
--- /dev/null
+++ b/lib/classes/output/core_renderer_cli.php
@@ -0,0 +1,260 @@
+.
+
+namespace core\output;
+
+use core_text;
+use core\check\result as check_result;
+
+/**
+ * A renderer that generates output for command-line scripts.
+ *
+ * The implementation of this renderer is probably incomplete.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class core_renderer_cli extends core_renderer {
+ /**
+ * @var array $progressmaximums stores the largest percentage for a progress bar.
+ */
+ private $progressmaximums = [];
+
+ /**
+ * Returns the page header.
+ *
+ * @return string HTML fragment
+ */
+ public function header() {
+ return $this->page->heading . "\n";
+ }
+
+ /**
+ * Renders a Check API result
+ *
+ * To aid in CLI consistency this status is NOT translated and the visual
+ * width is always exactly 10 chars.
+ *
+ * @param check_result $result
+ * @return string HTML fragment
+ */
+ protected function render_check_result(check_result $result) {
+ $status = $result->get_status();
+
+ $labels = [
+ check_result::NA => ' ' . cli_ansi_format('') . ' NA ',
+ check_result::OK => ' ' . cli_ansi_format('') . ' OK ',
+ check_result::INFO => ' ' . cli_ansi_format('') . ' INFO ',
+ check_result::UNKNOWN => ' ' . cli_ansi_format('') . ' UNKNOWN ',
+ check_result::WARNING => ' ' . cli_ansi_format('') . ' WARNING ',
+ check_result::ERROR => ' ' . cli_ansi_format('') . ' ERROR ',
+ check_result::CRITICAL => '' . cli_ansi_format('') . ' CRITICAL ',
+ ];
+ $string = $labels[$status] . cli_ansi_format('');
+ return $string;
+ }
+
+ /**
+ * Renders a Check API result
+ *
+ * @param check_result $result
+ * @return string fragment
+ */
+ public function check_result(check_result $result) {
+ return $this->render_check_result($result);
+ }
+
+ /**
+ * Renders a progress bar.
+ *
+ * Do not use $OUTPUT->render($bar), instead use progress_bar::create().
+ *
+ * @param progress_bar $bar The bar.
+ * @return string ascii fragment
+ */
+ public function render_progress_bar(progress_bar $bar) {
+ global $CFG;
+
+ $size = 55; // The width of the progress bar in chars.
+ $ascii = "\n";
+
+ if (stream_isatty(STDOUT)) {
+ require_once($CFG->libdir . '/clilib.php');
+
+ $ascii .= "[" . str_repeat(' ', $size) . "] 0% \n";
+ return cli_ansi_format($ascii);
+ }
+
+ $this->progressmaximums[$bar->get_id()] = 0;
+ $ascii .= '[';
+ return $ascii;
+ }
+
+ /**
+ * Renders an update to a progress bar.
+ *
+ * Note: This does not cleanly map to a renderable class and should
+ * never be used directly.
+ *
+ * @param string $id
+ * @param float $percent
+ * @param string $msg Message
+ * @param string $estimate time remaining message
+ * @return string ascii fragment
+ */
+ public function render_progress_bar_update(string $id, float $percent, string $msg, string $estimate): string {
+ $size = 55; // The width of the progress bar in chars.
+ $ascii = '';
+
+ // If we are rendering to a terminal then we can safely use ansii codes
+ // to move the cursor and redraw the complete progress bar each time
+ // it is updated.
+ if (stream_isatty(STDOUT)) {
+ $colour = $percent == 100 ? 'green' : 'blue';
+
+ $done = $percent * $size * 0.01;
+ $whole = floor($done);
+ $bar = "";
+ $bar .= str_repeat('█', $whole);
+
+ if ($whole < $size) {
+ // By using unicode chars for partial blocks we can have higher
+ // precision progress bar.
+ $fraction = floor(($done - $whole) * 8);
+ $bar .= core_text::substr(' ▏▎▍▌▋▊▉', $fraction, 1);
+
+ // Fill the rest of the empty bar.
+ $bar .= str_repeat(' ', $size - $whole - 1);
+ }
+
+ $bar .= '';
+
+ if ($estimate) {
+ $estimate = "- $estimate";
+ }
+
+ $ascii .= '';
+ $ascii .= '';
+ $ascii .= sprintf("[$bar] %3.1f%% %-22s\n", $percent, $estimate);
+ $ascii .= sprintf("%-80s\n", $msg);
+ return cli_ansi_format($ascii);
+ }
+
+ // If we are not rendering to a tty, ie when piped to another command
+ // or on windows we need to progressively render the progress bar
+ // which can only ever go forwards.
+ $done = round($percent * $size * 0.01);
+ $delta = max(0, $done - $this->progressmaximums[$id]);
+
+ $ascii .= str_repeat('#', $delta);
+ if ($percent >= 100 && $delta > 0) {
+ $ascii .= sprintf("] %3.1f%%", $percent) . "\n$msg\n";
+ }
+ $this->progressmaximums[$id] += $delta;
+ return $ascii;
+ }
+
+ /**
+ * Returns a template fragment representing a Heading.
+ *
+ * @param string $text The text of the heading
+ * @param int $level The level of importance of the heading
+ * @param string $classes A space-separated list of CSS classes
+ * @param string $id An optional ID
+ * @return string A template fragment for a heading
+ */
+ public function heading($text, $level = 2, $classes = 'main', $id = null) {
+ $text .= "\n";
+ switch ($level) {
+ case 1:
+ return '=>' . $text;
+ case 2:
+ return '-->' . $text;
+ default:
+ return $text;
+ }
+ }
+
+ /**
+ * Returns a template fragment representing a fatal error.
+ *
+ * @param string $message The message to output
+ * @param string $moreinfourl URL where more info can be found about the error
+ * @param string $link Link for the Continue button
+ * @param array $backtrace The execution backtrace
+ * @param null|string $debuginfo Debugging information
+ * @param string $errorcode
+ * @return string A template fragment for a fatal error
+ */
+ public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
+ global $CFG;
+
+ $output = "!!! $message !!!\n";
+
+ if ($CFG->debugdeveloper) {
+ if (!empty($debuginfo)) {
+ $output .= $this->notification($debuginfo, 'notifytiny');
+ }
+ if (!empty($backtrace)) {
+ $output .= $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
+ }
+ }
+
+ return $output;
+ }
+
+ /**
+ * Returns a template fragment representing a notification.
+ *
+ * @param string $message The message to print out.
+ * @param string $type The type of notification. See constants on \core\output\notification.
+ * @param bool $closebutton Whether to show a close icon to remove the notification (default true).
+ * @return string A template fragment for a notification
+ */
+ public function notification($message, $type = null, $closebutton = true) {
+ $message = clean_text($message);
+ if ($type === 'notifysuccess' || $type === 'success') {
+ return "++ $message ++\n";
+ }
+ return "!! $message !!\n";
+ }
+
+ /**
+ * There is no footer for a cli request, however we must override the
+ * footer method to prevent the default footer.
+ */
+ public function footer() {
+ }
+
+ /**
+ * Render a notification (that is, a status message about something that has
+ * just happened).
+ *
+ * @param notification $notification the notification to print out
+ * @return string plain text output
+ */
+ public function render_notification(notification $notification) {
+ return $this->notification($notification->get_message(), $notification->get_message_type());
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(core_renderer_cli::class, \core_renderer_cli::class);
diff --git a/lib/classes/output/core_renderer_maintenance.php b/lib/classes/output/core_renderer_maintenance.php
new file mode 100644
index 0000000000000..50b4153cb95e6
--- /dev/null
+++ b/lib/classes/output/core_renderer_maintenance.php
@@ -0,0 +1,250 @@
+.
+
+namespace core\output;
+
+use core_block\output\block_contents;
+use core\exception\coding_exception;
+use moodle_page;
+use moodle_url;
+use stdClass;
+
+/**
+ * The maintenance renderer.
+ *
+ * The purpose of this renderer is to block out the core renderer methods that are not usable when the site
+ * is running a maintenance related task.
+ * It must always extend the core_renderer as we switch from the core_renderer to this renderer in a couple of places.
+ *
+ * @since Moodle 2.6
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_renderer_maintenance extends core_renderer {
+ /**
+ * Initialises the renderer instance.
+ *
+ * @param moodle_page $page
+ * @param string $target
+ * @throws coding_exception
+ */
+ public function __construct(moodle_page $page, $target) {
+ if ($target !== RENDERER_TARGET_MAINTENANCE || $page->pagelayout !== 'maintenance') {
+ throw new coding_exception('Invalid request for the maintenance renderer.');
+ }
+ parent::__construct($page, $target);
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce blocks.
+ *
+ * @param block_contents $bc
+ * @param string $region
+ * @return string
+ */
+ public function block(block_contents $bc, $region) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce blocks.
+ *
+ * @param string $region
+ * @param array $classes
+ * @param string $tag
+ * @param boolean $fakeblocksonly
+ * @return string
+ */
+ public function blocks($region, $classes = [], $tag = 'aside', $fakeblocksonly = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce blocks.
+ *
+ * @param string $region
+ * @param boolean $fakeblocksonly Output fake block only.
+ * @return string
+ */
+ public function blocks_for_region($region, $fakeblocksonly = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course content header.
+ *
+ * @param bool $onlyifnotcalledbefore
+ * @return string
+ */
+ public function course_content_header($onlyifnotcalledbefore = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course content footer.
+ *
+ * @param bool $onlyifnotcalledbefore
+ * @return string
+ */
+ public function course_content_footer($onlyifnotcalledbefore = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course header.
+ *
+ * @return string
+ */
+ public function course_header() {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course footer.
+ *
+ * @return string
+ */
+ public function course_footer() {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a custom menu.
+ *
+ * @param string $custommenuitems
+ * @return string
+ */
+ public function custom_menu($custommenuitems = '') {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a file picker.
+ *
+ * @param array $options
+ * @return string
+ */
+ public function file_picker($options) {
+ return '';
+ }
+
+ /**
+ * Overridden confirm message for upgrades.
+ *
+ * @param string $message The question to ask the user
+ * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer.
+ * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer.
+ * @param array $displayoptions optional extra display options
+ * @return string HTML fragment
+ */
+ public function confirm($message, $continue, $cancel, array $displayoptions = []) {
+ // We need plain styling of confirm boxes on upgrade because we don't know which stylesheet we have (it could be
+ // from any previous version of Moodle).
+ if ($continue instanceof single_button) {
+ $continue->type = single_button::BUTTON_PRIMARY;
+ } else if (is_string($continue)) {
+ $continue = new single_button(
+ new moodle_url($continue),
+ get_string('continue'),
+ 'post',
+ $displayoptions['type'] ?? single_button::BUTTON_PRIMARY
+ );
+ } else if ($continue instanceof moodle_url) {
+ $continue = new single_button(
+ $continue,
+ get_string('continue'),
+ 'post',
+ $displayoptions['type'] ?? single_button::BUTTON_PRIMARY
+ );
+ } else {
+ throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL' .
+ ' (string/moodle_url) or a single_button instance.');
+ }
+
+ if ($cancel instanceof single_button) {
+ $output = '';
+ } else if (is_string($cancel)) {
+ $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
+ } else if ($cancel instanceof moodle_url) {
+ $cancel = new single_button($cancel, get_string('cancel'), 'get');
+ } else {
+ throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL' .
+ ' (string/moodle_url) or a single_button instance.');
+ }
+
+ $output = $this->box_start('generalbox', 'notice');
+ $output .= html_writer::tag('h4', get_string('confirm'));
+ $output .= html_writer::tag('p', $message);
+ $output .= html_writer::tag('div', $this->render($cancel) . $this->render($continue), ['class' => 'buttons']);
+ $output .= $this->box_end();
+ return $output;
+ }
+
+ /**
+ * Does nothing. The maintenance renderer does not support JS.
+ *
+ * @param block_contents $bc
+ */
+ public function init_block_hider_js(block_contents $bc) {
+ // Does nothing.
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce language menus.
+ *
+ * @return string
+ */
+ public function lang_menu() {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer has no need for login information.
+ *
+ * @param mixed $withlinks
+ * @return string
+ */
+ public function login_info($withlinks = null) {
+ return '';
+ }
+
+ /**
+ * Secure login info.
+ *
+ * @return string
+ */
+ public function secure_login_info() {
+ return $this->login_info(false);
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce user pictures.
+ *
+ * @param stdClass $user
+ * @param null|array $options
+ * @return string
+ */
+ public function user_picture(stdClass $user, ?array $options = null) {
+ return '';
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(core_renderer_maintenance::class, \core_renderer_maintenance::class);
diff --git a/lib/classes/output/custom_menu.php b/lib/classes/output/custom_menu.php
new file mode 100644
index 0000000000000..5357df2b78d03
--- /dev/null
+++ b/lib/classes/output/custom_menu.php
@@ -0,0 +1,188 @@
+.
+
+namespace core\output;
+
+use core\exception\moodle_exception;
+use moodle_url;
+
+/**
+ * Custom menu class
+ *
+ * This class is used to operate a custom menu that can be rendered for the page.
+ * The custom menu is built using $CFG->custommenuitems and is a structured collection
+ * of custom_menu_item nodes that can be rendered by the core renderer.
+ *
+ * To configure the custom menu:
+ * Settings: Administration > Appearance > Advanced theme settings
+ *
+ * @copyright 2010 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class custom_menu extends custom_menu_item {
+ /**
+ * @var string The language we should render for, null disables multilang support.
+ */
+ protected $currentlanguage = null;
+
+ /**
+ * Creates the custom menu
+ *
+ * @param string $definition the menu items definition in syntax required by {@see convert_text_to_menu_nodes()}
+ * @param string $currentlanguage the current language code, null disables multilang support
+ */
+ public function __construct($definition = '', $currentlanguage = null) {
+ $this->currentlanguage = $currentlanguage;
+ parent::__construct('root'); // create virtual root element of the menu
+ if (!empty($definition)) {
+ $this->override_children(self::convert_text_to_menu_nodes($definition, $currentlanguage));
+ }
+ }
+
+ /**
+ * Overrides the children of this custom menu. Useful when getting children
+ * from $CFG->custommenuitems
+ *
+ * @param array $children
+ */
+ public function override_children(array $children) {
+ $this->children = [];
+ foreach ($children as $child) {
+ if ($child instanceof custom_menu_item) {
+ $this->children[] = $child;
+ }
+ }
+ }
+
+ /**
+ * Converts a string into a structured array of custom_menu_items which can
+ * then be added to a custom menu.
+ *
+ * Structure:
+ * text|url|title|langs
+ * The number of hyphens at the start determines the depth of the item. The
+ * languages are optional, comma separated list of languages the line is for.
+ *
+ * Example structure:
+ * First level first item|http://www.moodle.com/
+ * -Second level first item|http://www.moodle.com/partners/
+ * -Second level second item|http://www.moodle.com/hq/
+ * --Third level first item|http://www.moodle.com/jobs/
+ * -Second level third item|http://www.moodle.com/development/
+ * First level second item|http://www.moodle.com/feedback/
+ * First level third item
+ * English only|http://moodle.com|English only item|en
+ * German only|http://moodle.de|Deutsch|de,de_du,de_kids
+ *
+ *
+ * @static
+ * @param string $text the menu items definition
+ * @param string $language the language code, null disables multilang support
+ * @return array
+ */
+ public static function convert_text_to_menu_nodes($text, $language = null) {
+ $root = new custom_menu();
+ $lastitem = $root;
+ $lastdepth = 0;
+ $hiddenitems = [];
+ $lines = explode("\n", $text);
+ foreach ($lines as $linenumber => $line) {
+ $line = trim($line);
+ if (strlen($line) == 0) {
+ continue;
+ }
+ // Parse item settings.
+ $itemtext = null;
+ $itemurl = null;
+ $itemtitle = null;
+ $itemvisible = true;
+ $settings = explode('|', $line);
+ foreach ($settings as $i => $setting) {
+ $setting = trim($setting);
+ if ($setting !== '') {
+ switch ($i) {
+ case 0: // Menu text.
+ $itemtext = ltrim($setting, '-');
+ break;
+ case 1: // URL.
+ try {
+ $itemurl = new moodle_url($setting);
+ } catch (moodle_exception $exception) {
+ // We're not actually worried about this, we don't want to mess up the display
+ // just for a wrongly entered URL.
+ $itemurl = null;
+ }
+ break;
+ case 2: // Title attribute.
+ $itemtitle = $setting;
+ break;
+ case 3: // Language.
+ if (!empty($language)) {
+ $itemlanguages = array_map('trim', explode(',', $setting));
+ $itemvisible &= in_array($language, $itemlanguages);
+ }
+ break;
+ }
+ }
+ }
+ // Get depth of new item.
+ preg_match('/^(\-*)/', $line, $match);
+ $itemdepth = strlen($match[1]) + 1;
+ // Find parent item for new item.
+ while (($lastdepth - $itemdepth) >= 0) {
+ $lastitem = $lastitem->get_parent();
+ $lastdepth--;
+ }
+ $lastitem = $lastitem->add($itemtext, $itemurl, $itemtitle, $linenumber + 1);
+ $lastdepth++;
+ if (!$itemvisible) {
+ $hiddenitems[] = $lastitem;
+ }
+ }
+ foreach ($hiddenitems as $item) {
+ $item->parent->remove_child($item);
+ }
+ return $root->get_children();
+ }
+
+ /**
+ * Sorts two custom menu items
+ *
+ * This function is designed to be used with the usort method
+ * usort($this->children, array('custom_menu','sort_custom_menu_items'));
+ *
+ * @static
+ * @param custom_menu_item $itema
+ * @param custom_menu_item $itemb
+ * @return int
+ */
+ public static function sort_custom_menu_items(custom_menu_item $itema, custom_menu_item $itemb) {
+ $itema = $itema->get_sort_order();
+ $itemb = $itemb->get_sort_order();
+ if ($itema == $itemb) {
+ return 0;
+ }
+ return ($itema > $itemb) ? +1 : -1;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(custom_menu::class, \custom_menu::class);
diff --git a/lib/classes/output/custom_menu_item.php b/lib/classes/output/custom_menu_item.php
new file mode 100644
index 0000000000000..c1e1a389530fc
--- /dev/null
+++ b/lib/classes/output/custom_menu_item.php
@@ -0,0 +1,272 @@
+.
+
+namespace core\output;
+
+use core\context\system as context_system;
+use moodle_url;
+use stdClass;
+
+/**
+ * Custom menu item
+ *
+ * This class is used to represent one item within a custom menu that may or may
+ * not have children.
+ *
+ * @copyright 2010 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class custom_menu_item implements renderable, templatable {
+ /**
+ * @var string The text to show for the item
+ */
+ protected $text;
+
+ /**
+ * @var string A title to apply to the item. By default the text
+ */
+ protected $title;
+
+ /**
+ * @var int A sort order for the item, not necessary if you order things in
+ * the CFG var.
+ */
+ protected $sort;
+
+ /**
+ * @var array A array in which to store children this item has.
+ */
+ protected $children = [];
+
+ /**
+ * @var int A reference to the sort var of the last child that was added
+ */
+ protected $lastsort = 0;
+
+ /**
+ * Constructs the new custom menu item
+ *
+ * @param string $text
+ * @param null|moodle_url $url A moodle url to apply as the link for this item [Optional]
+ * @param string $title A title to apply to this item [Optional]
+ * @param int $sort A sort or to use if we need to sort differently [Optional]
+ * @param null|custom_menu_item $parent A reference to the parent custom_menu_item this child
+ * belongs to, only if the child has a parent. [Optional]
+ * @param array $attributes Array of other HTML attributes for the custom menu item.
+ */
+ public function __construct(
+ $text,
+ /** @var moodle_url The link to give the icon if it has no children */
+ protected ?moodle_url $url = null,
+ $title = null,
+ $sort = null,
+ /**
+ * @var custom_menu_item A reference to the parent for this item or NULL if
+ * it is a top level item
+ */
+ protected ?custom_menu_item $parent = null,
+ /** @var array Array of other HTML attributes for the custom menu item. */
+ protected array $attributes = [],
+ ) {
+
+ // Use class setter method for text to ensure it's always a string type.
+ $this->set_text($text);
+
+ $this->title = $title;
+ $this->sort = (int)$sort;
+ }
+
+ /**
+ * Adds a custom menu item as a child of this node given its properties.
+ *
+ * @param string $text
+ * @param null|moodle_url $url
+ * @param string $title
+ * @param int $sort
+ * @param array $attributes Array of other HTML attributes for the custom menu item.
+ * @return custom_menu_item
+ */
+ public function add(
+ $text,
+ ?moodle_url $url = null,
+ $title = null,
+ $sort = null,
+ $attributes = [],
+ ) {
+ $key = count($this->children);
+ if (empty($sort)) {
+ $sort = $this->lastsort + 1;
+ }
+ $this->children[$key] = new custom_menu_item($text, $url, $title, $sort, $this, $attributes);
+ $this->lastsort = (int)$sort;
+ return $this->children[$key];
+ }
+
+ /**
+ * Removes a custom menu item that is a child or descendant to the current menu.
+ *
+ * Returns true if child was found and removed.
+ *
+ * @param custom_menu_item $menuitem
+ * @return bool
+ */
+ public function remove_child(custom_menu_item $menuitem) {
+ $removed = false;
+ if (($key = array_search($menuitem, $this->children)) !== false) {
+ unset($this->children[$key]);
+ $this->children = array_values($this->children);
+ $removed = true;
+ } else {
+ foreach ($this->children as $child) {
+ if ($removed = $child->remove_child($menuitem)) {
+ break;
+ }
+ }
+ }
+ return $removed;
+ }
+
+ /**
+ * Returns the text for this item
+ * @return string
+ */
+ public function get_text() {
+ return $this->text;
+ }
+
+ /**
+ * Returns the url for this item
+ * @return moodle_url
+ */
+ public function get_url() {
+ return $this->url;
+ }
+
+ /**
+ * Returns the title for this item
+ * @return string
+ */
+ public function get_title() {
+ return $this->title;
+ }
+
+ /**
+ * Sorts and returns the children for this item
+ * @return array
+ */
+ public function get_children() {
+ $this->sort();
+ return $this->children;
+ }
+
+ /**
+ * Gets the sort order for this child
+ * @return int
+ */
+ public function get_sort_order() {
+ return $this->sort;
+ }
+
+ /**
+ * Gets the parent this child belong to
+ * @return custom_menu_item
+ */
+ public function get_parent() {
+ return $this->parent;
+ }
+
+ /**
+ * Sorts the children this item has
+ */
+ public function sort() {
+ usort($this->children, ['custom_menu', 'sort_custom_menu_items']);
+ }
+
+ /**
+ * Returns true if this item has any children
+ * @return bool
+ */
+ public function has_children() {
+ return (count($this->children) > 0);
+ }
+
+ /**
+ * Sets the text for the node
+ * @param string $text
+ */
+ public function set_text($text) {
+ $this->text = (string)$text;
+ }
+
+ /**
+ * Sets the title for the node
+ * @param string $title
+ */
+ public function set_title($title) {
+ $this->title = (string)$title;
+ }
+
+ /**
+ * Sets the url for the node
+ * @param moodle_url $url
+ */
+ public function set_url(moodle_url $url) {
+ $this->url = $url;
+ }
+
+ /**
+ * Export this data so it can be used as the context for a mustache template.
+ *
+ * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $syscontext = context_system::instance();
+
+ $context = new stdClass();
+ $context->moremenuid = uniqid();
+ $context->text = \core_external\util::format_string($this->text, $syscontext->id);
+ $context->url = $this->url ? $this->url->out() : null;
+ // No need for the title if it's the same with text.
+ if ($this->text !== $this->title) {
+ // Show the title attribute only if it's different from the text.
+ $context->title = \core_external\util::format_string($this->title, $syscontext->id);
+ }
+ $context->sort = $this->sort;
+ if (!empty($this->attributes)) {
+ $context->attributes = $this->attributes;
+ }
+ $context->children = [];
+ if (preg_match("/^#+$/", $this->text)) {
+ $context->divider = true;
+ }
+ $context->haschildren = !empty($this->children) && (count($this->children) > 0);
+ foreach ($this->children as $child) {
+ $child = $child->export_for_template($output);
+ array_push($context->children, $child);
+ }
+
+ return $context;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(custom_menu_item::class, \custom_menu_item::class);
diff --git a/lib/classes/output/datafilter.php b/lib/classes/output/datafilter.php
index ea28136d45ba1..e8cef3acf2dfe 100644
--- a/lib/classes/output/datafilter.php
+++ b/lib/classes/output/datafilter.php
@@ -16,10 +16,8 @@
namespace core\output;
-use context;
-use renderable;
+use core\context;
use stdClass;
-use templatable;
/**
* The filter renderable class.
@@ -30,7 +28,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class datafilter implements renderable, templatable {
-
/** @var int None of the following match */
public const JOINTYPE_NONE = 0;
@@ -110,7 +107,7 @@ protected function get_filter_object(
'values' => $values,
'filteroptions' => $filteroptions,
'required' => $required,
- 'joinlist' => json_encode($joinlist)
+ 'joinlist' => json_encode($joinlist),
];
}
}
diff --git a/lib/classes/output/dynamic_tabs.php b/lib/classes/output/dynamic_tabs.php
index c2592bb8134d4..c739934b0d190 100644
--- a/lib/classes/output/dynamic_tabs.php
+++ b/lib/classes/output/dynamic_tabs.php
@@ -19,8 +19,6 @@
namespace core\output;
use core\output\dynamic_tabs\base;
-use renderer_base;
-use templatable;
/**
* Class dynamic tabs
@@ -30,7 +28,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class dynamic_tabs implements templatable {
-
/** @var base[] */
protected $tabs = [];
@@ -62,7 +59,7 @@ public function add_tab(base $tab): void {
*/
public function export_for_template(renderer_base $output): array {
$data = [
- 'tabs' => []
+ 'tabs' => [],
];
foreach ($this->tabs as $tab) {
diff --git a/lib/classes/output/dynamic_tabs/base.php b/lib/classes/output/dynamic_tabs/base.php
index 2396ee645ec3b..213148be34bb0 100644
--- a/lib/classes/output/dynamic_tabs/base.php
+++ b/lib/classes/output/dynamic_tabs/base.php
@@ -18,8 +18,8 @@
namespace core\output\dynamic_tabs;
-use moodle_exception;
-use templatable;
+use core\exception\moodle_exception;
+use core\output\templatable;
/**
* Class tab_base
@@ -29,7 +29,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class base implements templatable {
-
/** @var array */
protected $data;
diff --git a/lib/classes/output/external.php b/lib/classes/output/external.php
index b9c24e049c3c2..181faf9d6caa1 100644
--- a/lib/classes/output/external.php
+++ b/lib/classes/output/external.php
@@ -39,13 +39,12 @@ class external extends external_api {
* @return external_function_parameters
*/
public static function load_template_parameters() {
- return new external_function_parameters(
- array('component' => new external_value(PARAM_COMPONENT, 'component containing the template'),
- 'template' => new external_value(PARAM_SAFEPATH, 'name of the template'),
- 'themename' => new external_value(PARAM_ALPHANUMEXT, 'The current theme.'),
- 'includecomments' => new external_value(PARAM_BOOL, 'Include comments or not', VALUE_DEFAULT, false)
- )
- );
+ return new external_function_parameters([
+ 'component' => new external_value(PARAM_COMPONENT, 'component containing the template'),
+ 'template' => new external_value(PARAM_SAFEPATH, 'name of the template'),
+ 'themename' => new external_value(PARAM_ALPHANUMEXT, 'The current theme.'),
+ 'includecomments' => new external_value(PARAM_BOOL, 'Include comments or not', VALUE_DEFAULT, false),
+ ]);
}
/**
@@ -60,11 +59,15 @@ public static function load_template($component, $template, $themename, $include
global $DB, $CFG, $PAGE;
$PAGE->set_context(context_system::instance());
- $params = self::validate_parameters(self::load_template_parameters(),
- array('component' => $component,
- 'template' => $template,
- 'themename' => $themename,
- 'includecomments' => $includecomments));
+ $params = self::validate_parameters(
+ self::load_template_parameters(),
+ [
+ 'component' => $component,
+ 'template' => $template,
+ 'themename' => $themename,
+ 'includecomments' => $includecomments,
+ ],
+ );
$loader = new mustache_template_source_loader();
// Will throw exceptions if the template does not exist.
@@ -72,7 +75,7 @@ public static function load_template($component, $template, $themename, $include
$params['component'],
$params['template'],
$params['themename'],
- $params['includecomments']
+ $params['includecomments'],
);
}
@@ -108,7 +111,7 @@ public static function load_template_with_dependencies_parameters() {
* @param string $themename The name of the current theme.
* @param bool $includecomments Whether to strip comments from the template source.
* @param string $lang moodle translation language, null means use current.
- * @return string the template
+ * @return array the template
*/
public static function load_template_with_dependencies(
string $component,
@@ -126,7 +129,7 @@ public static function load_template_with_dependencies(
'template' => $template,
'themename' => $themename,
'includecomments' => $includecomments,
- 'lang' => $lang
+ 'lang' => $lang,
]
);
@@ -141,14 +144,14 @@ public static function load_template_with_dependencies(
[],
$params['lang']
);
- $formatdependencies = function($dependency) {
+ $formatdependencies = function ($dependency) {
$results = [];
foreach ($dependency as $dependencycomponent => $dependencyvalues) {
foreach ($dependencyvalues as $dependencyname => $dependencyvalue) {
array_push($results, [
'component' => $dependencycomponent,
'name' => $dependencyname,
- 'value' => $dependencyvalue
+ 'value' => $dependencyvalue,
]);
}
}
@@ -159,7 +162,7 @@ public static function load_template_with_dependencies(
// by external functions (because they don't support dynamic keys).
return [
'templates' => $formatdependencies($dependencies['templates']),
- 'strings' => $formatdependencies($dependencies['strings'])
+ 'strings' => $formatdependencies($dependencies['strings']),
];
}
@@ -172,12 +175,12 @@ public static function load_template_with_dependencies_returns() {
$resourcestructure = new external_single_structure([
'component' => new external_value(PARAM_COMPONENT, 'component containing the resource'),
'name' => new external_value(PARAM_TEXT, 'name of the resource'),
- 'value' => new external_value(PARAM_RAW, 'resource value')
+ 'value' => new external_value(PARAM_RAW, 'resource value'),
]);
return new external_single_structure([
'templates' => new external_multiple_structure($resourcestructure),
- 'strings' => new external_multiple_structure($resourcestructure)
+ 'strings' => new external_multiple_structure($resourcestructure),
]);
}
diff --git a/lib/classes/output/file_picker.php b/lib/classes/output/file_picker.php
new file mode 100644
index 0000000000000..2a3bdd3e0d3c6
--- /dev/null
+++ b/lib/classes/output/file_picker.php
@@ -0,0 +1,107 @@
+.
+
+namespace core\output;
+
+use core\context\user as context_user;
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure representing a file picker.
+ *
+ * @copyright 2010 Dongsheng Cai
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class file_picker implements renderable {
+ /**
+ * @var stdClass An object containing options for the file picker
+ */
+ public $options;
+
+ /**
+ * Constructs a file picker object.
+ *
+ * The following are possible options for the filepicker:
+ * - accepted_types (*)
+ * - return_types (FILE_INTERNAL)
+ * - env (filepicker)
+ * - client_id (uniqid)
+ * - itemid (0)
+ * - maxbytes (-1)
+ * - maxfiles (1)
+ * - buttonname (false)
+ *
+ * @param stdClass $options An object containing options for the file picker.
+ */
+ public function __construct(stdClass $options) {
+ global $CFG, $USER, $PAGE;
+ require_once($CFG->dirroot . '/repository/lib.php');
+ $defaults = [
+ 'accepted_types' => '*',
+ 'return_types' => FILE_INTERNAL,
+ 'env' => 'filepicker',
+ 'client_id' => uniqid(),
+ 'itemid' => 0,
+ 'maxbytes' => -1,
+ 'maxfiles' => 1,
+ 'buttonname' => false,
+ ];
+ foreach ($defaults as $key => $value) {
+ if (empty($options->$key)) {
+ $options->$key = $value;
+ }
+ }
+
+ $options->currentfile = '';
+ if (!empty($options->itemid)) {
+ $fs = get_file_storage();
+ $usercontext = context_user::instance($USER->id);
+ if (empty($options->filename)) {
+ if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $options->itemid, 'id DESC', false)) {
+ $file = reset($files);
+ }
+ } else {
+ $file = $fs->get_file($usercontext->id, 'user', 'draft', $options->itemid, $options->filepath, $options->filename);
+ }
+ if (!empty($file)) {
+ $options->currentfile = html_writer::link(moodle_url::make_draftfile_url(
+ $file->get_itemid(),
+ $file->get_filepath(),
+ $file->get_filename(),
+ ), $file->get_filename());
+ }
+ }
+
+ // Initialise options, getting files in root path.
+ $this->options = initialise_filepicker($options);
+
+ // Copying other options.
+ foreach ($options as $name => $value) {
+ if (!isset($this->options->$name)) {
+ $this->options->$name = $value;
+ }
+ }
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(file_picker::class, \file_picker::class);
diff --git a/lib/classes/output/help_icon.php b/lib/classes/output/help_icon.php
new file mode 100644
index 0000000000000..91edfc91c83d6
--- /dev/null
+++ b/lib/classes/output/help_icon.php
@@ -0,0 +1,127 @@
+.
+
+namespace core\output;
+
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure representing a help icon.
+ *
+ * @copyright 2010 Petr Skoda (info@skodak.org)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class help_icon implements renderable, templatable {
+ /**
+ * @var string lang pack identifier (without the "_help" suffix),
+ * both get_string($identifier, $component) and get_string($identifier.'_help', $component)
+ * must exist.
+ */
+ public $identifier;
+
+ /**
+ * @var string Component name, the same as in get_string()
+ */
+ public $component;
+
+ /**
+ * @var string Extra descriptive text next to the icon
+ */
+ public $linktext = null;
+
+ /**
+ * @var mixed An object, string or number that can be used within translation strings
+ */
+ public $a = null;
+
+ /**
+ * Constructor
+ *
+ * @param string $identifier string for help page title,
+ * string with _help suffix is used for the actual help text.
+ * string with _link suffix is used to create a link to further info (if it exists)
+ * @param string $component
+ * @param string|object|array|int $a An object, string or number that can be used
+ * within translation strings
+ */
+ public function __construct($identifier, $component, $a = null) {
+ $this->identifier = $identifier;
+ $this->component = $component;
+ $this->a = $a;
+ }
+
+ /**
+ * Verifies that both help strings exists, shows debug warnings if not
+ */
+ public function diag_strings() {
+ $sm = get_string_manager();
+ if (!$sm->string_exists($this->identifier, $this->component)) {
+ debugging("Help title string does not exist: [$this->identifier, $this->component]");
+ }
+ if (!$sm->string_exists($this->identifier . '_help', $this->component)) {
+ debugging("Help contents string does not exist: [{$this->identifier}_help, $this->component]");
+ }
+ }
+
+ /**
+ * Export this data so it can be used as the context for a mustache template.
+ *
+ * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ global $CFG;
+
+ $title = get_string($this->identifier, $this->component, $this->a);
+
+ if (empty($this->linktext)) {
+ $alt = get_string('helpprefix2', '', trim($title, ". \t"));
+ } else {
+ $alt = get_string('helpwiththis');
+ }
+
+ $data = get_formatted_help_string($this->identifier, $this->component, false, $this->a);
+
+ $data->alt = $alt;
+ $data->icon = (new pix_icon('help', $alt, 'core'))->export_for_template($output);
+ $data->linktext = $this->linktext;
+ $data->title = get_string('helpprefix2', '', trim($title, ". \t"));
+
+ $options = [
+ 'component' => $this->component,
+ 'identifier' => $this->identifier,
+ 'lang' => current_language(),
+ ];
+
+ // Debugging feature lets you display string identifier and component.
+ if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
+ $options['strings'] = 1;
+ }
+
+ $data->url = (new moodle_url('/help.php', $options))->out(false);
+ $data->ltr = !right_to_left();
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(help_icon::class, \help_icon::class);
diff --git a/lib/classes/output/html_writer.php b/lib/classes/output/html_writer.php
new file mode 100644
index 0000000000000..f9331da60387e
--- /dev/null
+++ b/lib/classes/output/html_writer.php
@@ -0,0 +1,891 @@
+.
+
+namespace core\output;
+
+use core\exception\coding_exception;
+use core_table\output\html_table;
+use core_table\output\html_table_cell;
+use core_table\output\html_table_row;
+use core_text;
+use moodle_url;
+
+/**
+ * Simple html output class
+ *
+ * @copyright 2009 Tim Hunt, 2010 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class html_writer {
+ /**
+ * Outputs a tag with attributes and contents
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @param string $contents What goes between the opening and closing tags
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function tag($tagname, $contents, ?array $attributes = null) {
+ return self::start_tag($tagname, $attributes) . $contents . self::end_tag($tagname);
+ }
+
+ /**
+ * Outputs an opening tag with attributes
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function start_tag($tagname, ?array $attributes = null) {
+ return '<' . $tagname . self::attributes($attributes) . '>';
+ }
+
+ /**
+ * Outputs a closing tag
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @return string HTML fragment
+ */
+ public static function end_tag($tagname) {
+ return '';
+ }
+
+ /**
+ * Outputs an empty tag with attributes
+ *
+ * @param string $tagname The name of tag ('input', 'img', 'br' etc.)
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function empty_tag($tagname, ?array $attributes = null) {
+ return '<' . $tagname . self::attributes($attributes) . ' />';
+ }
+
+ /**
+ * Outputs a tag, but only if the contents are not empty
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @param string $contents What goes between the opening and closing tags
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function nonempty_tag($tagname, $contents, ?array $attributes = null) {
+ if ($contents === '' || is_null($contents)) {
+ return '';
+ }
+ return self::tag($tagname, $contents, $attributes);
+ }
+
+ /**
+ * Outputs a HTML attribute and value
+ *
+ * @param string $name The name of the attribute ('src', 'href', 'class' etc.)
+ * @param string $value The value of the attribute. The value will be escaped with {@see s()}
+ * @return string HTML fragment
+ */
+ public static function attribute($name, $value) {
+ if ($value instanceof moodle_url) {
+ return ' ' . $name . '="' . $value->out() . '"';
+ }
+
+ // Special case, we do not want these in output.
+ if ($value === null) {
+ return '';
+ }
+
+ // No sloppy trimming here!
+ return ' ' . $name . '="' . s($value) . '"';
+ }
+
+ /**
+ * Outputs a list of HTML attributes and values
+ *
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * The values will be escaped with {@see s()}
+ * @return string HTML fragment
+ */
+ public static function attributes(?array $attributes = null) {
+ $attributes = (array)$attributes;
+ $output = '';
+ foreach ($attributes as $name => $value) {
+ $output .= self::attribute($name, $value);
+ }
+ return $output;
+ }
+
+ /**
+ * Generates a simple image tag with attributes.
+ *
+ * @param string $src The source of image
+ * @param string $alt The alternate text for image
+ * @param null|array $attributes The tag attributes (array('height' => $max_height, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function img($src, $alt, ?array $attributes = null) {
+ $attributes = (array)$attributes;
+ $attributes['src'] = $src;
+ // In case a null alt text is provided, set it to an empty string.
+ $attributes['alt'] = $alt ?? '';
+ if (array_key_exists('role', $attributes) && core_text::strtolower($attributes['role']) === 'presentation') {
+ // A presentation role is not necessary for the img tag.
+ // If a non-empty alt text is provided, the presentation role will conflict with the alt text.
+ // An empty alt text denotes a decorative image. The presence of a presentation role is redundant.
+ unset($attributes['role']);
+ debugging('The presentation role is not necessary for an img tag.', DEBUG_DEVELOPER);
+ }
+
+ return self::empty_tag('img', $attributes);
+ }
+
+ /**
+ * Generates random html element id.
+ *
+ * @staticvar int $counter
+ * @staticvar string $uniq
+ * @param string $base A string fragment that will be included in the random ID.
+ * @return string A unique ID
+ */
+ public static function random_id($base = 'random') {
+ static $counter = 0;
+ static $uniq;
+
+ if (!isset($uniq)) {
+ $uniq = uniqid();
+ }
+
+ $counter++;
+ return $base . $uniq . $counter;
+ }
+
+ /**
+ * Generates a simple html link
+ *
+ * @param string|moodle_url $url The URL
+ * @param string $text The text
+ * @param null|array $attributes HTML attributes
+ * @return string HTML fragment
+ */
+ public static function link($url, $text, ?array $attributes = null) {
+ $attributes = (array)$attributes;
+ $attributes['href'] = $url;
+ return self::tag('a', $text, $attributes);
+ }
+
+ /**
+ * Generates a simple checkbox with optional label
+ *
+ * @param string $name The name of the checkbox
+ * @param string $value The value of the checkbox
+ * @param bool $checked Whether the checkbox is checked
+ * @param string $label The label for the checkbox
+ * @param null|array $attributes Any attributes to apply to the checkbox
+ * @param null|array $labelattributes Any attributes to apply to the label, if present
+ * @return string html fragment
+ */
+ public static function checkbox(
+ $name,
+ $value,
+ $checked = true,
+ $label = '',
+ ?array $attributes = null,
+ ?array $labelattributes = null,
+ ) {
+ $attributes = (array) $attributes;
+ $output = '';
+
+ if ($label !== '' && !is_null($label)) {
+ if (empty($attributes['id'])) {
+ $attributes['id'] = self::random_id('checkbox_');
+ }
+ }
+ $attributes['type'] = 'checkbox';
+ $attributes['value'] = $value;
+ $attributes['name'] = $name;
+ $attributes['checked'] = $checked ? 'checked' : null;
+
+ $output .= self::empty_tag('input', $attributes);
+
+ if ($label !== '' && !is_null($label)) {
+ $labelattributes = (array) $labelattributes;
+ $labelattributes['for'] = $attributes['id'];
+ $output .= self::tag('label', $label, $labelattributes);
+ }
+
+ return $output;
+ }
+
+ /**
+ * Generates a simple select yes/no form field
+ *
+ * @param string $name name of select element
+ * @param bool $selected
+ * @param null|array $attributes - html select element attributes
+ * @return string HTML fragment
+ */
+ public static function select_yes_no($name, $selected = true, ?array $attributes = null) {
+ $options = ['1' => get_string('yes'), '0' => get_string('no')];
+ return self::select($options, $name, $selected, null, $attributes);
+ }
+
+ /**
+ * Generates a simple select form field
+ *
+ * Note this function does HTML escaping on the optgroup labels, but not on the choice labels.
+ *
+ * @param array $options associative array value=>label ex.:
+ * array(1=>'One, 2=>Two)
+ * it is also possible to specify optgroup as complex label array ex.:
+ * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
+ * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
+ * @param string $name name of select element
+ * @param string|array $selected value or array of values depending on multiple attribute
+ * @param array|bool|null $nothing add nothing selected option, or false of not added
+ * @param null|array $attributes html select element attributes
+ * @return string HTML fragment
+ */
+ public static function select(
+ array $options,
+ $name,
+ $selected = '',
+ $nothing = ['' => 'choosedots'],
+ ?array $attributes = null,
+ ) {
+ $attributes = (array)$attributes;
+ if (is_array($nothing)) {
+ foreach ($nothing as $k => $v) {
+ if ($v === 'choose' || $v === 'choosedots') {
+ $nothing[$k] = get_string('choosedots');
+ }
+ }
+ $options = $nothing + $options; // Keep keys, do not override.
+ } else if (is_string($nothing) && $nothing !== '') {
+ // BC.
+ $options = ['' => $nothing] + $options;
+ }
+
+ // We may accept more values if multiple attribute specified.
+ $selected = (array)$selected;
+ foreach ($selected as $k => $v) {
+ $selected[$k] = (string)$v;
+ }
+
+ if (!isset($attributes['id'])) {
+ $id = 'menu' . $name;
+ // Name may contain [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading.
+ $id = str_replace('[', '', $id);
+ $id = str_replace(']', '', $id);
+ $attributes['id'] = $id;
+ }
+
+ if (!isset($attributes['class'])) {
+ $class = 'menu' . $name;
+ // Name may contain [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading.
+ $class = str_replace('[', '', $class);
+ $class = str_replace(']', '', $class);
+ $attributes['class'] = $class;
+ }
+ $attributes['class'] = 'select custom-select ' . $attributes['class']; // Add 'select' selector always.
+
+ $attributes['name'] = $name;
+
+ if (!empty($attributes['disabled'])) {
+ $attributes['disabled'] = 'disabled';
+ } else {
+ unset($attributes['disabled']);
+ }
+
+ $output = '';
+ foreach ($options as $value => $label) {
+ if (is_array($label)) {
+ // Ignore key, it just has to be unique.
+ $output .= self::select_optgroup(key($label), current($label), $selected);
+ } else {
+ $output .= self::select_option($label, $value, $selected);
+ }
+ }
+ return self::tag('select', $output, $attributes);
+ }
+
+ /**
+ * Returns HTML to display a select box option.
+ *
+ * @param string $label The label to display as the option.
+ * @param string|int $value The value the option represents
+ * @param array $selected An array of selected options
+ * @return string HTML fragment
+ */
+ private static function select_option($label, $value, array $selected) {
+ $attributes = [];
+ $value = (string)$value;
+ if (in_array($value, $selected, true)) {
+ $attributes['selected'] = 'selected';
+ }
+ $attributes['value'] = $value;
+ return self::tag('option', $label, $attributes);
+ }
+
+ /**
+ * Returns HTML to display a select box option group.
+ *
+ * @param string $groupname The label to use for the group
+ * @param array $options The options in the group
+ * @param array $selected An array of selected values.
+ * @return string HTML fragment.
+ */
+ private static function select_optgroup($groupname, $options, array $selected) {
+ if (empty($options)) {
+ return '';
+ }
+ $attributes = ['label' => $groupname];
+ $output = '';
+ foreach ($options as $value => $label) {
+ $output .= self::select_option($label, $value, $selected);
+ }
+ return self::tag('optgroup', $output, $attributes);
+ }
+
+ /**
+ * This is a shortcut for making an hour selector menu.
+ *
+ * @param string $type The type of selector (years, months, days, hours, minutes)
+ * @param string $name fieldname
+ * @param int $currenttime A default timestamp in GMT
+ * @param int $step minute spacing
+ * @param null|array $attributes - html select element attributes
+ * @param float|int|string $timezone the timezone to use to calculate the time
+ * {@link https://moodledev.io/docs/apis/subsystems/time#timezone}
+ * @return string HTML fragment
+ */
+ public static function select_time($type, $name, $currenttime = 0, $step = 5, ?array $attributes = null, $timezone = 99) {
+ global $OUTPUT;
+
+ if (!$currenttime) {
+ $currenttime = time();
+ }
+ $calendartype = \core_calendar\type_factory::get_calendar_instance();
+ $currentdate = $calendartype->timestamp_to_date_array($currenttime, $timezone);
+
+ $userdatetype = $type;
+ $timeunits = [];
+
+ switch ($type) {
+ case 'years':
+ $timeunits = $calendartype->get_years();
+ $userdatetype = 'year';
+ break;
+ case 'months':
+ $timeunits = $calendartype->get_months();
+ $userdatetype = 'month';
+ $currentdate['month'] = (int)$currentdate['mon'];
+ break;
+ case 'days':
+ $timeunits = $calendartype->get_days();
+ $userdatetype = 'mday';
+ break;
+ case 'hours':
+ for ($i = 0; $i <= 23; $i++) {
+ $timeunits[$i] = sprintf("%02d", $i);
+ }
+ break;
+ case 'minutes':
+ if ($step != 1) {
+ $currentdate['minutes'] = ceil($currentdate['minutes'] / $step) * $step;
+ }
+
+ for ($i = 0; $i <= 59; $i += $step) {
+ $timeunits[$i] = sprintf("%02d", $i);
+ }
+ break;
+ default:
+ throw new coding_exception("Time type $type is not supported by html_writer::select_time().");
+ }
+
+ $attributes = (array) $attributes;
+ $data = (object) [
+ 'name' => $name,
+ 'id' => !empty($attributes['id']) ? $attributes['id'] : self::random_id('ts_'),
+ 'label' => get_string(substr($type, 0, -1), 'form'),
+ 'options' => array_map(function ($value) use ($timeunits, $currentdate, $userdatetype) {
+ return [
+ 'name' => $timeunits[$value],
+ 'value' => $value,
+ 'selected' => $currentdate[$userdatetype] == $value,
+ ];
+ }, array_keys($timeunits)),
+ ];
+
+ unset($attributes['id']);
+ unset($attributes['name']);
+ $data->attributes = array_map(function ($name) use ($attributes) {
+ return [
+ 'name' => $name,
+ 'value' => $attributes[$name],
+ ];
+ }, array_keys($attributes));
+
+ return $OUTPUT->render_from_template('core/select_time', $data);
+ }
+
+ /**
+ * Shortcut for quick making of lists
+ *
+ * Note: 'list' is a reserved keyword ;-)
+ *
+ * @param array $items
+ * @param null|array $attributes
+ * @param string $tag ul or ol
+ * @return string
+ */
+ public static function alist(array $items, ?array $attributes = null, $tag = 'ul') {
+ $output = self::start_tag($tag, $attributes) . "\n";
+ foreach ($items as $item) {
+ $output .= self::tag('li', $item) . "\n";
+ }
+ $output .= self::end_tag($tag);
+ return $output;
+ }
+
+ /**
+ * Returns hidden input fields created from url parameters.
+ *
+ * @param moodle_url $url
+ * @param null|array $exclude list of excluded parameters
+ * @return string HTML fragment
+ */
+ public static function input_hidden_params(moodle_url $url, ?array $exclude = null) {
+ $exclude = (array)$exclude;
+ $params = $url->params();
+ foreach ($exclude as $key) {
+ unset($params[$key]);
+ }
+
+ $output = '';
+ foreach ($params as $key => $value) {
+ $attributes = ['type' => 'hidden', 'name' => $key, 'value' => $value];
+ $output .= self::empty_tag('input', $attributes) . "\n";
+ }
+ return $output;
+ }
+
+ /**
+ * Generate a script tag containing the the specified code.
+ *
+ * @param string $jscode the JavaScript code
+ * @param moodle_url|string $url optional url of the external script, $code ignored if specified
+ * @return string HTML, the code wrapped in ';
+ } else {
+ $code = '';
+ foreach ($baserollups as $rollup) {
+ $code .= '';
+ }
+ return $code;
+ }
+ }
+
+ /**
+ * Returns html tags needed for inclusion of theme CSS.
+ *
+ * @return string
+ */
+ protected function get_css_code() {
+ // First of all the theme CSS, then any custom CSS
+ // Please note custom CSS is strongly discouraged,
+ // because it can not be overridden by themes!
+ // It is suitable only for things like mod/data which accepts CSS from teachers.
+ $attributes = ['rel' => 'stylesheet', 'type' => 'text/css'];
+
+ // Add the YUI code first. We want this to be overridden by any Moodle CSS.
+ $code = $this->get_yui3lib_headcss();
+
+ // This line of code may look funny but it is currently required in order
+ // to avoid MASSIVE display issues in Internet Explorer.
+ // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
+ // ignored whenever another resource is added until such time as a redraw
+ // is forced, usually by moving the mouse over the affected element.
+ $code .= html_writer::tag(
+ 'script',
+ '/** Required in order to fix style inclusion problems in IE with YUI **/',
+ ['id' => 'firstthemesheet', 'type' => 'text/css'],
+ );
+
+ $urls = $this->cssthemeurls + $this->cssurls;
+ foreach ($urls as $url) {
+ $attributes['href'] = $url;
+ $code .= html_writer::empty_tag('link', $attributes) . "\n";
+ // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly.
+ unset($attributes['id']);
+ }
+
+ return $code;
+ }
+
+ /**
+ * Adds extra modules specified after printing of page header.
+ *
+ * @return string
+ */
+ protected function get_extra_modules_code() {
+ if (empty($this->extramodules)) {
+ return '';
+ }
+ return html_writer::script(js_writer::function_call('M.yui.add_module', [$this->extramodules]));
+ }
+
+ /**
+ * Generate any HTML that needs to go inside the tag.
+ *
+ * Normally, this method is called automatically by the code that prints the
+ * tag. You should not normally need to call it in your own code.
+ *
+ * @param moodle_page $page
+ * @param core_renderer $renderer
+ * @return string the HTML code to to inside the tag.
+ */
+ public function get_head_code(moodle_page $page, core_renderer $renderer) {
+ global $CFG;
+
+ // Note: the $page and $output are not stored here because it would
+ // create circular references in memory which prevents garbage collection.
+ $this->init_requirements_data($page, $renderer);
+
+ $output = '';
+
+ // Add all standard CSS for this page.
+ $output .= $this->get_css_code();
+
+ // Set up the M namespace.
+ $js = "var M = {}; M.yui = {};\n";
+
+ // Capture the time now ASAP during page load. This minimises the lag when
+ // we try to relate times on the server to times in the browser.
+ // An example of where this is used is the quiz countdown timer.
+ $js .= "M.pageloadstarttime = new Date();\n";
+
+ // Add a subset of Moodle configuration to the M namespace.
+ $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
+
+ // Set up global YUI3 loader object - this should contain all code needed by plugins.
+ // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });",
+ // this needs to be done before including any other script.
+ $js .= $this->YUI_config->get_config_functions();
+ $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n";
+ $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more.
+ $js = $this->YUI_config->update_header_js($js);
+
+ $output .= html_writer::script($js);
+
+ // Add variables.
+ if ($this->jsinitvariables['head']) {
+ $js = '';
+ foreach ($this->jsinitvariables['head'] as $data) {
+ [$var, $value] = $data;
+ $js .= js_writer::set_variable($var, $value, true);
+ }
+ $output .= html_writer::script($js);
+ }
+
+ // Mark head sending done, it is not possible to anything there.
+ $this->headdone = true;
+
+ return $output;
+ }
+
+ /**
+ * Generate any HTML that needs to go at the start of the tag.
+ *
+ * Normally, this method is called automatically by the code that prints the
+ * tag. You should not normally need to call it in your own code.
+ *
+ * @param renderer_base $renderer
+ * @return string the HTML code to go at the start of the tag.
+ */
+ public function get_top_of_body_code(renderer_base $renderer) {
+ global $CFG;
+
+ // First the skip links.
+ $output = $renderer->render_skip_links($this->skiplinks);
+
+ // Include the Polyfills.
+ $output .= html_writer::script('', $this->js_fix_url('/lib/polyfills/polyfill.js'));
+
+ // YUI3 JS needs to be loaded early in the body. It should be cached well by the browser.
+ $output .= $this->get_yui3lib_headcode();
+
+ // Add hacked jQuery support, it is not intended for standard Moodle distribution!
+ $output .= $this->get_jquery_headcode();
+
+ // Link our main JS file, all core stuff should be there.
+ $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js'));
+
+ // All the other linked things from HEAD - there should be as few as possible.
+ if ($this->jsincludes['head']) {
+ foreach ($this->jsincludes['head'] as $url) {
+ $output .= html_writer::script('', $url);
+ }
+ }
+
+ // Then the clever trick for hiding of things not needed when JS works.
+ $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
+ $this->topofbodydone = true;
+ return $output;
+ }
+
+ /**
+ * Generate any HTML that needs to go at the end of the page.
+ *
+ * Normally, this method is called automatically by the code that prints the
+ * page footer. You should not normally need to call it in your own code.
+ *
+ * @return string the HTML code to to at the end of the page.
+ */
+ public function get_end_code() {
+ global $CFG;
+ $output = '';
+
+ // Set the log level for the JS logging.
+ $logconfig = new stdClass();
+ $logconfig->level = 'warn';
+ if ($CFG->debugdeveloper) {
+ $logconfig->level = 'trace';
+ }
+ $this->js_call_amd('core/log', 'setConfig', [$logconfig]);
+ // Add any global JS that needs to run on all pages.
+ $this->js_call_amd('core/page_global', 'init');
+ $this->js_call_amd('core/utility');
+
+ // Call amd init functions.
+ $output .= $this->get_amd_footercode();
+
+ // Add other requested modules.
+ $output .= $this->get_extra_modules_code();
+
+ $this->js_init_code('M.util.js_complete("init");', true);
+
+ // All the other linked scripts - there should be as few as possible.
+ if ($this->jsincludes['footer']) {
+ foreach ($this->jsincludes['footer'] as $url) {
+ $output .= html_writer::script('', $url);
+ }
+ }
+
+ // Add all needed strings.
+ // First add core strings required for some dialogues.
+ $this->strings_for_js([
+ 'confirm',
+ 'yes',
+ 'no',
+ 'areyousure',
+ 'closebuttontitle',
+ 'unknownerror',
+ 'error',
+ 'file',
+ 'url',
+ // TODO MDL-70830 shortforms should preload the collapseall/expandall strings properly.
+ 'collapseall',
+ 'expandall',
+ ], 'moodle');
+ $this->strings_for_js([
+ 'debuginfo',
+ 'line',
+ 'stacktrace',
+ ], 'debug');
+ $this->string_for_js('labelsep', 'langconfig');
+ if (!empty($this->stringsforjs)) {
+ $strings = [];
+ foreach ($this->stringsforjs as $component => $v) {
+ foreach ($v as $indentifier => $langstring) {
+ $strings[$component][$indentifier] = $langstring->out();
+ }
+ }
+ $output .= html_writer::script(js_writer::set_variable('M.str', $strings));
+ }
+
+ // Add variables.
+ if ($this->jsinitvariables['footer']) {
+ $js = '';
+ foreach ($this->jsinitvariables['footer'] as $data) {
+ [$var, $value] = $data;
+ $js .= js_writer::set_variable($var, $value, true);
+ }
+ $output .= html_writer::script($js);
+ }
+
+ $inyuijs = $this->get_javascript_code(false);
+ $ondomreadyjs = $this->get_javascript_code(true);
+ $jsinit = $this->get_javascript_init_code();
+ $handlersjs = $this->get_event_handler_code();
+
+ // There is a global Y, make sure it is available in your scope.
+ $js = "(function() {{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}})();";
+
+ $output .= html_writer::script($js);
+
+ return $output;
+ }
+
+ /**
+ * Have we already output the code in the tag?
+ *
+ * @return bool
+ */
+ public function is_head_done() {
+ return $this->headdone;
+ }
+
+ /**
+ * Have we already output the code at the start of the tag?
+ *
+ * @return bool
+ */
+ public function is_top_of_body_done() {
+ return $this->topofbodydone;
+ }
+
+ /**
+ * Should we generate a bit of content HTML that is only required once on
+ * this page (e.g. the contents of the modchooser), now? Basically, we call
+ * {@see has_one_time_item_been_created()}, and if the thing has not already
+ * been output, we return true to tell the caller to generate it, and also
+ * call {@see set_one_time_item_created()} to record the fact that it is
+ * about to be generated.
+ *
+ * That is, a typical usage pattern (in a renderer method) is:
+ *
+ * if (!$this->page->requires->should_create_one_time_item_now($thing)) {
+ * return '';
+ * }
+ * // Else generate it.
+ *
+ *
+ * @param string $thing identifier for the bit of content. Should be of the form
+ * frankenstyle_things, e.g. core_course_modchooser.
+ * @return bool if true, the caller should generate that bit of output now, otherwise don't.
+ */
+ public function should_create_one_time_item_now($thing) {
+ if ($this->has_one_time_item_been_created($thing)) {
+ return false;
+ }
+
+ $this->set_one_time_item_created($thing);
+ return true;
+ }
+
+ /**
+ * Has a particular bit of HTML that is only required once on this page
+ * (e.g. the contents of the modchooser) already been generated?
+ *
+ * Normally, you can use the {@see should_create_one_time_item_now()} helper
+ * method rather than calling this method directly.
+ *
+ * @param string $thing identifier for the bit of content. Should be of the form
+ * frankenstyle_things, e.g. core_course_modchooser.
+ * @return bool whether that bit of output has been created.
+ */
+ public function has_one_time_item_been_created($thing) {
+ return isset($this->onetimeitemsoutput[$thing]);
+ }
+
+ /**
+ * Indicate that a particular bit of HTML that is only required once on this
+ * page (e.g. the contents of the modchooser) has been generated (or is about to be)?
+ *
+ * Normally, you can use the {@see should_create_one_time_item_now()} helper
+ * method rather than calling this method directly.
+ *
+ * @param string $thing identifier for the bit of content. Should be of the form
+ * frankenstyle_things, e.g. core_course_modchooser.
+ */
+ public function set_one_time_item_created($thing) {
+ if ($this->has_one_time_item_been_created($thing)) {
+ throw new coding_exception($thing . ' is only supposed to be ouput ' .
+ 'once per page, but it seems to be being output again.');
+ }
+ return $this->onetimeitemsoutput[$thing] = true;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(page_requirements_manager::class, \page_requirements_manager::class);
diff --git a/lib/classes/output/requirements/yui.php b/lib/classes/output/requirements/yui.php
new file mode 100644
index 0000000000000..58a695191c28b
--- /dev/null
+++ b/lib/classes/output/requirements/yui.php
@@ -0,0 +1,379 @@
+.
+
+namespace core\output\requirements;
+
+use cache;
+use core_component;
+use core_minify;
+use core\exception\coding_exception;
+use DirectoryIterator;
+
+/**
+ * This class represents the YUI configuration.
+ *
+ * @copyright 2013 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.5
+ * @package core
+ * @category output
+ */
+class yui {
+ /**
+ * These settings must be public so that when the object is converted to json they are exposed.
+ * Note: Some of these are camelCase because YUI uses camelCase variable names.
+ *
+ * The settings are described and documented in the YUI API at:
+ * - http://yuilibrary.com/yui/docs/api/classes/config.html
+ * - http://yuilibrary.com/yui/docs/api/classes/Loader.html
+ */
+ public $debug = false;
+ public $base;
+ public $comboBase;
+ public $combine;
+ public $filter = null;
+ public $insertBefore = 'firstthemesheet';
+ public $groups = [];
+ public $modules = [];
+ /** @var array The log sources that should be not be logged. */
+ public $logInclude = [];
+ /** @var array Tog sources that should be logged. */
+ public $logExclude = [];
+ /** @var string The minimum log level for YUI logging statements. */
+ public $logLevel;
+
+ /**
+ * @var array List of functions used by the YUI Loader group pattern recognition.
+ */
+ protected $jsconfigfunctions = [];
+
+ /**
+ * Create a new group within the YUI_config system.
+ *
+ * @param string $name The name of the group. This must be unique and
+ * not previously used.
+ * @param array $config The configuration for this group.
+ * @return void
+ */
+ public function add_group($name, $config) {
+ if (isset($this->groups[$name])) {
+ throw new coding_exception(
+ "A YUI configuration group for '{$name}' already exists. " .
+ 'To make changes to this group use YUI_config->update_group().',
+ );
+ }
+ $this->groups[$name] = $config;
+ }
+
+ /**
+ * Update an existing group configuration
+ *
+ * Note, any existing configuration for that group will be wiped out.
+ * This includes module configuration.
+ *
+ * @param string $name The name of the group. This must be unique and
+ * not previously used.
+ * @param array $config The configuration for this group.
+ * @return void
+ */
+ public function update_group($name, $config) {
+ if (!isset($this->groups[$name])) {
+ throw new coding_exception(
+ 'The Moodle YUI module does not exist. ' .
+ 'You must define the moodle module config using YUI_config->add_module_config first.',
+ );
+ }
+ $this->groups[$name] = $config;
+ }
+
+ /**
+ * Set the value of a configuration function used by the YUI Loader's pattern testing.
+ *
+ * Only the body of the function should be passed, and not the whole function wrapper.
+ *
+ * The JS function your write will be passed a single argument 'name' containing the
+ * name of the module being loaded.
+ *
+ * @param string $function String the body of the JavaScript function. This should be used i
+ * @return string the name of the function to use in the group pattern configuration.
+ */
+ public function set_config_function($function) {
+ $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn';
+ if (isset($this->jsconfigfunctions[$configname])) {
+ throw new coding_exception(
+ "A YUI config function with this name already exists. Config function names must be unique.",
+ );
+ }
+ $this->jsconfigfunctions[$configname] = $function;
+ return '@' . $configname . '@';
+ }
+
+ /**
+ * Allow setting of the config function described in {@see set_config_function} from a file.
+ * The contents of this file are then passed to set_config_function.
+ *
+ * When jsrev is positive, the function is minified and stored in a MUC cache for subsequent uses.
+ *
+ * @param string $file The path to the JavaScript function used for YUI configuration.
+ * @return string the name of the function to use in the group pattern configuration.
+ */
+ public function set_config_source($file) {
+ global $CFG;
+ $cache = cache::make('core', 'yuimodules');
+
+ // Attempt to get the metadata from the cache.
+ $keyname = 'configfn_' . $file;
+ $fullpath = $CFG->dirroot . '/' . $file;
+ if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
+ $cache->delete($keyname);
+ $configfn = file_get_contents($fullpath);
+ } else {
+ $configfn = $cache->get($keyname);
+ if ($configfn === false) {
+ require_once($CFG->libdir . '/jslib.php');
+ $configfn = core_minify::js_files([$fullpath]);
+ $cache->set($keyname, $configfn);
+ }
+ }
+ return $this->set_config_function($configfn);
+ }
+
+ /**
+ * Retrieve the list of JavaScript functions for YUI_config groups.
+ *
+ * @return string The complete set of config functions
+ */
+ public function get_config_functions() {
+ $configfunctions = '';
+ foreach ($this->jsconfigfunctions as $functionname => $function) {
+ $configfunctions .= "var {$functionname} = function(me) {";
+ $configfunctions .= $function;
+ $configfunctions .= "};\n";
+ }
+ return $configfunctions;
+ }
+
+ /**
+ * Update the header JavaScript with any required modification for the YUI Loader.
+ *
+ * @param string $js String The JavaScript to manipulate.
+ * @return string the modified JS string.
+ */
+ public function update_header_js($js) {
+ // Update the names of the the configFn variables.
+ // The PHP json_encode function cannot handle literal names so we have to wrap
+ // them in @ and then replace them with literals of the same function name.
+ foreach ($this->jsconfigfunctions as $functionname => $function) {
+ $js = str_replace('"@' . $functionname . '@"', $functionname, $js);
+ }
+ return $js;
+ }
+
+ /**
+ * Add configuration for a specific module.
+ *
+ * @param string $name The name of the module to add configuration for.
+ * @param array $config The configuration for the specified module.
+ * @param string $group The name of the group to add configuration for.
+ * If not specified, then this module is added to the global
+ * configuration.
+ * @return void
+ */
+ public function add_module_config($name, $config, $group = null) {
+ if ($group) {
+ if (!isset($this->groups[$name])) {
+ throw new coding_exception(
+ 'The Moodle YUI module does not exist. ' .
+ 'You must define the moodle module config using YUI_config->add_module_config first.',
+ );
+ }
+ if (!isset($this->groups[$group]['modules'])) {
+ $this->groups[$group]['modules'] = [];
+ }
+ $modules = &$this->groups[$group]['modules'];
+ } else {
+ $modules = &$this->modules;
+ }
+ $modules[$name] = $config;
+ }
+
+ /**
+ * Add the moodle YUI module metadata for the moodle group to the YUI_config instance.
+ *
+ * If js caching is disabled, metadata will not be served causing YUI to calculate
+ * module dependencies as each module is loaded.
+ *
+ * If metadata does not exist it will be created and stored in a MUC entry.
+ *
+ * @return void
+ */
+ public function add_moodle_metadata() {
+ global $CFG;
+ if (!isset($this->groups['moodle'])) {
+ throw new coding_exception(
+ 'The Moodle YUI module does not exist. ' .
+ 'You must define the moodle module config using YUI_config->add_module_config first.',
+ );
+ }
+
+ if (!isset($this->groups['moodle']['modules'])) {
+ $this->groups['moodle']['modules'] = [];
+ }
+
+ $cache = cache::make('core', 'yuimodules');
+ if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
+ $metadata = [];
+ $metadata = $this->get_moodle_metadata();
+ $cache->delete('metadata');
+ } else {
+ // Attempt to get the metadata from the cache.
+ if (!$metadata = $cache->get('metadata')) {
+ $metadata = $this->get_moodle_metadata();
+ $cache->set('metadata', $metadata);
+ }
+ }
+
+ // Merge with any metadata added specific to this page which was added manually.
+ $this->groups['moodle']['modules'] = array_merge(
+ $this->groups['moodle']['modules'],
+ $metadata
+ );
+ }
+
+ /**
+ * Determine the module metadata for all moodle YUI modules.
+ *
+ * This works through all modules capable of serving YUI modules, and attempts to get
+ * metadata for each of those modules.
+ *
+ * @return array of module metadata
+ */
+ private function get_moodle_metadata() {
+ $moodlemodules = [];
+ // Core isn't a plugin type or subsystem - handle it seperately.
+ if ($module = $this->get_moodle_path_metadata(core_component::get_component_directory('core'))) {
+ $moodlemodules = array_merge($moodlemodules, $module);
+ }
+
+ // Handle other core subsystems.
+ $subsystems = core_component::get_core_subsystems();
+ foreach ($subsystems as $subsystem => $path) {
+ if (is_null($path)) {
+ continue;
+ }
+ if ($module = $this->get_moodle_path_metadata($path)) {
+ $moodlemodules = array_merge($moodlemodules, $module);
+ }
+ }
+
+ // And finally the plugins.
+ $plugintypes = core_component::get_plugin_types();
+ foreach ($plugintypes as $plugintype => $pathroot) {
+ $pluginlist = core_component::get_plugin_list($plugintype);
+ foreach ($pluginlist as $plugin => $path) {
+ if ($module = $this->get_moodle_path_metadata($path)) {
+ $moodlemodules = array_merge($moodlemodules, $module);
+ }
+ }
+ }
+
+ return $moodlemodules;
+ }
+
+ /**
+ * Helper function process and return the YUI metadata for all of the modules under the specified path.
+ *
+ * @param string $path the UNC path to the YUI src directory.
+ * @return array the complete array for frankenstyle directory.
+ */
+ private function get_moodle_path_metadata($path) {
+ // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json.
+ $baseyui = $path . '/yui/src';
+ $modules = [];
+ if (is_dir($baseyui)) {
+ $items = new DirectoryIterator($baseyui);
+ foreach ($items as $item) {
+ if ($item->isDot() || !$item->isDir()) {
+ continue;
+ }
+ $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json');
+ if (!is_readable($metafile)) {
+ continue;
+ }
+ $metadata = file_get_contents($metafile);
+ $modules = array_merge($modules, (array) json_decode($metadata));
+ }
+ }
+ return $modules;
+ }
+
+ /**
+ * Define YUI modules which we have been required to patch between releases.
+ *
+ * We must do this because we aggressively cache content on the browser, and we must also override use of the
+ * external CDN which will serve the true authoritative copy of the code without our patches.
+ *
+ * @param string $combobase The local combobase
+ * @param string $yuiversion The current YUI version
+ * @param int $patchlevel The patch level we're working to for YUI
+ * @param array $patchedmodules An array containing the names of the patched modules
+ * @return void
+ */
+ public function define_patched_core_modules($combobase, $yuiversion, $patchlevel, $patchedmodules) {
+ // The version we use is suffixed with a patchlevel so that we can get additional revisions between YUI releases.
+ $subversion = $yuiversion . '_' . $patchlevel;
+
+ if ($this->comboBase == $combobase) {
+ // If we are using the local combobase in the loader, we can add a group and still make use of the combo
+ // loader. We just need to specify a different root which includes a slightly different YUI version number
+ // to include our patchlevel.
+ $patterns = [];
+ $modules = [];
+ foreach ($patchedmodules as $modulename) {
+ // We must define the pattern and module here so that the loader uses our group configuration instead of
+ // the standard module definition. We may lose some metadata provided by upstream but this will be
+ // loaded when the module is loaded anyway.
+ $patterns[$modulename] = [
+ 'group' => 'yui-patched',
+ ];
+ $modules[$modulename] = [];
+ }
+
+ // Actually add the patch group here.
+ $this->add_group('yui-patched', [
+ 'combine' => true,
+ 'root' => $subversion . '/',
+ 'patterns' => $patterns,
+ 'modules' => $modules,
+ ]);
+ } else {
+ // The CDN is in use - we need to instead use the local combobase for this module and override the modules
+ // definition. We cannot use the local base - we must use the combobase because we cannot invalidate the
+ // local base in browser caches.
+ $fullpathbase = $combobase . $subversion . '/';
+ foreach ($patchedmodules as $modulename) {
+ $this->modules[$modulename] = [
+ 'fullpath' => $fullpathbase . $modulename . '/' . $modulename . '-min.js',
+ ];
+ }
+ }
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(yui::class, \YUI_config::class);
diff --git a/lib/classes/output/select_menu.php b/lib/classes/output/select_menu.php
index eb487911d1761..e642c70b6c69c 100644
--- a/lib/classes/output/select_menu.php
+++ b/lib/classes/output/select_menu.php
@@ -18,8 +18,6 @@
namespace core\output;
-use renderer_base;
-
/**
* A single-select combobox widget that is functionally similar to an HTML select element.
*
@@ -28,7 +26,7 @@
* @copyright 2022 Shamim Rezaie
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class select_menu implements \renderable, \templatable {
+class select_menu implements renderable, templatable {
/** @var array List of options. */
protected $options;
@@ -85,7 +83,7 @@ protected function flatten_options(): array {
'name' => $groupname,
'isgroup' => true,
'id' => \html_writer::random_id('select-menu-group'),
- 'options' => []
+ 'options' => [],
];
}
foreach ($optoptions as $optvalue => $optoption) {
diff --git a/lib/classes/output/single_button.php b/lib/classes/output/single_button.php
new file mode 100644
index 0000000000000..853f8d83f0817
--- /dev/null
+++ b/lib/classes/output/single_button.php
@@ -0,0 +1,282 @@
+.
+
+namespace core\output;
+
+use core\output\actions\confirm_action;
+use core\output\actions\component_action;
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure representing a simple form with only one button.
+ *
+ * @copyright 2009 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class single_button implements renderable {
+ /**
+ * Possible button types. From boostrap.
+ */
+ const BUTTON_TYPES = [
+ self::BUTTON_PRIMARY,
+ self::BUTTON_SECONDARY,
+ self::BUTTON_SUCCESS,
+ self::BUTTON_DANGER,
+ self::BUTTON_WARNING,
+ self::BUTTON_INFO,
+ ];
+
+ /**
+ * Possible button types - Primary.
+ */
+ const BUTTON_PRIMARY = 'primary';
+ /**
+ * Possible button types - Secondary.
+ */
+ const BUTTON_SECONDARY = 'secondary';
+ /**
+ * Possible button types - Danger.
+ */
+ const BUTTON_DANGER = 'danger';
+ /**
+ * Possible button types - Success.
+ */
+ const BUTTON_SUCCESS = 'success';
+ /**
+ * Possible button types - Warning.
+ */
+ const BUTTON_WARNING = 'warning';
+ /**
+ * Possible button types - Info.
+ */
+ const BUTTON_INFO = 'info';
+
+ /**
+ * @var moodle_url Target url
+ */
+ public $url;
+
+ /**
+ * @var string Button label
+ */
+ public $label;
+
+ /**
+ * @var string Form submit method post or get
+ */
+ public $method = 'post';
+
+ /**
+ * @var string Wrapping div class
+ */
+ public $class = 'singlebutton';
+
+ /**
+ * @var string Type of button (from defined types). Used for styling.
+ */
+ protected $type;
+
+ /**
+ * @var bool True if button is primary button. Used for styling.
+ * @deprecated since Moodle 4.2
+ */
+ private $primary = false;
+
+ /**
+ * @var bool True if button disabled, false if normal
+ */
+ public $disabled = false;
+
+ /**
+ * @var string Button tooltip
+ */
+ public $tooltip = null;
+
+ /**
+ * @var string Form id
+ */
+ public $formid;
+
+ /**
+ * @var array List of attached actions
+ */
+ public $actions = [];
+
+ /**
+ * @var array $params URL Params
+ */
+ public $params;
+
+ /**
+ * @var string Action id
+ */
+ public $actionid;
+
+ /**
+ * @var array
+ */
+ protected $attributes = [];
+
+ /**
+ * Constructor
+ *
+ * @param moodle_url $url
+ * @param string $label button text
+ * @param string $method get or post submit method
+ * @param string $type whether this is a primary button or another type, used for styling
+ * @param array $attributes Attributes for the HTML button tag
+ */
+ public function __construct(
+ moodle_url $url,
+ $label,
+ $method = 'post',
+ $type = self::BUTTON_SECONDARY,
+ $attributes = []
+ ) {
+ if (is_bool($type)) {
+ debugging('The boolean $primary is deprecated and replaced by $type,
+ use single_button::BUTTON_PRIMARY or self::BUTTON_SECONDARY instead');
+ $type = $type ? self::BUTTON_PRIMARY : self::BUTTON_SECONDARY;
+ }
+ $this->url = clone($url);
+ $this->label = $label;
+ $this->method = $method;
+ $this->type = $type;
+ $this->attributes = $attributes;
+ }
+
+ /**
+ * Shortcut for adding a JS confirm dialog when the button is clicked.
+ * The message must be a yes/no question.
+ *
+ * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
+ */
+ public function add_confirm_action($confirmmessage) {
+ $this->add_action(new confirm_action($confirmmessage));
+ }
+
+ /**
+ * Add action to the button.
+ * @param component_action $action
+ */
+ public function add_action(component_action $action) {
+ $this->actions[] = $action;
+ }
+
+ /**
+ * Sets an attribute for the HTML button tag.
+ *
+ * @param string $name The attribute name
+ * @param mixed $value The value
+ * @return null
+ */
+ public function set_attribute($name, $value) {
+ $this->attributes[$name] = $value;
+ }
+
+ /**
+ * Magic setter method.
+ *
+ * This method manages access to some properties and will display deprecation message when accessing 'primary' property.
+ *
+ * @param string $name
+ * @param mixed $value
+ */
+ public function __set($name, $value) {
+ switch ($name) {
+ case 'primary':
+ debugging('The primary field is deprecated, use the type field instead');
+ // Here just in case we modified the primary field from outside {@see \mod_quiz_renderer::summary_page_controls}.
+ $this->type = $value ? self::BUTTON_PRIMARY : self::BUTTON_SECONDARY;
+ break;
+ case 'type':
+ $this->type = in_array($value, self::BUTTON_TYPES) ? $value : self::BUTTON_SECONDARY;
+ break;
+ default:
+ $this->$name = $value;
+ }
+ }
+
+ /**
+ * Magic method getter.
+ *
+ * This method manages access to some properties and will display deprecation message when accessing 'primary' property.
+ *
+ * @param string $name
+ * @return mixed
+ */
+ public function __get($name) {
+ switch ($name) {
+ case 'primary':
+ debugging('The primary field is deprecated, use type field instead');
+ return $this->type == self::BUTTON_PRIMARY;
+ case 'type':
+ return $this->type;
+ default:
+ return $this->$name;
+ }
+ }
+
+ /**
+ * Export data.
+ *
+ * @param renderer_base $output Renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $url = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
+
+ $data = new stdClass();
+ $data->id = html_writer::random_id('single_button');
+ $data->formid = $this->formid;
+ $data->method = $this->method;
+ $data->url = $url === '' ? '#' : $url;
+ $data->label = $this->label;
+ $data->classes = $this->class;
+ $data->disabled = $this->disabled;
+ $data->tooltip = $this->tooltip;
+ $data->type = $this->type;
+ $data->attributes = [];
+ foreach ($this->attributes as $key => $value) {
+ $data->attributes[] = ['name' => $key, 'value' => $value];
+ }
+
+ // Form parameters.
+ $actionurl = new moodle_url($this->url);
+ if ($this->method === 'post') {
+ $actionurl->param('sesskey', sesskey());
+ }
+ $data->params = $actionurl->export_params_for_template();
+
+ // Button actions.
+ $actions = $this->actions;
+ $data->actions = array_map(function ($action) use ($output) {
+ return $action->export_for_template($output);
+ }, $actions);
+ $data->hasactions = !empty($data->actions);
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(single_button::class, \single_button::class);
diff --git a/lib/classes/output/single_select.php b/lib/classes/output/single_select.php
new file mode 100644
index 0000000000000..d4bfa8cc084c2
--- /dev/null
+++ b/lib/classes/output/single_select.php
@@ -0,0 +1,306 @@
+.
+
+namespace core\output;
+
+use core\exception\coding_exception;
+use core\output\actions\component_action;
+use moodle_url;
+use stdClass;
+
+/**
+ * Simple form with just one select field that gets submitted automatically.
+ *
+ * If JS not enabled small go button is printed too.
+ *
+ * @copyright 2009 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class single_select implements renderable, templatable {
+ /**
+ * @var moodle_url Target url - includes hidden fields
+ */
+ public $url;
+
+ /**
+ * @var string Name of the select element.
+ */
+ public $name;
+
+ /**
+ * @var array $options associative array value=>label ex.: array(1=>'One, 2=>Two)
+ * it is also possible to specify optgroup as complex label array ex.:
+ * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
+ * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
+ */
+ public $options;
+
+ /**
+ * @var string Selected option
+ */
+ public $selected;
+
+ /**
+ * @var array Nothing selected
+ */
+ public $nothing;
+
+ /**
+ * @var array Extra select field attributes
+ */
+ public $attributes = [];
+
+ /**
+ * @var string Button label
+ */
+ public $label = '';
+
+ /**
+ * @var array Button label's attributes
+ */
+ public $labelattributes = [];
+
+ /**
+ * @var string Form submit method post or get
+ */
+ public $method = 'get';
+
+ /**
+ * @var string Wrapping div class
+ */
+ public $class = 'singleselect';
+
+ /**
+ * @var bool True if button disabled, false if normal
+ */
+ public $disabled = false;
+
+ /**
+ * @var string Button tooltip
+ */
+ public $tooltip = null;
+
+ /**
+ * @var string Form id
+ */
+ public $formid = null;
+
+ /**
+ * @var help_icon The help icon for this element.
+ */
+ public $helpicon = null;
+
+ /** @var component_action[] component action. */
+ public $actions = [];
+
+ /**
+ * Constructor
+ * @param moodle_url $url form action target, includes hidden fields
+ * @param string $name name of selection field - the changing parameter in url
+ * @param array $options list of options
+ * @param string $selected selected element
+ * @param ?array $nothing
+ * @param string $formid
+ */
+ public function __construct(
+ moodle_url $url,
+ $name,
+ array $options,
+ $selected = '',
+ $nothing = ['' => 'choosedots'],
+ $formid = null,
+ ) {
+ $this->url = $url;
+ $this->name = $name;
+ $this->options = $options;
+ $this->selected = $selected;
+ $this->nothing = $nothing;
+ $this->formid = $formid;
+ }
+
+ /**
+ * Shortcut for adding a JS confirm dialog when the button is clicked.
+ * The message must be a yes/no question.
+ *
+ * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
+ */
+ public function add_confirm_action($confirmmessage) {
+ $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', ['message' => $confirmmessage]));
+ }
+
+ /**
+ * Add action to the button.
+ *
+ * @param component_action $action
+ */
+ public function add_action(component_action $action) {
+ $this->actions[] = $action;
+ }
+
+ /**
+ * Adds help icon.
+ *
+ * @deprecated since Moodle 2.0
+ */
+ public function set_old_help_icon($helppage, $title, $component = 'moodle') {
+ throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
+ }
+
+ /**
+ * Adds help icon.
+ *
+ * @param string $identifier The keyword that defines a help page
+ * @param string $component
+ */
+ public function set_help_icon($identifier, $component = 'moodle') {
+ $this->helpicon = new help_icon($identifier, $component);
+ }
+
+ /**
+ * Sets select's label
+ *
+ * @param string $label
+ * @param array $attributes (optional)
+ */
+ public function set_label($label, $attributes = []) {
+ $this->label = $label;
+ $this->labelattributes = $attributes;
+ }
+
+ /**
+ * Export data.
+ *
+ * @param renderer_base $output Renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $attributes = $this->attributes;
+
+ $data = new stdClass();
+ $data->name = $this->name;
+ $data->method = $this->method;
+ $data->action = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
+ $data->classes = $this->class;
+ $data->label = $this->label;
+ $data->disabled = $this->disabled;
+ $data->title = $this->tooltip;
+ $data->formid = !empty($this->formid) ? $this->formid : html_writer::random_id('single_select_f');
+ $data->id = !empty($attributes['id']) ? $attributes['id'] : html_writer::random_id('single_select');
+
+ // Select element attributes.
+ // Unset attributes that are already predefined in the template.
+ unset($attributes['id']);
+ unset($attributes['class']);
+ unset($attributes['name']);
+ unset($attributes['title']);
+ unset($attributes['disabled']);
+
+ // Map the attributes.
+ $data->attributes = array_map(function ($key) use ($attributes) {
+ return ['name' => $key, 'value' => $attributes[$key]];
+ }, array_keys($attributes));
+
+ // Form parameters.
+ $actionurl = new moodle_url($this->url);
+ if ($this->method === 'post') {
+ $actionurl->param('sesskey', sesskey());
+ }
+ $data->params = $actionurl->export_params_for_template();
+
+ // Select options.
+ $hasnothing = false;
+ if (is_string($this->nothing) && $this->nothing !== '') {
+ $nothing = ['' => $this->nothing];
+ $hasnothing = true;
+ $nothingkey = '';
+ } else if (is_array($this->nothing)) {
+ $nothingvalue = reset($this->nothing);
+ if ($nothingvalue === 'choose' || $nothingvalue === 'choosedots') {
+ $nothing = [key($this->nothing) => get_string('choosedots')];
+ } else {
+ $nothing = $this->nothing;
+ }
+ $hasnothing = true;
+ $nothingkey = key($this->nothing);
+ }
+ if ($hasnothing) {
+ $options = $nothing + $this->options;
+ } else {
+ $options = $this->options;
+ }
+
+ foreach ($options as $value => $name) {
+ if (is_array($options[$value])) {
+ foreach ($options[$value] as $optgroupname => $optgroupvalues) {
+ $sublist = [];
+ foreach ($optgroupvalues as $optvalue => $optname) {
+ $option = [
+ 'value' => $optvalue,
+ 'name' => $optname,
+ 'selected' => strval($this->selected) === strval($optvalue),
+ ];
+
+ if ($hasnothing && $nothingkey === $optvalue) {
+ $option['ignore'] = 'data-ignore';
+ }
+
+ $sublist[] = $option;
+ }
+ $data->options[] = [
+ 'name' => $optgroupname,
+ 'optgroup' => true,
+ 'options' => $sublist,
+ ];
+ }
+ } else {
+ $option = [
+ 'value' => $value,
+ 'name' => $options[$value],
+ 'selected' => strval($this->selected) === strval($value),
+ 'optgroup' => false,
+ ];
+
+ if ($hasnothing && $nothingkey === $value) {
+ $option['ignore'] = 'data-ignore';
+ }
+
+ $data->options[] = $option;
+ }
+ }
+
+ // Label attributes.
+ $data->labelattributes = [];
+ // Unset label attributes that are already in the template.
+ unset($this->labelattributes['for']);
+ // Map the label attributes.
+ foreach ($this->labelattributes as $key => $value) {
+ $data->labelattributes[] = ['name' => $key, 'value' => $value];
+ }
+
+ // Help icon.
+ $data->helpicon = !empty($this->helpicon) ? $this->helpicon->export_for_template($output) : false;
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(single_select::class, \single_select::class);
diff --git a/lib/classes/output/sticky_footer.php b/lib/classes/output/sticky_footer.php
index a007c2b060ee1..06e7e3723dab3 100644
--- a/lib/classes/output/sticky_footer.php
+++ b/lib/classes/output/sticky_footer.php
@@ -16,8 +16,6 @@
namespace core\output;
-use renderable;
-
/**
* Class to render a sticky footer element.
*
@@ -35,7 +33,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class sticky_footer implements named_templatable, renderable {
-
/**
* @var string content of the sticky footer.
*/
diff --git a/lib/classes/output/tabobject.php b/lib/classes/output/tabobject.php
new file mode 100644
index 0000000000000..d0943e6b16642
--- /dev/null
+++ b/lib/classes/output/tabobject.php
@@ -0,0 +1,149 @@
+.
+
+namespace core\output;
+
+use moodle_url;
+
+/**
+ * Stores one tab
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ * @copyright Marina Glancy
+ */
+class tabobject implements renderable, templatable {
+ /** @var string unique id of the tab in this tree, it is used to find selected and/or inactive tabs */
+ public $id;
+ /** @var moodle_url|string link */
+ public $link;
+ /** @var string text on the tab */
+ public $text;
+ /** @var string title under the link, by defaul equals to text */
+ public $title;
+ /** @var bool whether to display a link under the tab name when it's selected */
+ public $linkedwhenselected = false;
+ /** @var bool whether the tab is inactive */
+ public $inactive = false;
+ /** @var bool indicates that this tab's child is selected */
+ public $activated = false;
+ /** @var bool indicates that this tab is selected */
+ public $selected = false;
+ /** @var array stores children tabobjects */
+ public $subtree = [];
+ /** @var int level of tab in the tree, 0 for root (instance of tabtree), 1 for the first row of tabs */
+ public $level = 1;
+
+ /**
+ * Constructor
+ *
+ * @param string $id unique id of the tab in this tree, it is used to find selected and/or inactive tabs
+ * @param string|moodle_url $link
+ * @param string $text text on the tab
+ * @param string $title title under the link, by defaul equals to text
+ * @param bool $linkedwhenselected whether to display a link under the tab name when it's selected
+ */
+ public function __construct($id, $link = null, $text = '', $title = '', $linkedwhenselected = false) {
+ $this->id = $id;
+ $this->link = $link;
+ $this->text = $text;
+ $this->title = $title ? $title : $text;
+ $this->linkedwhenselected = $linkedwhenselected;
+ }
+
+ /**
+ * Travels through tree and finds the tab to mark as selected, all parents are automatically marked as activated
+ *
+ * @param string $selected the id of the selected tab (whatever row it's on),
+ * if null marks all tabs as unselected
+ * @return bool whether this tab is selected or contains selected tab in its subtree
+ */
+ protected function set_selected($selected) {
+ if ((string)$selected === (string)$this->id) {
+ $this->selected = true;
+ // This tab is selected. No need to travel through subtree.
+ return true;
+ }
+ foreach ($this->subtree as $subitem) {
+ if ($subitem->set_selected($selected)) {
+ // This tab has child that is selected. Mark it as activated. No need to check other children.
+ $this->activated = true;
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Travels through tree and finds a tab with specified id
+ *
+ * @param string $id
+ * @return tabtree|null
+ */
+ public function find($id) {
+ if ((string)$this->id === (string)$id) {
+ return $this;
+ }
+ foreach ($this->subtree as $tab) {
+ if ($obj = $tab->find($id)) {
+ return $obj;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Allows to mark each tab's level in the tree before rendering.
+ *
+ * @param int $level
+ */
+ protected function set_level($level) {
+ $this->level = $level;
+ foreach ($this->subtree as $tab) {
+ $tab->set_level($level + 1);
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output Renderer.
+ * @return object
+ */
+ public function export_for_template(renderer_base $output) {
+ if ($this->inactive || ($this->selected && !$this->linkedwhenselected) || $this->activated) {
+ $link = null;
+ } else {
+ $link = $this->link;
+ }
+ $active = $this->activated || $this->selected;
+
+ return (object) [
+ 'id' => $this->id,
+ 'link' => is_object($link) ? $link->out(false) : $link,
+ 'text' => $this->text,
+ 'title' => $this->title,
+ 'inactive' => !$active && $this->inactive,
+ 'active' => $active,
+ 'level' => $this->level,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(tabobject::class, \tabobject::class);
diff --git a/lib/classes/output/tabtree.php b/lib/classes/output/tabtree.php
new file mode 100644
index 0000000000000..0c47b4cb69bf4
--- /dev/null
+++ b/lib/classes/output/tabtree.php
@@ -0,0 +1,98 @@
+.
+
+namespace core\output;
+
+/**
+ * Stores tabs list
+ *
+ * Example how to print a single line tabs:
+ * $rows = array(
+ * new tabobject(...),
+ * new tabobject(...)
+ * );
+ * echo $OUTPUT->tabtree($rows, $selectedid);
+ *
+ * Multiple row tabs may not look good on some devices but if you want to use them
+ * you can specify ->subtree for the active tabobject.
+ *
+ * @copyright 2013 Marina Glancy
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.5
+ * @package core
+ * @category output
+ */
+class tabtree extends tabobject {
+ /**
+ * Constuctor
+ *
+ * It is highly recommended to call constructor when list of tabs is already
+ * populated, this way you ensure that selected and inactive tabs are located
+ * and attribute level is set correctly.
+ *
+ * @param array $tabs array of tabs, each of them may have it's own ->subtree
+ * @param string|null $selected which tab to mark as selected, all parent tabs will
+ * automatically be marked as activated
+ * @param array|string|null $inactive list of ids of inactive tabs, regardless of
+ * their level. Note that you can as weel specify tabobject::$inactive for separate instances
+ */
+ public function __construct($tabs, $selected = null, $inactive = null) {
+ $this->subtree = $tabs;
+ if ($selected !== null) {
+ $this->set_selected($selected);
+ }
+ if ($inactive !== null) {
+ if (is_array($inactive)) {
+ foreach ($inactive as $id) {
+ if ($tab = $this->find($id)) {
+ $tab->inactive = true;
+ }
+ }
+ } else if ($tab = $this->find($inactive)) {
+ $tab->inactive = true;
+ }
+ }
+ $this->set_level(0);
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output Renderer.
+ * @return \stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $tabs = [];
+ $secondrow = false;
+
+ foreach ($this->subtree as $tab) {
+ $tabs[] = $tab->export_for_template($output);
+ if (!empty($tab->subtree) && ($tab->level == 0 || $tab->selected || $tab->activated)) {
+ $secondrow = new tabtree($tab->subtree);
+ }
+ }
+
+ return (object) [
+ 'tabs' => $tabs,
+ 'secondrow' => $secondrow ? $secondrow->export_for_template($output) : false,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(tabtree::class, \tabtree::class);
diff --git a/lib/classes/output/templatable.php b/lib/classes/output/templatable.php
new file mode 100644
index 0000000000000..007335e697f32
--- /dev/null
+++ b/lib/classes/output/templatable.php
@@ -0,0 +1,44 @@
+.
+
+namespace core\output;
+
+/**
+ * Interface marking other classes having the ability to export their data for use by templates.
+ *
+ * @copyright 2015 Damyon Wiese
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ * @category output
+ * @since 2.9
+ */
+interface templatable {
+ /**
+ * Function to export the renderer data in a format that is suitable for a
+ * mustache template. This means:
+ * 1. No complex types - only stdClass, array, int, string, float, bool
+ * 2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
+ *
+ * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
+ * @return \stdClass|array
+ */
+ public function export_for_template(renderer_base $output);
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(templatable::class, \templatable::class);
diff --git a/lib/classes/output/theme_config.php b/lib/classes/output/theme_config.php
new file mode 100644
index 0000000000000..ae937078c932d
--- /dev/null
+++ b/lib/classes/output/theme_config.php
@@ -0,0 +1,2344 @@
+.
+
+namespace core\output;
+
+use block_manager;
+use cache;
+use cache_store;
+use core_component;
+use core_cssparser;
+use core_minify;
+use core_php_time_limit;
+use core_rtlcss;
+use core_scss;
+use core_useragent;
+use core\context\system as context_system;
+use core\exception\coding_exception;
+use core\output\renderer_factory\renderer_factory_interface as renderer_factory;
+use core\output\renderer_factory\standard_renderer_factory;
+use dml_exception;
+use moodle_page;
+use moodle_url;
+use stdClass;
+
+// phpcs:disable moodle.NamingConventions.ValidVariableName.VariableNameUnderscore
+// phpcs:disable moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+/**
+ * This class represents the configuration variables of a Moodle theme.
+ *
+ * All the variables with access: public below (with a few exceptions that are marked)
+ * are the properties you can set in your themes config.php file.
+ *
+ * There are also some methods and protected variables that are part of the inner
+ * workings of Moodle's themes system. If you are just editing a themes config.php
+ * file, you can just ignore those, and the following information for developers.
+ *
+ * Normally, to create an instance of this class, you should use the
+ * {@see theme_config::load()} factory method to load a themes config.php file.
+ * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
+ * will create one for you, accessible as $PAGE->theme.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ * @category output
+ */
+class theme_config {
+ /**
+ * @var string Default theme, used when requested theme not found.
+ */
+ const DEFAULT_THEME = 'boost';
+
+ /** The key under which the SCSS file is stored amongst the CSS files. */
+ const SCSS_KEY = '__SCSS__';
+
+ /**
+ * @var array You can base your theme on other themes by linking to the other theme as
+ * parents. This lets you use the CSS and layouts from the other themes
+ * (see {@see theme_config::$layouts}).
+ * That makes it easy to create a new theme that is similar to another one
+ * but with a few changes. In this themes CSS you only need to override
+ * those rules you want to change.
+ */
+ public $parents;
+
+ /**
+ * @var array The names of all the stylesheets from this theme that you would
+ * like included, in order. Give the names of the files without .css.
+ */
+ public $sheets = [];
+
+ /**
+ * @var array The names of all the stylesheets from parents that should be excluded.
+ * true value may be used to specify all parents or all themes from one parent.
+ * If no value specified value from parent theme used.
+ */
+ public $parents_exclude_sheets = null;
+
+ /**
+ * @var array List of plugin sheets to be excluded.
+ * If no value specified value from parent theme used.
+ */
+ public $plugins_exclude_sheets = null;
+
+ /**
+ * @var array List of style sheets that are included in the text editor bodies.
+ * Sheets from parent themes are used automatically and can not be excluded.
+ */
+ public $editor_sheets = [];
+
+ /**
+ * @var bool Whether a fallback version of the stylesheet will be used
+ * whilst the final version is generated.
+ */
+ public $usefallback = false;
+
+ /**
+ * @var array The names of all the javascript files this theme that you would
+ * like included from head, in order. Give the names of the files without .js.
+ */
+ public $javascripts = [];
+
+ /**
+ * @var array The names of all the javascript files this theme that you would
+ * like included from footer, in order. Give the names of the files without .js.
+ */
+ public $javascripts_footer = [];
+
+ /**
+ * @var array The names of all the javascript files from parents that should
+ * be excluded. true value may be used to specify all parents or all themes
+ * from one parent.
+ * If no value specified value from parent theme used.
+ */
+ public $parents_exclude_javascripts = null;
+
+ /**
+ * @var array Which file to use for each page layout.
+ *
+ * This is an array of arrays. The keys of the outer array are the different layouts.
+ * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
+ * 'popup', 'form', .... The most reliable way to get a complete list is to look at
+ * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
+ * That file also has a good example of how to set this setting.
+ *
+ * For each layout, the value in the outer array is an array that describes
+ * how you want that type of page to look. For example
+ *
+ * $THEME->layouts = array(
+ * // Most pages - if we encounter an unknown or a missing page type, this one is used.
+ * 'standard' => array(
+ * 'theme' = 'mytheme',
+ * 'file' => 'normal.php',
+ * 'regions' => array('side-pre', 'side-post'),
+ * 'defaultregion' => 'side-post'
+ * ),
+ * // The site home page.
+ * 'home' => array(
+ * 'theme' = 'mytheme',
+ * 'file' => 'home.php',
+ * 'regions' => array('side-pre', 'side-post'),
+ * 'defaultregion' => 'side-post'
+ * ),
+ * // ...
+ * );
+ *
+ *
+ * 'theme' name of the theme where is the layout located
+ * 'file' is the layout file to use for this type of page.
+ * layout files are stored in layout subfolder
+ * 'regions' This lists the regions on the page where blocks may appear. For
+ * each region you list here, your layout file must include a call to
+ *
+ * echo $OUTPUT->blocks_for_region($regionname);
+ *
+ * or equivalent so that the blocks are actually visible.
+ *
+ * 'defaultregion' If the list of regions is non-empty, then you must pick
+ * one of the one of them as 'default'. This has two meanings. First, this is
+ * where new blocks are added. Second, if there are any blocks associated with
+ * the page, but in non-existent regions, they appear here. (Imaging, for example,
+ * that someone added blocks using a different theme that used different region
+ * names, and then switched to this theme.)
+ */
+ public $layouts = [];
+
+ /**
+ * @var string Name of the renderer factory class to use. Must implement the
+ * {@see renderer_factory} interface.
+ *
+ * This is an advanced feature. Moodle output is generated by 'renderers',
+ * you can customise the HTML that is output by writing custom renderers,
+ * and then you need to specify 'renderer factory' so that Moodle can find
+ * your renderers.
+ *
+ * There are some renderer factories supplied with Moodle. Please follow these
+ * links to see what they do.
+ *
+ * - {@see standard_renderer_factory} - the default.
+ * - {@see theme_overridden_renderer_factory} - use this if you want to write
+ * your own custom renderers in a lib.php file in this theme (or the parent theme).
+ *
+ */
+ public $rendererfactory = standard_renderer_factory::class;
+
+ /**
+ * @var string Function to do custom CSS post-processing.
+ *
+ * This is an advanced feature. If you want to do custom post-processing on the
+ * CSS before it is output (for example, to replace certain variable names
+ * with particular values) you can give the name of a function here.
+ */
+ public $csspostprocess = null;
+
+ /**
+ * @var string Function to do custom CSS post-processing on a parsed CSS tree.
+ *
+ * This is an advanced feature. If you want to do custom post-processing on the
+ * CSS before it is output, you can provide the name of the function here. The
+ * function will receive a CSS tree document as first parameter, and the theme_config
+ * object as second parameter. A return value is not required, the tree can
+ * be edited in place.
+ */
+ public $csstreepostprocessor = null;
+
+ /**
+ * @var string Accessibility: Right arrow-like character is
+ * used in the breadcrumb trail, course navigation menu
+ * (previous/next activity), calendar, and search forum block.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically. Please DO NOT
+ * use < > » - these are confusing for blind users.
+ */
+ public $rarrow = null;
+
+ /**
+ * @var string Accessibility: Left arrow-like character is
+ * used in the breadcrumb trail, course navigation menu
+ * (previous/next activity), calendar, and search forum block.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically. Please DO NOT
+ * use < > » - these are confusing for blind users.
+ */
+ public $larrow = null;
+
+ /**
+ * @var string Accessibility: Up arrow-like character is used in
+ * the book heirarchical navigation.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically. Please DO NOT
+ * use ^ - this is confusing for blind users.
+ */
+ public $uarrow = null;
+
+ /**
+ * @var string Accessibility: Down arrow-like character.
+ * If the theme does not set characters, appropriate defaults
+ * are set automatically.
+ */
+ public $darrow = null;
+
+ /**
+ * @var bool Some themes may want to disable ajax course editing.
+ */
+ public $enablecourseajax = true;
+
+ /**
+ * @var string Determines served document types
+ * - 'html5' the only officially supported doctype in Moodle
+ * - 'xhtml5' may be used in development for validation (not intended for production servers!)
+ * - 'xhtml' XHTML 1.0 Strict for legacy themes only
+ */
+ public $doctype = 'html5';
+
+ /**
+ * @var string|false requiredblocks If set to a string, will list the block types that cannot be deleted. Defaults to
+ * navigation and settings.
+ */
+ public $requiredblocks = false;
+
+ // The Following properties are not configurable from theme config.php.
+
+ /**
+ * @var string The name of this theme. Set automatically when this theme is
+ * loaded. This can not be set in theme config.php
+ */
+ public $name;
+
+ /**
+ * @var string The folder where this themes files are stored. This is set
+ * automatically. This can not be set in theme config.php
+ */
+ public $dir;
+
+ /**
+ * @var stdClass Theme settings stored in config_plugins table.
+ * This can not be set in theme config.php
+ */
+ public $settings = null;
+
+ /**
+ * @var bool If set to true and the theme enables the dock then blocks will be able
+ * to be moved to the special dock
+ */
+ public $enable_dock = false;
+
+ /**
+ * @var bool If set to true then this theme will not be shown in the theme selector unless
+ * theme designer mode is turned on.
+ */
+ public $hidefromselector = false;
+
+ /**
+ * @var array list of YUI CSS modules to be included on each page. This may be used
+ * to remove cssreset and use cssnormalise module instead.
+ */
+ public $yuicssmodules = ['cssreset', 'cssfonts', 'cssgrids', 'cssbase'];
+
+ /**
+ * An associative array of block manipulations that should be made if the user is using an rtl language.
+ * The key is the original block region, and the value is the block region to change to.
+ * This is used when displaying blocks for regions only.
+ * @var array
+ */
+ public $blockrtlmanipulations = [];
+
+ /**
+ * @var renderer_factory Instance of the renderer_factory implementation
+ * we are using. Implementation detail.
+ */
+ protected $rf = null;
+
+ /**
+ * @var array List of parent config objects.
+ **/
+ protected $parent_configs = [];
+
+ /**
+ * Used to determine whether we can serve SVG images or not.
+ * @var bool
+ */
+ private $usesvg = null;
+
+ /**
+ * Whether in RTL mode or not.
+ * @var bool
+ */
+ protected $rtlmode = false;
+
+ /**
+ * The SCSS file to compile (without .scss), located in the scss/ folder of the theme.
+ * Or a Closure, which receives the theme_config as argument and must
+ * return the SCSS content.
+ * @var string|Closure
+ */
+ public $scss = false;
+
+ /**
+ * Local cache of the SCSS property.
+ * @var false|array
+ */
+ protected $scsscache = null;
+
+ /**
+ * The name of the function to call to get the SCSS code to inject.
+ * @var string
+ */
+ public $extrascsscallback = null;
+
+ /**
+ * The name of the function to call to get SCSS to prepend.
+ * @var string
+ */
+ public $prescsscallback = null;
+
+ /**
+ * Sets the render method that should be used for rendering custom block regions by scripts such as my/index.php
+ * Defaults to {@see core_renderer::blocks_for_region()}
+ * @var string
+ */
+ public $blockrendermethod = null;
+
+ /**
+ * Remember the results of icon remapping for the current page.
+ * @var array
+ */
+ public $remapiconcache = [];
+
+ /**
+ * The name of the function to call to get precompiled CSS.
+ * @var string
+ */
+ public $precompiledcsscallback = null;
+
+ /**
+ * Whether the theme uses course index.
+ * @var bool
+ */
+ public $usescourseindex = false;
+
+ /**
+ * Configuration for the page activity header
+ * @var array
+ */
+ public $activityheaderconfig = [];
+
+ /**
+ * For backward compatibility with old themes.
+ * BLOCK_ADDBLOCK_POSITION_DEFAULT, BLOCK_ADDBLOCK_POSITION_FLATNAV.
+ * @var int
+ */
+ public $addblockposition;
+
+ /**
+ * editor_scss file(s) provided by this theme.
+ * @var array
+ */
+ public $editor_scss;
+
+ /**
+ * Name of the class extending \core\output\icon_system.
+ * @var string
+ */
+ public $iconsystem;
+
+ /**
+ * Theme defines its own editing mode switch.
+ * @var bool
+ */
+ public $haseditswitch = false;
+
+ /**
+ * Allows a theme to customise primary navigation by specifying the list of items to remove.
+ * @var array
+ */
+ public $removedprimarynavitems = [];
+
+ /**
+ * Load the config.php file for a particular theme, and return an instance
+ * of this class. (That is, this is a factory method.)
+ *
+ * @param string $themename the name of the theme.
+ * @return theme_config an instance of this class.
+ */
+ public static function load($themename) {
+ global $CFG;
+
+ // Load theme settings from db.
+ try {
+ $settings = get_config('theme_' . $themename);
+ } catch (dml_exception $e) {
+ // Most probably moodle tables not created yet.
+ $settings = new stdClass();
+ }
+
+ if ($config = self::find_theme_config($themename, $settings)) {
+ return new self($config);
+ } else if ($themename == self::DEFAULT_THEME) {
+ throw new coding_exception('Default theme ' . self::DEFAULT_THEME . ' not available or broken!');
+ } else if ($config = self::find_theme_config($CFG->theme, $settings)) {
+ debugging('This page should be using theme ' . $themename .
+ ' which cannot be initialised. Falling back to the site theme ' . $CFG->theme, DEBUG_NORMAL);
+ return new self($config);
+ } else {
+ // Bad luck, the requested theme has some problems - admin see details in theme config.
+ debugging('This page should be using theme ' . $themename .
+ ' which cannot be initialised. Nor can the site theme ' . $CFG->theme .
+ '. Falling back to ' . self::DEFAULT_THEME, DEBUG_NORMAL);
+ return new self(self::find_theme_config(self::DEFAULT_THEME, $settings));
+ }
+ }
+
+ /**
+ * Theme diagnostic code. It is very problematic to send debug output
+ * to the actual CSS file, instead this functions is supposed to
+ * diagnose given theme and highlights all potential problems.
+ * This information should be available from the theme selection page
+ * or some other debug page for theme designers.
+ *
+ * @param string $themename
+ * @return array description of problems
+ */
+ public static function diagnose($themename) {
+ // TODO: MDL-21108.
+ return [];
+ }
+
+ /**
+ * Private constructor, can be called only from the factory method.
+ * @param stdClass $config
+ */
+ private function __construct($config) {
+ global $CFG; // Needed for included lib.php files.
+
+ $this->settings = $config->settings;
+ $this->name = $config->name;
+ $this->dir = $config->dir;
+
+ if ($this->name != self::DEFAULT_THEME) {
+ $baseconfig = self::find_theme_config(self::DEFAULT_THEME, $this->settings);
+ } else {
+ $baseconfig = $config;
+ }
+
+ // Ensure that each of the configurable properties defined below are also defined at the class level.
+ $configurable = [
+ 'parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'usefallback',
+ 'javascripts', 'javascripts_footer', 'parents_exclude_javascripts',
+ 'layouts', 'enablecourseajax', 'requiredblocks',
+ 'rendererfactory', 'csspostprocess', 'editor_sheets', 'editor_scss', 'rarrow', 'larrow', 'uarrow', 'darrow',
+ 'hidefromselector', 'doctype', 'yuicssmodules', 'blockrtlmanipulations', 'blockrendermethod',
+ 'scss', 'extrascsscallback', 'prescsscallback', 'csstreepostprocessor', 'addblockposition',
+ 'iconsystem', 'precompiledcsscallback', 'haseditswitch', 'usescourseindex', 'activityheaderconfig',
+ 'removedprimarynavitems',
+ ];
+
+ foreach ($config as $key => $value) {
+ if (in_array($key, $configurable)) {
+ $this->$key = $value;
+ }
+ }
+
+ // Verify all parents and load configs and renderers.
+ foreach ($this->parents as $parent) {
+ if (!$parent_config = self::find_theme_config($parent, $this->settings)) {
+ // This is not good - better exclude faulty parents.
+ continue;
+ }
+ $libfile = $parent_config->dir . '/lib.php';
+ if (is_readable($libfile)) {
+ // Theme may store various function here.
+ include_once($libfile);
+ }
+ $renderersfile = $parent_config->dir . '/renderers.php';
+ if (is_readable($renderersfile)) {
+ // May contain core and plugin renderers and renderer factory.
+ include_once($renderersfile);
+ }
+ $this->parent_configs[$parent] = $parent_config;
+ }
+ $libfile = $this->dir . '/lib.php';
+ if (is_readable($libfile)) {
+ // Theme may store various function here.
+ include_once($libfile);
+ }
+ $rendererfile = $this->dir . '/renderers.php';
+ if (is_readable($rendererfile)) {
+ // May contain core and plugin renderers and renderer factory.
+ include_once($rendererfile);
+ } else {
+ // Check if renderers.php file is missnamed renderer.php.
+ if (is_readable($this->dir . '/renderer.php')) {
+ debugging('Developer hint: ' . $this->dir . '/renderer.php should be renamed to ' . $this->dir . "/renderers.php.
+ See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
+ }
+ }
+
+ // Cascade all layouts properly.
+ foreach ($baseconfig->layouts as $layout => $value) {
+ if (!isset($this->layouts[$layout])) {
+ foreach ($this->parent_configs as $parent_config) {
+ if (isset($parent_config->layouts[$layout])) {
+ $this->layouts[$layout] = $parent_config->layouts[$layout];
+ continue 2;
+ }
+ }
+ $this->layouts[$layout] = $value;
+ }
+ }
+
+ // Fix arrows if needed.
+ $this->check_theme_arrows();
+ }
+
+ /**
+ * Let the theme initialise the page object (usually $PAGE).
+ *
+ * This may be used for example to request jQuery in add-ons.
+ *
+ * @param moodle_page $page
+ */
+ public function init_page(moodle_page $page) {
+ $themeinitfunction = 'theme_' . $this->name . '_page_init';
+ if (function_exists($themeinitfunction)) {
+ $themeinitfunction($page);
+ }
+ }
+
+ /**
+ * Checks if arrows $THEME->rarrow, $THEME->larrow, $THEME->uarrow, $THEME->darrow have been set (theme/-/config.php).
+ * If not it applies sensible defaults.
+ *
+ * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
+ * search forum block, etc. Important: these are 'silent' in a screen-reader
+ * (unlike > »), and must be accompanied by text.
+ */
+ private function check_theme_arrows() {
+ if (!isset($this->rarrow) && !isset($this->larrow)) {
+ // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
+ // Also OK in Win 9x/2K/IE 5.x.
+ $this->rarrow = '►';
+ $this->larrow = '◄';
+ $this->uarrow = '▲';
+ $this->darrow = '▼';
+ if (empty($_SERVER['HTTP_USER_AGENT'])) {
+ $uagent = '';
+ } else {
+ $uagent = $_SERVER['HTTP_USER_AGENT'];
+ }
+ if (
+ false !== strpos($uagent, 'Opera')
+ || false !== strpos($uagent, 'Mac')
+ ) {
+ // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
+ // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
+ $this->rarrow = '▶︎';
+ $this->larrow = '◀︎';
+ } else if (
+ (false !== strpos($uagent, 'Konqueror'))
+ || (false !== strpos($uagent, 'Android'))
+ ) {
+ // The fonts on Android don't include the characters required for this to work as expected.
+ // So we use the same ones Konqueror uses.
+ $this->rarrow = '→';
+ $this->larrow = '←';
+ $this->uarrow = '↑';
+ $this->darrow = '↓';
+ } else if (
+ isset($_SERVER['HTTP_ACCEPT_CHARSET'])
+ && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')
+ ) {
+ // Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.
+ // To be safe, non-Unicode browsers!
+ $this->rarrow = '>';
+ $this->larrow = '<';
+ $this->uarrow = '^';
+ $this->darrow = 'v';
+ }
+
+ // RTL support - in RTL languages, swap r and l arrows.
+ if (right_to_left()) {
+ $t = $this->rarrow;
+ $this->rarrow = $this->larrow;
+ $this->larrow = $t;
+ }
+ }
+ }
+
+ /**
+ * Returns output renderer prefixes, these are used when looking
+ * for the overridden renderers in themes.
+ *
+ * @return array
+ */
+ public function renderer_prefixes() {
+ global $CFG; // Just in case the included files need it.
+
+ $prefixes = ['theme_' . $this->name];
+
+ foreach ($this->parent_configs as $parent) {
+ $prefixes[] = 'theme_' . $parent->name;
+ }
+
+ return $prefixes;
+ }
+
+ /**
+ * Returns the stylesheet URL of this editor content
+ *
+ * @param bool $encoded false means use & and true use & in URLs
+ * @return moodle_url
+ */
+ public function editor_css_url($encoded = true) {
+ global $CFG;
+ $rev = theme_get_revision();
+ $type = 'editor';
+ if (right_to_left()) {
+ $type .= '-rtl';
+ }
+
+ if ($rev > -1) {
+ $themesubrevision = theme_get_sub_revision_for_theme($this->name);
+
+ // Provide the sub revision to allow us to invalidate cached theme CSS
+ // on a per theme basis, rather than globally.
+ if ($themesubrevision && $themesubrevision > 0) {
+ $rev .= "_{$themesubrevision}";
+ }
+
+ $url = new moodle_url("/theme/styles.php");
+ if (!empty($CFG->slasharguments)) {
+ $url->set_slashargument("/{$this->name}/{$rev}/{$type}", 'noparam', true);
+ } else {
+ $url->params([
+ 'theme' => $this->name,
+ 'rev' => $rev,
+ 'type' => $type,
+ ]);
+ }
+ } else {
+ $url = new moodle_url('/theme/styles_debug.php', [
+ 'theme' => $this->name,
+ 'type' => $type,
+ ]);
+ }
+ return $url;
+ }
+
+ /**
+ * Returns the content of the CSS to be used in editor content
+ *
+ * @return array
+ */
+ public function editor_css_files() {
+ $files = [];
+
+ // First editor plugins.
+ $plugins = core_component::get_plugin_list('editor');
+ foreach ($plugins as $plugin => $fulldir) {
+ $sheetfile = "$fulldir/editor_styles.css";
+ if (is_readable($sheetfile)) {
+ $files['plugin_' . $plugin] = $sheetfile;
+ }
+
+ $subplugintypes = core_component::get_subplugins("editor_{$plugin}") ?? [];
+ // Fetch sheets for any editor subplugins.
+ foreach ($subplugintypes as $plugintype => $subplugins) {
+ foreach ($subplugins as $subplugin) {
+ $plugindir = core_component::get_plugin_directory($plugintype, $subplugin);
+ $sheetfile = "{$plugindir}/editor_styles.css";
+ if (is_readable($sheetfile)) {
+ $files["{$plugintype}_{$subplugin}"] = $sheetfile;
+ }
+ }
+ }
+ }
+
+ // Then parent themes - base first, the immediate parent last.
+ foreach (array_reverse($this->parent_configs) as $parent_config) {
+ if (empty($parent_config->editor_sheets)) {
+ continue;
+ }
+ foreach ($parent_config->editor_sheets as $sheet) {
+ $sheetfile = "$parent_config->dir/style/$sheet.css";
+ if (is_readable($sheetfile)) {
+ $files['parent_' . $parent_config->name . '_' . $sheet] = $sheetfile;
+ }
+ }
+ }
+ // Finally this theme.
+ if (!empty($this->editor_sheets)) {
+ foreach ($this->editor_sheets as $sheet) {
+ $sheetfile = "$this->dir/style/$sheet.css";
+ if (is_readable($sheetfile)) {
+ $files['theme_' . $sheet] = $sheetfile;
+ }
+ }
+ }
+
+ return $files;
+ }
+
+ /**
+ * Compiles and returns the content of the SCSS to be used in editor content
+ *
+ * @return string Compiled CSS from the editor SCSS
+ */
+ public function editor_scss_to_css() {
+ $css = '';
+ $dir = $this->dir;
+ $filenames = [];
+
+ // Use editor_scss file(s) provided by this theme if set.
+ if (!empty($this->editor_scss)) {
+ $filenames = $this->editor_scss;
+ } else {
+ // If no editor_scss set, move up theme hierarchy until one is found (if at all).
+ // This is so child themes only need to set editor_scss if an override is required.
+ foreach (array_reverse($this->parent_configs) as $parentconfig) {
+ if (!empty($parentconfig->editor_scss)) {
+ $dir = $parentconfig->dir;
+ $filenames = $parentconfig->editor_scss;
+
+ // Config found, stop looking.
+ break;
+ }
+ }
+ }
+
+ if (!empty($filenames)) {
+ $compiler = new core_scss();
+
+ foreach ($filenames as $filename) {
+ $compiler->set_file("{$dir}/scss/{$filename}.scss");
+
+ try {
+ $css .= $compiler->to_css();
+ } catch (\Exception $e) {
+ debugging('Error while compiling editor SCSS: ' . $e->getMessage(), DEBUG_DEVELOPER);
+ }
+ }
+ }
+
+ return $css;
+ }
+
+ /**
+ * Get the stylesheet URL of this theme.
+ *
+ * @param moodle_page $page Not used... deprecated?
+ * @return moodle_url[]
+ */
+ public function css_urls(moodle_page $page) {
+ global $CFG;
+
+ $rev = theme_get_revision();
+
+ $urls = [];
+
+ $svg = $this->use_svg_icons();
+ $separate = (core_useragent::is_ie() && !core_useragent::check_ie_version('10'));
+
+ if ($rev > -1) {
+ $filename = right_to_left() ? 'all-rtl' : 'all';
+ $url = new moodle_url("/theme/styles.php");
+ $themesubrevision = theme_get_sub_revision_for_theme($this->name);
+
+ // Provide the sub revision to allow us to invalidate cached theme CSS
+ // on a per theme basis, rather than globally.
+ if ($themesubrevision && $themesubrevision > 0) {
+ $rev .= "_{$themesubrevision}";
+ }
+
+ if (!empty($CFG->slasharguments)) {
+ $slashargs = '';
+ if (!$svg) {
+ // We add a simple /_s to the start of the path.
+ // The underscore is used to ensure that it isn't a valid theme name.
+ $slashargs .= '/_s' . $slashargs;
+ }
+ $slashargs .= '/' . $this->name . '/' . $rev . '/' . $filename;
+ if ($separate) {
+ $slashargs .= '/chunk0';
+ }
+ $url->set_slashargument($slashargs, 'noparam', true);
+ } else {
+ $params = ['theme' => $this->name, 'rev' => $rev, 'type' => $filename];
+ if (!$svg) {
+ // We add an SVG param so that we know not to serve SVG images.
+ // We do this because all modern browsers support SVG and this param will one day be removed.
+ $params['svg'] = '0';
+ }
+ if ($separate) {
+ $params['chunk'] = '0';
+ }
+ $url->params($params);
+ }
+ $urls[] = $url;
+ } else {
+ $baseurl = new moodle_url('/theme/styles_debug.php');
+
+ $css = $this->get_css_files(true);
+ if (!$svg) {
+ // We add an SVG param so that we know not to serve SVG images.
+ // We do this because all modern browsers support SVG and this param will one day be removed.
+ $baseurl->param('svg', '0');
+ }
+ if (right_to_left()) {
+ $baseurl->param('rtl', 1);
+ }
+ if ($separate) {
+ // We might need to chunk long files.
+ $baseurl->param('chunk', '0');
+ }
+ if (core_useragent::is_ie()) {
+ // Lalala, IE does not allow more than 31 linked CSS files from main document.
+ $urls[] = new moodle_url($baseurl, ['theme' => $this->name, 'type' => 'ie', 'subtype' => 'plugins']);
+ foreach ($css['parents'] as $parent => $sheets) {
+ // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096).
+ $urls[] = new moodle_url($baseurl, [
+ 'theme' => $this->name,
+ 'type' => 'ie',
+ 'subtype' => 'parents',
+ 'sheet' => $parent,
+ ]);
+ }
+ if ($this->get_scss_property()) {
+ // No need to define the type as IE here.
+ $urls[] = new moodle_url($baseurl, ['theme' => $this->name, 'type' => 'scss']);
+ }
+ $urls[] = new moodle_url($baseurl, ['theme' => $this->name, 'type' => 'ie', 'subtype' => 'theme']);
+ } else {
+ foreach ($css['plugins'] as $plugin => $unused) {
+ $urls[] = new moodle_url($baseurl, ['theme' => $this->name, 'type' => 'plugin', 'subtype' => $plugin]);
+ }
+ foreach ($css['parents'] as $parent => $sheets) {
+ foreach ($sheets as $sheet => $unused2) {
+ $urls[] = new moodle_url($baseurl, [
+ 'theme' => $this->name,
+ 'type' => 'parent',
+ 'subtype' => $parent,
+ 'sheet' => $sheet,
+ ]);
+ }
+ }
+ foreach ($css['theme'] as $sheet => $filename) {
+ if ($sheet === self::SCSS_KEY) {
+ // This is the theme SCSS file.
+ $urls[] = new moodle_url($baseurl, ['theme' => $this->name, 'type' => 'scss']);
+ } else {
+ // Sheet first in order to make long urls easier to read.
+ $urls[] = new moodle_url($baseurl, ['sheet' => $sheet, 'theme' => $this->name, 'type' => 'theme']);
+ }
+ }
+ }
+ }
+
+ // Allow themes to change the css url to something like theme/mytheme/mycss.php.
+ component_callback('theme_' . $this->name, 'alter_css_urls', [&$urls]);
+ return $urls;
+ }
+
+ /**
+ * Get the whole css stylesheet for production mode.
+ *
+ * NOTE: this method is not expected to be used from any addons.
+ *
+ * @return string CSS markup compressed
+ */
+ public function get_css_content() {
+
+ $csscontent = '';
+ foreach ($this->get_css_files(false) as $type => $value) {
+ foreach ($value as $identifier => $val) {
+ if (is_array($val)) {
+ foreach ($val as $v) {
+ $csscontent .= file_get_contents($v) . "\n";
+ }
+ } else {
+ if ($type === 'theme' && $identifier === self::SCSS_KEY) {
+ // We need the content from SCSS because this is the SCSS file from the theme.
+ if ($compiled = $this->get_css_content_from_scss(false)) {
+ $csscontent .= $compiled;
+ } else {
+ // The compiler failed so default back to any precompiled css that might
+ // exist.
+ $csscontent .= $this->get_precompiled_css_content();
+ }
+ } else {
+ $csscontent .= file_get_contents($val) . "\n";
+ }
+ }
+ }
+ }
+ $csscontent = $this->post_process($csscontent);
+ $csscontent = core_minify::css($csscontent);
+
+ return $csscontent;
+ }
+ /**
+ * Set post processed CSS content cache.
+ *
+ * @param string $csscontent The post processed CSS content.
+ * @return bool True if the content was successfully cached.
+ */
+ public function set_css_content_cache($csscontent) {
+
+ $cache = cache::make('core', 'postprocessedcss');
+ $key = $this->get_css_cache_key();
+
+ return $cache->set($key, $csscontent);
+ }
+
+ /**
+ * Return whether the post processed CSS content has been cached.
+ *
+ * @return bool Whether the post-processed CSS is available in the cache.
+ */
+ public function has_css_cached_content() {
+
+ $key = $this->get_css_cache_key();
+ $cache = cache::make('core', 'postprocessedcss');
+
+ return $cache->has($key);
+ }
+
+ /**
+ * Return cached post processed CSS content.
+ *
+ * @return bool|string The cached css content or false if not found.
+ */
+ public function get_css_cached_content() {
+
+ $key = $this->get_css_cache_key();
+ $cache = cache::make('core', 'postprocessedcss');
+
+ return $cache->get($key);
+ }
+
+ /**
+ * Generate the css content cache key.
+ *
+ * @return string The post processed css cache key.
+ */
+ public function get_css_cache_key() {
+ $nosvg = (!$this->use_svg_icons()) ? 'nosvg_' : '';
+ $rtlmode = ($this->rtlmode == true) ? 'rtl' : 'ltr';
+
+ return $nosvg . $this->name . '_' . $rtlmode;
+ }
+
+ /**
+ * Get the theme designer css markup,
+ * the parameters are coming from css_urls().
+ *
+ * NOTE: this method is not expected to be used from any addons.
+ *
+ * @param string $type
+ * @param string $subtype
+ * @param string $sheet
+ * @return string CSS markup
+ */
+ public function get_css_content_debug($type, $subtype, $sheet) {
+ if ($type === 'scss') {
+ // The SCSS file of the theme is requested.
+ $csscontent = $this->get_css_content_from_scss(true);
+ if ($csscontent !== false) {
+ return $this->post_process($csscontent);
+ }
+ return '';
+ }
+
+ $cssfiles = [];
+ $css = $this->get_css_files(true);
+
+ if ($type === 'ie') {
+ // IE is a sloppy browser with weird limits, sorry.
+ if ($subtype === 'plugins') {
+ $cssfiles = $css['plugins'];
+ } else if ($subtype === 'parents') {
+ if (empty($sheet)) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf
+ // Do not bother with the empty parent here.
+ } else {
+ // Build up the CSS for that parent so we can serve it as one file.
+ foreach ($css[$subtype][$sheet] as $parent => $css) {
+ $cssfiles[] = $css;
+ }
+ }
+ } else if ($subtype === 'theme') {
+ $cssfiles = $css['theme'];
+ foreach ($cssfiles as $key => $value) {
+ if (in_array($key, [self::SCSS_KEY])) {
+ // Remove the SCSS file from the theme CSS files.
+ // The SCSS files use the type 'scss', not 'ie'.
+ unset($cssfiles[$key]);
+ }
+ }
+ }
+ } else if ($type === 'plugin') {
+ if (isset($css['plugins'][$subtype])) {
+ $cssfiles[] = $css['plugins'][$subtype];
+ }
+ } else if ($type === 'parent') {
+ if (isset($css['parents'][$subtype][$sheet])) {
+ $cssfiles[] = $css['parents'][$subtype][$sheet];
+ }
+ } else if ($type === 'theme') {
+ if (isset($css['theme'][$sheet])) {
+ $cssfiles[] = $css['theme'][$sheet];
+ }
+ }
+
+ $csscontent = '';
+ foreach ($cssfiles as $file) {
+ $contents = file_get_contents($file);
+ $contents = $this->post_process($contents);
+ $comment = "/** Path: $type $subtype $sheet.' **/\n";
+ $stats = '';
+ $csscontent .= $comment . $stats . $contents . "\n\n";
+ }
+
+ return $csscontent;
+ }
+
+ /**
+ * Get the whole css stylesheet for editor iframe.
+ *
+ * NOTE: this method is not expected to be used from any addons.
+ *
+ * @return string CSS markup
+ */
+ public function get_css_content_editor() {
+ $css = '';
+ $cssfiles = $this->editor_css_files();
+
+ // If editor has static CSS, include it.
+ foreach ($cssfiles as $file) {
+ $css .= file_get_contents($file) . "\n";
+ }
+
+ // If editor has SCSS, compile and include it.
+ if (($convertedscss = $this->editor_scss_to_css())) {
+ $css .= $convertedscss;
+ }
+
+ $output = $this->post_process($css);
+
+ return $output;
+ }
+
+ /**
+ * Returns an array of organised CSS files required for this output.
+ *
+ * @param bool $themedesigner
+ * @return array nested array of file paths
+ */
+ protected function get_css_files($themedesigner) {
+ global $CFG;
+
+ $cache = null;
+ $cachekey = 'cssfiles';
+ if ($themedesigner) {
+ require_once($CFG->dirroot . '/lib/csslib.php');
+ // We need some kind of caching here because otherwise the page navigation becomes
+ // way too slow in theme designer mode. Feel free to create full cache definition later...
+ $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner', ['theme' => $this->name]);
+ if ($files = $cache->get($cachekey)) {
+ if ($files['created'] > time() - THEME_DESIGNER_CACHE_LIFETIME) {
+ unset($files['created']);
+ return $files;
+ }
+ }
+ }
+
+ $cssfiles = ['plugins' => [], 'parents' => [], 'theme' => []];
+
+ // Get all plugin sheets.
+ $excludes = $this->resolve_excludes('plugins_exclude_sheets');
+ if ($excludes !== true) {
+ foreach (core_component::get_plugin_types() as $type => $unused) {
+ if ($type === 'theme' || (!empty($excludes[$type]) && $excludes[$type] === true)) {
+ continue;
+ }
+ $plugins = core_component::get_plugin_list($type);
+ foreach ($plugins as $plugin => $fulldir) {
+ if (
+ !empty($excludes[$type])
+ && is_array($excludes[$type])
+ && in_array($plugin, $excludes[$type])
+ ) {
+ continue;
+ }
+
+ // Get the CSS from the plugin.
+ $sheetfile = "$fulldir/styles.css";
+ if (is_readable($sheetfile)) {
+ $cssfiles['plugins'][$type . '_' . $plugin] = $sheetfile;
+ }
+
+ // Create a list of candidate sheets from parents (direct parent last) and current theme.
+ $candidates = [];
+ foreach (array_reverse($this->parent_configs) as $parent_config) {
+ $candidates[] = $parent_config->name;
+ }
+ $candidates[] = $this->name;
+
+ // Add the sheets found.
+ foreach ($candidates as $candidate) {
+ $sheetthemefile = "$fulldir/styles_{$candidate}.css";
+ if (is_readable($sheetthemefile)) {
+ $cssfiles['plugins'][$type . '_' . $plugin . '_' . $candidate] = $sheetthemefile;
+ }
+ }
+ }
+ }
+ }
+
+ // Find out wanted parent sheets.
+ $excludes = $this->resolve_excludes('parents_exclude_sheets');
+ if ($excludes !== true) {
+ foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
+ $parent = $parent_config->name;
+ if (empty($parent_config->sheets) || (!empty($excludes[$parent]) && $excludes[$parent] === true)) {
+ continue;
+ }
+ foreach ($parent_config->sheets as $sheet) {
+ if (
+ !empty($excludes[$parent]) && is_array($excludes[$parent])
+ && in_array($sheet, $excludes[$parent])
+ ) {
+ continue;
+ }
+
+ // We never refer to the parent LESS files.
+ $sheetfile = "$parent_config->dir/style/$sheet.css";
+ if (is_readable($sheetfile)) {
+ $cssfiles['parents'][$parent][$sheet] = $sheetfile;
+ }
+ }
+ }
+ }
+
+ // Current theme sheets.
+ // We first add the SCSS file because we want the CSS ones to
+ // be included after the SCSS code.
+ if ($this->get_scss_property()) {
+ $cssfiles['theme'][self::SCSS_KEY] = true;
+ }
+ if (is_array($this->sheets)) {
+ foreach ($this->sheets as $sheet) {
+ $sheetfile = "$this->dir/style/$sheet.css";
+ if (is_readable($sheetfile) && !isset($cssfiles['theme'][$sheet])) {
+ $cssfiles['theme'][$sheet] = $sheetfile;
+ }
+ }
+ }
+
+ if ($cache) {
+ $files = $cssfiles;
+ $files['created'] = time();
+ $cache->set($cachekey, $files);
+ }
+ return $cssfiles;
+ }
+
+ /**
+ * Return the CSS content generated from the SCSS file.
+ *
+ * @param bool $themedesigner True if theme designer is enabled.
+ * @return bool|string Return false when the compilation failed. Else the compiled string.
+ */
+ protected function get_css_content_from_scss($themedesigner) {
+ global $CFG;
+
+ [$paths, $scss] = $this->get_scss_property();
+ if (!$scss) {
+ throw new coding_exception('The theme did not define a SCSS file, or it is not readable.');
+ }
+
+ // We might need more memory/time to do this, so let's play safe.
+ raise_memory_limit(MEMORY_EXTRA);
+ core_php_time_limit::raise(300);
+
+ // TODO: MDL-62757 When changing anything in this method please do not forget to check
+ // if the validate() method in class admin_setting_configthemepreset needs updating too.
+
+ $cachedir = make_localcache_directory('scsscache-' . $this->name, false);
+ $cacheoptions = [];
+ if ($themedesigner) {
+ $cacheoptions = [
+ 'cacheDir' => $cachedir,
+ 'prefix' => 'scssphp_',
+ 'forceRefresh' => false,
+ ];
+ } else {
+ if (file_exists($cachedir)) {
+ remove_dir($cachedir);
+ }
+ }
+
+ // Set-up the compiler.
+ $compiler = new core_scss($cacheoptions);
+
+ if ($this->supports_source_maps($themedesigner)) {
+ // Enable source maps.
+ $compiler->setSourceMapOptions([
+ 'sourceMapBasepath' => str_replace('\\', '/', $CFG->dirroot),
+ 'sourceMapRootpath' => $CFG->wwwroot . '/',
+ ]);
+ $compiler->setSourceMap($compiler::SOURCE_MAP_INLINE);
+ }
+
+ $compiler->prepend_raw_scss($this->get_pre_scss_code());
+ if (is_string($scss)) {
+ $compiler->set_file($scss);
+ } else {
+ $compiler->append_raw_scss($scss($this));
+ $compiler->setImportPaths($paths);
+ }
+ $compiler->append_raw_scss($this->get_extra_scss_code());
+
+ try {
+ // Compile!
+ $compiled = $compiler->to_css();
+ } catch (\Exception $e) {
+ $compiled = false;
+ debugging('Error while compiling SCSS: ' . $e->getMessage(), DEBUG_DEVELOPER);
+ }
+
+ // Try to save memory.
+ $compiler = null;
+ unset($compiler);
+
+ return $compiled;
+ }
+
+ /**
+ * Return the precompiled CSS if the precompiledcsscallback exists.
+ *
+ * @return string Return compiled css.
+ */
+ public function get_precompiled_css_content() {
+ $configs = array_reverse($this->parent_configs) + [$this];
+ $css = '';
+
+ foreach ($configs as $config) {
+ if (isset($config->precompiledcsscallback)) {
+ $function = $config->precompiledcsscallback;
+ if (function_exists($function)) {
+ $css .= $function($this);
+ }
+ }
+ }
+ return $css;
+ }
+
+ /**
+ * Get the icon system to use.
+ *
+ * @return string
+ */
+ public function get_icon_system() {
+
+ // Getting all the candidate functions.
+ $system = false;
+ if (isset($this->iconsystem) && icon_system::is_valid_system($this->iconsystem)) {
+ return $this->iconsystem;
+ }
+ foreach ($this->parent_configs as $parent_config) {
+ if (isset($parent_config->iconsystem) && icon_system::is_valid_system($parent_config->iconsystem)) {
+ return $parent_config->iconsystem;
+ }
+ }
+ return icon_system::STANDARD;
+ }
+
+ /**
+ * Return extra SCSS code to add when compiling.
+ *
+ * This is intended to be used by themes to inject some SCSS code
+ * before it gets compiled. If you want to inject variables you
+ * should use {@see self::get_scss_variables()}.
+ *
+ * @return string The SCSS code to inject.
+ */
+ public function get_extra_scss_code() {
+ $content = '';
+
+ // Getting all the candidate functions.
+ $candidates = [];
+ foreach (array_reverse($this->parent_configs) as $parent_config) {
+ if (!isset($parent_config->extrascsscallback)) {
+ continue;
+ }
+ $candidates[] = $parent_config->extrascsscallback;
+ }
+
+ if (isset($this->extrascsscallback)) {
+ $candidates[] = $this->extrascsscallback;
+ }
+
+ // Calling the functions.
+ foreach ($candidates as $function) {
+ if (function_exists($function)) {
+ $content .= "\n/** Extra SCSS from $function **/\n" . $function($this) . "\n";
+ }
+ }
+
+ return $content;
+ }
+
+ /**
+ * SCSS code to prepend when compiling.
+ *
+ * This is intended to be used by themes to inject SCSS code before it gets compiled.
+ *
+ * @return string The SCSS code to inject.
+ */
+ public function get_pre_scss_code() {
+ $content = '';
+
+ // Getting all the candidate functions.
+ $candidates = [];
+ foreach (array_reverse($this->parent_configs) as $parent_config) {
+ if (!isset($parent_config->prescsscallback)) {
+ continue;
+ }
+ $candidates[] = $parent_config->prescsscallback;
+ }
+
+ if (isset($this->prescsscallback)) {
+ $candidates[] = $this->prescsscallback;
+ }
+
+ // Calling the functions.
+ foreach ($candidates as $function) {
+ if (function_exists($function)) {
+ $content .= "\n/** Pre-SCSS from $function **/\n" . $function($this) . "\n";
+ }
+ }
+
+ return $content;
+ }
+
+ /**
+ * Get the SCSS property.
+ *
+ * This resolves whether a SCSS file (or content) has to be used when generating
+ * the stylesheet for the theme. It will look at parents themes and check the
+ * SCSS properties there.
+ *
+ * @return array|false False when SCSS is not used.
+ * An array with the import paths, and the path to the SCSS file or Closure as second.
+ */
+ public function get_scss_property() {
+ if ($this->scsscache === null) {
+ $configs = [$this] + $this->parent_configs;
+ $scss = null;
+
+ foreach ($configs as $config) {
+ $path = "{$config->dir}/scss";
+
+ // We collect the SCSS property until we've found one.
+ if (empty($scss) && !empty($config->scss)) {
+ $candidate = is_string($config->scss) ? "{$path}/{$config->scss}.scss" : $config->scss;
+ if ($candidate instanceof \Closure) {
+ $scss = $candidate;
+ } else if (is_string($candidate) && is_readable($candidate)) {
+ $scss = $candidate;
+ }
+ }
+
+ // We collect the import paths once we've found a SCSS property.
+ if ($scss && is_dir($path)) {
+ $paths[] = $path;
+ }
+ }
+
+ $this->scsscache = $scss !== null ? [$paths, $scss] : false;
+ }
+
+ return $this->scsscache;
+ }
+
+ /**
+ * Generate a URL to the file that serves theme JavaScript files.
+ *
+ * If we determine that the theme has no relevant files, then we return
+ * early with a null value.
+ *
+ * @param bool $inhead true means head url, false means footer
+ * @return moodle_url|null
+ */
+ public function javascript_url($inhead) {
+ global $CFG;
+
+ $rev = theme_get_revision();
+ $params = ['theme' => $this->name, 'rev' => $rev];
+ $params['type'] = $inhead ? 'head' : 'footer';
+
+ // Return early if there are no files to serve.
+ if (count($this->javascript_files($params['type'])) === 0) {
+ return null;
+ }
+
+ if (!empty($CFG->slasharguments) && $rev > 0) {
+ $url = new moodle_url("/theme/javascript.php");
+ $url->set_slashargument('/' . $this->name . '/' . $rev . '/' . $params['type'], 'noparam', true);
+ return $url;
+ } else {
+ return new moodle_url('/theme/javascript.php', $params);
+ }
+ }
+
+ /**
+ * Get the URL's for the JavaScript files used by this theme.
+ * They won't be served directly, instead they'll be mediated through
+ * theme/javascript.php.
+ *
+ * @param string $type Either javascripts_footer, or javascripts
+ * @return array
+ */
+ public function javascript_files($type) {
+ if ($type === 'footer') {
+ $type = 'javascripts_footer';
+ } else {
+ $type = 'javascripts';
+ }
+
+ $js = [];
+ // Find out wanted parent javascripts.
+ $excludes = $this->resolve_excludes('parents_exclude_javascripts');
+ if ($excludes !== true) {
+ foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
+ $parent = $parent_config->name;
+ if (empty($parent_config->$type)) {
+ continue;
+ }
+ if (!empty($excludes[$parent]) && $excludes[$parent] === true) {
+ continue;
+ }
+ foreach ($parent_config->$type as $javascript) {
+ if (
+ !empty($excludes[$parent])
+ && is_array($excludes[$parent])
+ && in_array($javascript, $excludes[$parent])
+ ) {
+ continue;
+ }
+ $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
+ if (is_readable($javascriptfile)) {
+ $js[] = $javascriptfile;
+ }
+ }
+ }
+ }
+
+ // Current theme javascripts.
+ if (is_array($this->$type)) {
+ foreach ($this->$type as $javascript) {
+ $javascriptfile = "$this->dir/javascript/$javascript.js";
+ if (is_readable($javascriptfile)) {
+ $js[] = $javascriptfile;
+ }
+ }
+ }
+ return $js;
+ }
+
+ /**
+ * Resolves an exclude setting to the themes setting is applicable or the
+ * setting of its closest parent.
+ *
+ * @param string $variable The name of the setting the exclude setting to resolve
+ * @param string $default
+ * @return mixed
+ */
+ protected function resolve_excludes($variable, $default = null) {
+ $setting = $default;
+ if (is_array($this->{$variable}) || $this->{$variable} === true) {
+ $setting = $this->{$variable};
+ } else {
+ foreach ($this->parent_configs as $parent_config) { // The immediate parent first, base last.
+ if (!isset($parent_config->{$variable})) {
+ continue;
+ }
+ if (is_array($parent_config->{$variable}) || $parent_config->{$variable} === true) {
+ $setting = $parent_config->{$variable};
+ break;
+ }
+ }
+ }
+ return $setting;
+ }
+
+ /**
+ * Returns the content of the one huge javascript file merged from all theme javascript files.
+ *
+ * @param bool $type
+ * @return string
+ */
+ public function javascript_content($type) {
+ $jsfiles = $this->javascript_files($type);
+ $js = '';
+ foreach ($jsfiles as $jsfile) {
+ $js .= file_get_contents($jsfile) . "\n";
+ }
+ return $js;
+ }
+
+ /**
+ * Post processes CSS.
+ *
+ * This method post processes all of the CSS before it is served for this theme.
+ * This is done so that things such as image URL's can be swapped in and to
+ * run any specific CSS post process method the theme has requested.
+ * This allows themes to use CSS settings.
+ *
+ * @param string $css The CSS to process.
+ * @return string The processed CSS.
+ */
+ public function post_process($css) {
+ // Now resolve all image locations.
+ if (preg_match_all('/\[\[pix:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
+ $replaced = [];
+ foreach ($matches as $match) {
+ if (isset($replaced[$match[0]])) {
+ continue;
+ }
+ $replaced[$match[0]] = true;
+ $imagename = $match[2];
+ $component = rtrim($match[1], '|');
+ $imageurl = $this->image_url($imagename, $component)->out(false);
+ // We do not need full url because the image.php is always in the same dir.
+ $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
+ $css = str_replace($match[0], $imageurl, $css);
+ }
+ }
+
+ // Now resolve all font locations.
+ if (preg_match_all('/\[\[font:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
+ $replaced = [];
+ foreach ($matches as $match) {
+ if (isset($replaced[$match[0]])) {
+ continue;
+ }
+ $replaced[$match[0]] = true;
+ $fontname = $match[2];
+ $component = rtrim($match[1], '|');
+ $fonturl = $this->font_url($fontname, $component)->out(false);
+ // We do not need full url because the font.php is always in the same dir.
+ $fonturl = preg_replace('|^http.?://[^/]+|', '', $fonturl);
+ $css = str_replace($match[0], $fonturl, $css);
+ }
+ }
+
+ // Now resolve all theme settings or do any other postprocessing.
+ // This needs to be done before calling core parser, since the parser strips [[settings]] tags.
+ $csspostprocess = $this->csspostprocess;
+ if ($csspostprocess && function_exists($csspostprocess)) {
+ $css = $csspostprocess($css, $this);
+ }
+
+ // Post processing using an object representation of CSS.
+ $treeprocessor = $this->get_css_tree_post_processor();
+ $needsparsing = !empty($treeprocessor) || !empty($this->rtlmode);
+ if ($needsparsing) {
+ // We might need more memory/time to do this, so let's play safe.
+ raise_memory_limit(MEMORY_EXTRA);
+ core_php_time_limit::raise(300);
+
+ $parser = new core_cssparser($css);
+ $csstree = $parser->parse();
+ unset($parser);
+
+ if ($this->rtlmode) {
+ $this->rtlize($csstree);
+ }
+
+ if ($treeprocessor) {
+ $treeprocessor($csstree, $this);
+ }
+
+ $css = $csstree->render();
+ unset($csstree);
+ }
+
+ return $css;
+ }
+
+ /**
+ * Flip a stylesheet to RTL.
+ *
+ * @param mixed $csstree The parsed CSS tree structure to flip.
+ * @return void
+ */
+ protected function rtlize($csstree) {
+ $rtlcss = new core_rtlcss($csstree);
+ $rtlcss->flip();
+ }
+
+ /**
+ * Return the direct URL for an image from the pix folder.
+ *
+ * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
+ *
+ * @deprecated since Moodle 3.3
+ * @param string $imagename the name of the icon.
+ * @param string $component specification of one plugin like in get_string()
+ * @return moodle_url
+ */
+ public function pix_url($imagename, $component) {
+ debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
+ return $this->image_url($imagename, $component);
+ }
+
+ /**
+ * Return the direct URL for an image from the pix folder.
+ *
+ * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
+ *
+ * @param string $imagename the name of the icon.
+ * @param string $component specification of one plugin like in get_string()
+ * @return moodle_url
+ */
+ public function image_url($imagename, $component) {
+ global $CFG;
+
+ $params = ['theme' => $this->name];
+ $svg = $this->use_svg_icons();
+
+ if (empty($component) || $component === 'moodle' || $component === 'core') {
+ $params['component'] = 'core';
+ } else {
+ $params['component'] = $component;
+ }
+
+ $rev = theme_get_revision();
+ if ($rev != -1) {
+ $params['rev'] = $rev;
+ }
+
+ $params['image'] = $imagename;
+
+ $url = new moodle_url("/theme/image.php");
+ if (!empty($CFG->slasharguments) && $rev > 0) {
+ $path = '/' . $params['theme'] . '/' . $params['component'] . '/' . $params['rev'] . '/' . $params['image'];
+ if (!$svg) {
+ // We add a simple /_s to the start of the path.
+ // The underscore is used to ensure that it isn't a valid theme name.
+ $path = '/_s' . $path;
+ }
+ $url->set_slashargument($path, 'noparam', true);
+ } else {
+ if (!$svg) {
+ // We add an SVG param so that we know not to serve SVG images.
+ // We do this because all modern browsers support SVG and this param will one day be removed.
+ $params['svg'] = '0';
+ }
+ $url->params($params);
+ }
+
+ return $url;
+ }
+
+ /**
+ * Return the URL for a font
+ *
+ * @param string $font the name of the font (including extension).
+ * @param string $component specification of one plugin like in get_string()
+ * @return moodle_url
+ */
+ public function font_url($font, $component) {
+ global $CFG;
+
+ $params = ['theme' => $this->name];
+
+ if (empty($component) || $component === 'moodle' || $component === 'core') {
+ $params['component'] = 'core';
+ } else {
+ $params['component'] = $component;
+ }
+
+ $rev = theme_get_revision();
+ if ($rev != -1) {
+ $params['rev'] = $rev;
+ }
+
+ $params['font'] = $font;
+
+ $url = new moodle_url("/theme/font.php");
+ if (!empty($CFG->slasharguments) && $rev > 0) {
+ $path = '/' . $params['theme'] . '/' . $params['component'] . '/' . $params['rev'] . '/' . $params['font'];
+ $url->set_slashargument($path, 'noparam', true);
+ } else {
+ $url->params($params);
+ }
+
+ return $url;
+ }
+
+ /**
+ * Returns URL to the stored file via pluginfile.php.
+ *
+ * Note the theme must also implement pluginfile.php handler,
+ * theme revision is used instead of the itemid.
+ *
+ * @param string $setting
+ * @param string $filearea
+ * @return string protocol relative URL or null if not present
+ */
+ public function setting_file_url($setting, $filearea) {
+ global $CFG;
+
+ if (empty($this->settings->$setting)) {
+ return null;
+ }
+
+ $component = 'theme_' . $this->name;
+ $itemid = theme_get_revision();
+ $filepath = $this->settings->$setting;
+ $syscontext = context_system::instance();
+
+ $url = moodle_url::make_file_url(
+ "$CFG->wwwroot/pluginfile.php",
+ "/$syscontext->id/$component/$filearea/$itemid" . $filepath,
+ );
+
+ // Now this is tricky because the we can not hardcode http or https here, lets use the relative link.
+ // Note: unfortunately moodle_url does not support //urls yet.
+
+ $url = preg_replace('|^https?://|i', '//', $url->out(false));
+
+ return $url;
+ }
+
+ /**
+ * Serve the theme setting file.
+ *
+ * @param string $filearea
+ * @param array $args
+ * @param bool $forcedownload
+ * @param array $options
+ * @return bool may terminate if file not found or donotdie not specified
+ */
+ public function setting_file_serve($filearea, $args, $forcedownload, $options) {
+ global $CFG;
+ require_once("$CFG->libdir/filelib.php");
+
+ $syscontext = context_system::instance();
+ $component = 'theme_' . $this->name;
+
+ $revision = array_shift($args);
+ if ($revision < 0) {
+ $lifetime = 0;
+ } else {
+ $lifetime = 60 * 60 * 24 * 60;
+ // By default, theme files must be cache-able by both browsers and proxies.
+ if (!array_key_exists('cacheability', $options)) {
+ $options['cacheability'] = 'public';
+ }
+ }
+
+ $fs = get_file_storage();
+ $relativepath = implode('/', $args);
+
+ $fullpath = "/{$syscontext->id}/{$component}/{$filearea}/0/{$relativepath}";
+ $fullpath = rtrim($fullpath, '/');
+ if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
+ send_stored_file($file, $lifetime, 0, $forcedownload, $options);
+ return true;
+ } else {
+ send_file_not_found();
+ }
+ }
+
+ /**
+ * Resolves the real image location.
+ *
+ * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
+ * and we need a way in which to turn it off.
+ * By default SVG won't be used unless asked for. This is done for two reasons:
+ * 1. It ensures that we don't serve svg images unless we really want to. The admin has selected to force them, of the users
+ * browser supports SVG.
+ * 2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
+ * by the user due to security concerns.
+ *
+ * @param string $image name of image, may contain relative path
+ * @param string $component
+ * @param bool|null $svg Should SVG images also be looked for? If null, falls back to auto-detection of browser support
+ * @return string full file path
+ */
+ public function resolve_image_location($image, $component, $svg = false) {
+ global $CFG;
+
+ if (!is_bool($svg)) {
+ // If $svg isn't a bool then we need to decide for ourselves.
+ $svg = $this->use_svg_icons();
+ }
+
+ if ($component === 'moodle' || $component === 'core' || empty($component)) {
+ if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
+ return $imagefile;
+ }
+ foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
+ if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
+ return $imagefile;
+ }
+ }
+ if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
+ return $imagefile;
+ }
+ if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
+ return $imagefile;
+ }
+ return null;
+ } else if ($component === 'theme') { // Exception.
+ if ($image === 'favicon') {
+ return "$this->dir/pix/favicon.ico";
+ }
+ if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
+ return $imagefile;
+ }
+ foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
+ if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
+ return $imagefile;
+ }
+ }
+ return null;
+ } else {
+ if (strpos($component, '_') === false) {
+ $component = "mod_{$component}";
+ }
+ [$type, $plugin] = explode('_', $component, 2);
+
+ // In Moodle 4.0 we introduced a new image format.
+ // Support that image format here.
+ $candidates = [$image];
+
+ if ($type === 'mod') {
+ if ($image === 'icon' || $image === 'monologo') {
+ $candidates = ['monologo', 'icon'];
+ if ($image === 'icon') {
+ debugging(
+ "The 'icon' image for activity modules has been replaced with a new 'monologo'. " .
+ "Please update your calling code to fetch the new icon where possible. " .
+ "Called for component {$component}.",
+ DEBUG_DEVELOPER
+ );
+ }
+ }
+ }
+ foreach ($candidates as $image) {
+ if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
+ return $imagefile;
+ }
+
+ // Base first, the immediate parent last.
+ foreach (array_reverse($this->parent_configs) as $parentconfig) {
+ if ($imagefile = $this->image_exists("$parentconfig->dir/pix_plugins/$type/$plugin/$image", $svg)) {
+ return $imagefile;
+ }
+ }
+ if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
+ return $imagefile;
+ }
+ $dir = core_component::get_plugin_directory($type, $plugin);
+ if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
+ return $imagefile;
+ }
+ }
+ return null;
+ }
+ }
+
+ /**
+ * Resolves the real font location.
+ *
+ * @param string $font name of font file
+ * @param string $component
+ * @return string full file path
+ */
+ public function resolve_font_location($font, $component) {
+ global $CFG;
+
+ if ($component === 'moodle' || $component === 'core' || empty($component)) {
+ if (file_exists("$this->dir/fonts_core/$font")) {
+ return "$this->dir/fonts_core/$font";
+ }
+ foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
+ if (file_exists("$parent_config->dir/fonts_core/$font")) {
+ return "$parent_config->dir/fonts_core/$font";
+ }
+ }
+ if (file_exists("$CFG->dataroot/fonts/$font")) {
+ return "$CFG->dataroot/fonts/$font";
+ }
+ if (file_exists("$CFG->dirroot/lib/fonts/$font")) {
+ return "$CFG->dirroot/lib/fonts/$font";
+ }
+ return null;
+ } else if ($component === 'theme') { // Exception.
+ if (file_exists("$this->dir/fonts/$font")) {
+ return "$this->dir/fonts/$font";
+ }
+ foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
+ if (file_exists("$parent_config->dir/fonts/$font")) {
+ return "$parent_config->dir/fonts/$font";
+ }
+ }
+ return null;
+ } else {
+ if (strpos($component, '_') === false) {
+ $component = 'mod_' . $component;
+ }
+ [$type, $plugin] = explode('_', $component, 2);
+
+ if (file_exists("$this->dir/fonts_plugins/$type/$plugin/$font")) {
+ return "$this->dir/fonts_plugins/$type/$plugin/$font";
+ }
+ foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
+ if (file_exists("$parent_config->dir/fonts_plugins/$type/$plugin/$font")) {
+ return "$parent_config->dir/fonts_plugins/$type/$plugin/$font";
+ }
+ }
+ if (file_exists("$CFG->dataroot/fonts_plugins/$type/$plugin/$font")) {
+ return "$CFG->dataroot/fonts_plugins/$type/$plugin/$font";
+ }
+ $dir = core_component::get_plugin_directory($type, $plugin);
+ if (file_exists("$dir/fonts/$font")) {
+ return "$dir/fonts/$font";
+ }
+ return null;
+ }
+ }
+
+ /**
+ * Return true if we should look for SVG images as well.
+ *
+ * @return bool
+ */
+ public function use_svg_icons() {
+ if ($this->usesvg === null) {
+ $this->usesvg = core_useragent::supports_svg();
+ }
+
+ return $this->usesvg;
+ }
+
+ /**
+ * Forces the usesvg setting to either true or false, avoiding any decision making.
+ *
+ * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
+ * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
+ *
+ * @param bool $setting True to force the use of svg when available, null otherwise.
+ */
+ public function force_svg_use($setting) {
+ $this->usesvg = (bool)$setting;
+ }
+
+ /**
+ * Set to be in RTL mode.
+ *
+ * This will likely be used when post processing the CSS before serving it.
+ *
+ * @param bool $inrtl True when in RTL mode.
+ */
+ public function set_rtl_mode($inrtl = true) {
+ $this->rtlmode = $inrtl;
+ }
+
+ /**
+ * Checks if source maps are supported
+ *
+ * @param bool $themedesigner True if theme designer is enabled.
+ * @return boolean True if source maps are supported.
+ */
+ public function supports_source_maps($themedesigner): bool {
+ if (empty($this->rtlmode) && $themedesigner) {
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Whether the theme is being served in RTL mode.
+ *
+ * @return bool True when in RTL mode.
+ */
+ public function get_rtl_mode() {
+ return $this->rtlmode;
+ }
+
+ /**
+ * Checks if file with any image extension exists.
+ *
+ * The order to these images was adjusted prior to the release of 2.4
+ * At that point the were the following image counts in Moodle core:
+ *
+ * - png = 667 in pix dirs (1499 total)
+ * - gif = 385 in pix dirs (606 total)
+ * - jpg = 62 in pix dirs (74 total)
+ * - jpeg = 0 in pix dirs (1 total)
+ *
+ * There is work in progress to move towards SVG presently hence that has been prioritiesed.
+ *
+ * @param string $filepath
+ * @param bool $svg If set to true SVG images will also be looked for.
+ * @return string image name with extension
+ */
+ private static function image_exists($filepath, $svg = false) {
+ if ($svg && file_exists("$filepath.svg")) {
+ return "$filepath.svg";
+ } else if (file_exists("$filepath.png")) {
+ return "$filepath.png";
+ } else if (file_exists("$filepath.gif")) {
+ return "$filepath.gif";
+ } else if (file_exists("$filepath.jpg")) {
+ return "$filepath.jpg";
+ } else if (file_exists("$filepath.jpeg")) {
+ return "$filepath.jpeg";
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Loads the theme config from config.php file.
+ *
+ * @param string $themename
+ * @param stdClass $settings from config_plugins table
+ * @param boolean $parentscheck true to also check the parents. .
+ * @return ?stdClass The theme configuration
+ */
+ private static function find_theme_config($themename, $settings, $parentscheck = true) {
+ // We have to use the variable name $THEME (upper case) because that
+ // is what is used in theme config.php files.
+
+ if (!$dir = self::find_theme_location($themename)) {
+ return null;
+ }
+
+ $THEME = new stdClass();
+ $THEME->name = $themename;
+ $THEME->dir = $dir;
+ $THEME->settings = $settings;
+
+ global $CFG; // Just in case somebody tries to use $CFG in theme config.
+ include("$THEME->dir/config.php");
+
+ // Verify the theme configuration is OK.
+ if (!is_array($THEME->parents)) {
+ // Parents option is mandatory now.
+ return null;
+ } else {
+ // We use $parentscheck to only check the direct parents (avoid infinite loop).
+ if ($parentscheck) {
+ // Find all parent theme configs.
+ foreach ($THEME->parents as $parent) {
+ $parentconfig = self::find_theme_config($parent, $settings, false);
+ if (empty($parentconfig)) {
+ return null;
+ }
+ }
+ }
+ }
+
+ return $THEME;
+ }
+
+ /**
+ * Finds the theme location and verifies the theme has all needed files
+ * and is not obsoleted.
+ *
+ * @param string $themename
+ * @return string full dir path or null if not found
+ */
+ private static function find_theme_location($themename) {
+ global $CFG;
+
+ if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
+ $dir = "$CFG->dirroot/theme/$themename";
+ } else if (!empty($CFG->themedir) && file_exists("$CFG->themedir/$themename/config.php")) {
+ $dir = "$CFG->themedir/$themename";
+ } else {
+ return null;
+ }
+
+ if (file_exists("$dir/styles.php")) {
+ // Legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page.
+ return null;
+ }
+
+ return $dir;
+ }
+
+ /**
+ * Get the renderer for a part of Moodle for this theme.
+ *
+ * @param moodle_page $page the page we are rendering
+ * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
+ * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
+ * @param string $target one of rendering target constants
+ * @return renderer_base the requested renderer.
+ */
+ public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
+ if (is_null($this->rf)) {
+ $classname = $this->rendererfactory;
+ $this->rf = new $classname($this);
+ }
+
+ return $this->rf->get_renderer($page, $component, $subtype, $target);
+ }
+
+ /**
+ * Get the information from {@see $layouts} for this type of page.
+ *
+ * @param string $pagelayout the the page layout name.
+ * @return array the appropriate part of {@see $layouts}.
+ */
+ protected function layout_info_for_page($pagelayout) {
+ if (array_key_exists($pagelayout, $this->layouts)) {
+ return $this->layouts[$pagelayout];
+ } else {
+ debugging('Invalid page layout specified: ' . $pagelayout);
+ return $this->layouts['standard'];
+ }
+ }
+
+ /**
+ * Given the settings of this theme, and the page pagelayout, return the
+ * full path of the page layout file to use.
+ *
+ * Used by {@see core_renderer::header()}.
+ *
+ * @param string $pagelayout the the page layout name.
+ * @return string Full path to the lyout file to use
+ */
+ public function layout_file($pagelayout) {
+ global $CFG;
+
+ $layoutinfo = $this->layout_info_for_page($pagelayout);
+ $layoutfile = $layoutinfo['file'];
+
+ if (array_key_exists('theme', $layoutinfo)) {
+ $themes = [$layoutinfo['theme']];
+ } else {
+ $themes = array_merge([$this->name], $this->parents);
+ }
+
+ foreach ($themes as $theme) {
+ if ($dir = $this->find_theme_location($theme)) {
+ $path = "$dir/layout/$layoutfile";
+
+ // Check the template exists, return general base theme template if not.
+ if (is_readable($path)) {
+ return $path;
+ }
+ }
+ }
+
+ throw new coding_exception('Can not find layout file for: ' . $pagelayout . ' (' . $layoutfile . ')');
+ }
+
+ /**
+ * Returns auxiliary page layout options specified in layout configuration array.
+ *
+ * @param string $pagelayout
+ * @return array
+ */
+ public function pagelayout_options($pagelayout) {
+ $info = $this->layout_info_for_page($pagelayout);
+ if (!empty($info['options'])) {
+ return $info['options'];
+ }
+ return [];
+ }
+
+ /**
+ * Inform a block_manager about the block regions this theme wants on this
+ * page layout.
+ *
+ * @param string $pagelayout the general type of the page.
+ * @param block_manager $blockmanager the block_manger to set up.
+ */
+ public function setup_blocks($pagelayout, $blockmanager) {
+ $layoutinfo = $this->layout_info_for_page($pagelayout);
+ if (!empty($layoutinfo['regions'])) {
+ $blockmanager->add_regions($layoutinfo['regions'], false);
+ $blockmanager->set_default_region($layoutinfo['defaultregion']);
+ }
+ }
+
+ /**
+ * Gets the visible name for the requested block region.
+ *
+ * @param string $region The region name to get
+ * @param string $theme The theme the region belongs to (may come from the parent theme)
+ * @return string
+ */
+ protected function get_region_name($region, $theme) {
+
+ $stringman = get_string_manager();
+
+ // Check if the name is defined in the theme.
+ if ($stringman->string_exists('region-' . $region, 'theme_' . $theme)) {
+ return get_string('region-' . $region, 'theme_' . $theme);
+ }
+
+ // Check the theme parents.
+ foreach ($this->parents as $parentthemename) {
+ if ($stringman->string_exists('region-' . $region, 'theme_' . $parentthemename)) {
+ return get_string('region-' . $region, 'theme_' . $parentthemename);
+ }
+ }
+
+ // Last resort, try the boost theme for names.
+ return get_string('region-' . $region, 'theme_boost');
+ }
+
+ /**
+ * Get the list of all block regions known to this theme in all templates.
+ *
+ * @return array internal region name => human readable name.
+ */
+ public function get_all_block_regions() {
+ $regions = [];
+ foreach ($this->layouts as $layoutinfo) {
+ foreach ($layoutinfo['regions'] as $region) {
+ $regions[$region] = $this->get_region_name($region, $this->name);
+ }
+ }
+ return $regions;
+ }
+
+ /**
+ * Returns the human readable name of the theme
+ *
+ * @return string
+ */
+ public function get_theme_name() {
+ return get_string('pluginname', 'theme_' . $this->name);
+ }
+
+ /**
+ * Returns the block render method.
+ *
+ * It is set by the theme via:
+ * $THEME->blockrendermethod = '...';
+ *
+ * It can be one of two values, blocks or blocks_for_region.
+ * It should be set to the method being used by the theme layouts.
+ *
+ * @return string
+ */
+ public function get_block_render_method() {
+ if ($this->blockrendermethod) {
+ // Return the specified block render method.
+ return $this->blockrendermethod;
+ }
+ // Its not explicitly set, check the parent theme configs.
+ foreach ($this->parent_configs as $config) {
+ if (isset($config->blockrendermethod)) {
+ return $config->blockrendermethod;
+ }
+ }
+ // Default it to blocks.
+ return 'blocks';
+ }
+
+ /**
+ * Get the callable for CSS tree post processing.
+ *
+ * @return string|null
+ */
+ public function get_css_tree_post_processor() {
+ $configs = [$this] + $this->parent_configs;
+ foreach ($configs as $config) {
+ if (!empty($config->csstreepostprocessor) && is_callable($config->csstreepostprocessor)) {
+ return $config->csstreepostprocessor;
+ }
+ }
+ return null;
+ }
+}
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(theme_config::class, \theme_config::class);
diff --git a/lib/classes/output/theme_usage.php b/lib/classes/output/theme_usage.php
index 21d33dda0460b..19633dc8642b3 100644
--- a/lib/classes/output/theme_usage.php
+++ b/lib/classes/output/theme_usage.php
@@ -25,7 +25,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class theme_usage {
-
/** @var string The theme usage type for users. */
public const THEME_USAGE_TYPE_USER = 'user';
@@ -61,7 +60,6 @@ public static function is_theme_used_in_any_context(string $themename): int {
$isused = $cache->get($themename);
if ($isused === false) {
-
$sqlunions = [];
// For each context, check if the config is enabled and there is at least one use.
@@ -119,7 +117,6 @@ public static function is_theme_used_in_any_context(string $themename): int {
// Cache the result so we don't have to keep checking for this theme.
$cache->set($themename, $isused);
return $isused;
-
} else {
return $isused;
}
diff --git a/lib/classes/output/url_rewriter.php b/lib/classes/output/url_rewriter.php
index eacd434ed2fd3..5cc5270d6a274 100644
--- a/lib/classes/output/url_rewriter.php
+++ b/lib/classes/output/url_rewriter.php
@@ -25,8 +25,6 @@
namespace core\output;
-defined('MOODLE_INTERNAL') || die();
-
/**
* URL rewriter interface
*
@@ -36,7 +34,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
interface url_rewriter {
-
/**
* Rewrite moodle_urls into another form.
*
@@ -52,7 +49,4 @@ public static function url_rewrite(\moodle_url $url);
* @return void
*/
public static function html_head_setup();
-
-
}
-
diff --git a/lib/classes/output/url_select.php b/lib/classes/output/url_select.php
new file mode 100644
index 0000000000000..3068f443ae9d7
--- /dev/null
+++ b/lib/classes/output/url_select.php
@@ -0,0 +1,291 @@
+.
+
+namespace core\output;
+
+use core\exception\coding_exception;
+use moodle_url;
+use stdClass;
+
+/**
+ * Simple URL selection widget description.
+ *
+ * @copyright 2009 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class url_select implements renderable, templatable {
+ /**
+ * @var array $urls associative array value=>label ex.: array(1=>'One, 2=>Two)
+ * it is also possible to specify optgroup as complex label array ex.:
+ * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
+ * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
+ */
+ public $urls;
+
+ /**
+ * @var string Selected option
+ */
+ public $selected;
+
+ /**
+ * @var array Nothing selected
+ */
+ public $nothing;
+
+ /**
+ * @var array Extra select field attributes
+ */
+ public $attributes = [];
+
+ /**
+ * @var string Button label
+ */
+ public $label = '';
+
+ /**
+ * @var array Button label's attributes
+ */
+ public $labelattributes = [];
+
+ /**
+ * @var string Wrapping div class
+ */
+ public $class = 'urlselect';
+
+ /**
+ * @var bool True if button disabled, false if normal
+ */
+ public $disabled = false;
+
+ /**
+ * @var string Button tooltip
+ */
+ public $tooltip = null;
+
+ /**
+ * @var string Form id
+ */
+ public $formid = null;
+
+ /**
+ * @var help_icon The help icon for this element.
+ */
+ public $helpicon = null;
+
+ /**
+ * @var string If set, makes button visible with given name for button
+ */
+ public $showbutton = null;
+
+ /**
+ * Constructor
+ * @param array $urls list of options
+ * @param string $selected selected element
+ * @param array $nothing
+ * @param string $formid
+ * @param string $showbutton Set to text of button if it should be visible
+ * or null if it should be hidden (hidden version always has text 'go')
+ */
+ public function __construct(array $urls, $selected = '', $nothing = ['' => 'choosedots'], $formid = null, $showbutton = null) {
+ $this->urls = $urls;
+ $this->selected = $selected;
+ $this->nothing = $nothing;
+ $this->formid = $formid;
+ $this->showbutton = $showbutton;
+ }
+
+ /**
+ * Adds help icon.
+ *
+ * @deprecated since Moodle 2.0
+ */
+ public function set_old_help_icon($helppage, $title, $component = 'moodle') {
+ throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
+ }
+
+ /**
+ * Adds help icon.
+ *
+ * @param string $identifier The keyword that defines a help page
+ * @param string $component
+ */
+ public function set_help_icon($identifier, $component = 'moodle') {
+ $this->helpicon = new help_icon($identifier, $component);
+ }
+
+ /**
+ * Sets select's label
+ *
+ * @param string $label
+ * @param array $attributes (optional)
+ */
+ public function set_label($label, $attributes = []) {
+ $this->label = $label;
+ $this->labelattributes = $attributes;
+ }
+
+ /**
+ * Clean a URL.
+ *
+ * @param string $value The URL.
+ * @return string The cleaned URL.
+ */
+ protected function clean_url($value) {
+ global $CFG;
+
+ // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf
+ if (empty($value)) {
+ // Nothing.
+ } else if (strpos($value, $CFG->wwwroot . '/') === 0) {
+ $value = str_replace($CFG->wwwroot, '', $value);
+ } else if (strpos($value, '/') !== 0) {
+ debugging("Invalid url_select urls parameter: url '$value' is not local relative url!", DEBUG_DEVELOPER);
+ }
+
+ return $value;
+ }
+
+ /**
+ * Flatten the options for Mustache.
+ *
+ * This also cleans the URLs.
+ *
+ * @param array $options The options.
+ * @param array $nothing The nothing option.
+ * @return array
+ */
+ protected function flatten_options($options, $nothing) {
+ $flattened = [];
+
+ foreach ($options as $value => $option) {
+ if (is_array($option)) {
+ foreach ($option as $groupname => $optoptions) {
+ if (!isset($flattened[$groupname])) {
+ $flattened[$groupname] = [
+ 'name' => $groupname,
+ 'isgroup' => true,
+ 'options' => [],
+ ];
+ }
+ foreach ($optoptions as $optvalue => $optoption) {
+ $cleanedvalue = $this->clean_url($optvalue);
+ $flattened[$groupname]['options'][$cleanedvalue] = [
+ 'name' => $optoption,
+ 'value' => $cleanedvalue,
+ 'selected' => $this->selected == $optvalue,
+ ];
+ }
+ }
+ } else {
+ $cleanedvalue = $this->clean_url($value);
+ $flattened[$cleanedvalue] = [
+ 'name' => $option,
+ 'value' => $cleanedvalue,
+ 'selected' => $this->selected == $value,
+ ];
+ }
+ }
+
+ if (!empty($nothing)) {
+ $value = key($nothing);
+ $name = reset($nothing);
+ $flattened = [
+ $value => ['name' => $name, 'value' => $value, 'selected' => $this->selected == $value],
+ ] + $flattened;
+ }
+
+ // Make non-associative array.
+ foreach ($flattened as $key => $value) {
+ if (!empty($value['options'])) {
+ $flattened[$key]['options'] = array_values($value['options']);
+ }
+ }
+ $flattened = array_values($flattened);
+
+ return $flattened;
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output Renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $attributes = $this->attributes;
+
+ $data = new stdClass();
+ $data->formid = !empty($this->formid) ? $this->formid : html_writer::random_id('url_select_f');
+ $data->classes = $this->class;
+ $data->label = $this->label;
+ $data->disabled = $this->disabled;
+ $data->title = $this->tooltip;
+ $data->id = !empty($attributes['id']) ? $attributes['id'] : html_writer::random_id('url_select');
+ $data->sesskey = sesskey();
+ $data->action = (new moodle_url('/course/jumpto.php'))->out(false);
+
+ // Remove attributes passed as property directly.
+ unset($attributes['class']);
+ unset($attributes['id']);
+ unset($attributes['name']);
+ unset($attributes['title']);
+ unset($attributes['disabled']);
+
+ $data->showbutton = $this->showbutton;
+
+ // Select options.
+ $nothing = false;
+ if (is_string($this->nothing) && $this->nothing !== '') {
+ $nothing = ['' => $this->nothing];
+ } else if (is_array($this->nothing)) {
+ $nothingvalue = reset($this->nothing);
+ if ($nothingvalue === 'choose' || $nothingvalue === 'choosedots') {
+ $nothing = [key($this->nothing) => get_string('choosedots')];
+ } else {
+ $nothing = $this->nothing;
+ }
+ }
+ $data->options = $this->flatten_options($this->urls, $nothing);
+
+ // Label attributes.
+ $data->labelattributes = [];
+ // Unset label attributes that are already in the template.
+ unset($this->labelattributes['for']);
+ // Map the label attributes.
+ foreach ($this->labelattributes as $key => $value) {
+ $data->labelattributes[] = ['name' => $key, 'value' => $value];
+ }
+
+ // Help icon.
+ $data->helpicon = !empty($this->helpicon) ? $this->helpicon->export_for_template($output) : false;
+
+ // Finally all the remaining attributes.
+ $data->attributes = [];
+ foreach ($attributes as $key => $value) {
+ $data->attributes[] = ['name' => $key, 'value' => $value];
+ }
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(url_select::class, \url_select::class);
diff --git a/lib/classes/output/user_picture.php b/lib/classes/output/user_picture.php
new file mode 100644
index 0000000000000..8da6537c5814a
--- /dev/null
+++ b/lib/classes/output/user_picture.php
@@ -0,0 +1,346 @@
+.
+
+namespace core\output;
+
+use core\context\user as context_user;
+use core\exception\coding_exception;
+use moodle_page;
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure representing a user picture.
+ *
+ * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Modle 2.0
+ * @package core
+ * @category output
+ */
+class user_picture implements renderable {
+ /**
+ * @var stdClass A user object with at least fields all columns specified
+ * in $fields array constant set.
+ */
+ public $user;
+
+ /**
+ * @var int The course id. Used when constructing the link to the user's
+ * profile, page course id used if not specified.
+ */
+ public $courseid;
+
+ /**
+ * @var bool Add course profile link to image
+ */
+ public $link = true;
+
+ /**
+ * @var int Size in pixels. Special values are (true/1 = 100px) and (false/0 = 35px) for backward compatibility.
+ * Recommended values (supporting user initials too): 16, 35, 64 and 100.
+ */
+ public $size = 35;
+
+ /**
+ * @var bool Add non-blank alt-text to the image.
+ * Default true, set to false when image alt just duplicates text in screenreaders.
+ */
+ public $alttext = true;
+
+ /**
+ * @var bool Whether or not to open the link in a popup window.
+ */
+ public $popup = false;
+
+ /**
+ * @var string Image class attribute
+ */
+ public $class = 'userpicture';
+
+ /**
+ * @var bool Whether to be visible to screen readers.
+ */
+ public $visibletoscreenreaders = true;
+
+ /**
+ * @var bool Whether to include the fullname in the user picture link.
+ */
+ public $includefullname = false;
+
+ /**
+ * @var mixed Include user authentication token. True indicates to generate a token for current user, and integer value
+ * indicates to generate a token for the user whose id is the value indicated.
+ */
+ public $includetoken = false;
+
+ /**
+ * User picture constructor.
+ *
+ * @param stdClass $user user record with at least id, picture, imagealt, firstname and lastname set.
+ * It is recommended to add also contextid of the user for performance reasons.
+ */
+ public function __construct(stdClass $user) {
+ global $DB;
+
+ if (empty($user->id)) {
+ throw new coding_exception('User id is required when printing user avatar image.');
+ }
+
+ // Only touch the DB if we are missing data and complain loudly...
+ $needrec = false;
+ foreach (\core_user\fields::get_picture_fields() as $field) {
+ if (!property_exists($user, $field)) {
+ $needrec = true;
+ debugging(
+ "Missing {$field} property in {$user} object, "
+ . "this is a performance problem that needs to be fixed by a developer. "
+ . 'Please use the \core_user\fields API to get the full list of required fields.',
+ DEBUG_DEVELOPER,
+ );
+ break;
+ }
+ }
+
+ if ($needrec) {
+ $this->user = $DB->get_record(
+ 'user',
+ ['id' => $user->id],
+ implode(',', \core_user\fields::get_picture_fields()),
+ MUST_EXIST
+ );
+ } else {
+ $this->user = clone($user);
+ }
+ }
+
+ /**
+ * Returns a list of required user fields, useful when fetching required user info from db.
+ *
+ * In some cases we have to fetch the user data together with some other information,
+ * the idalias is useful there because the id would otherwise override the main
+ * id of the result record. Please note it has to be converted back to id before rendering.
+ *
+ * @param string $tableprefix name of database table prefix in query
+ * @param null|array $extrafields extra fields to be included in result
+ * Do not include TEXT columns because it would break SELECT DISTINCT in MSSQL and ORACLE.
+ * @param string $idalias alias of id field
+ * @param string $fieldprefix prefix to add to all columns in their aliases, does not apply to 'id'
+ * @return string
+ * @deprecated since Moodle 3.11 MDL-45242
+ * @see \core_user\fields
+ */
+ public static function fields(
+ $tableprefix = '',
+ ?array $extrafields = null,
+ $idalias = 'id',
+ $fieldprefix = '',
+ ) {
+ debugging('user_picture::fields() is deprecated. Please use the \core_user\fields API instead.', DEBUG_DEVELOPER);
+ $userfields = \core_user\fields::for_userpic();
+ if ($extrafields) {
+ $userfields->including(...$extrafields);
+ }
+ $selects = $userfields->get_sql($tableprefix, false, $fieldprefix, $idalias, false)->selects;
+ if ($tableprefix === '') {
+ // If no table alias is specified, don't add {user}. in front of fields.
+ $selects = str_replace('{user}.', '', $selects);
+ }
+ // Maintain legacy behaviour where the field list was done with 'implode' and no spaces.
+ $selects = str_replace(', ', ',', $selects);
+ return $selects;
+ }
+
+ /**
+ * Extract the aliased user fields from a given record
+ *
+ * Given a record that was previously obtained using {@see self::fields()} with aliases,
+ * this method extracts user related unaliased fields.
+ *
+ * @param stdClass $record containing user picture fields
+ * @param null|array $extrafields extra fields included in the $record
+ * @param string $idalias alias of the id field
+ * @param string $fieldprefix prefix added to all columns in their aliases, does not apply to 'id'
+ * @return stdClass object with unaliased user fields
+ */
+ public static function unalias(
+ stdClass $record,
+ ?array $extrafields = null,
+ $idalias = 'id',
+ $fieldprefix = '',
+ ) {
+ if (empty($idalias)) {
+ $idalias = 'id';
+ }
+
+ $return = new stdClass();
+
+ foreach (\core_user\fields::get_picture_fields() as $field) {
+ if ($field === 'id') {
+ if (property_exists($record, $idalias)) {
+ $return->id = $record->{$idalias};
+ }
+ } else {
+ if (property_exists($record, $fieldprefix . $field)) {
+ $return->{$field} = $record->{$fieldprefix . $field};
+ }
+ }
+ }
+ // Add extra fields if not already there.
+ if ($extrafields) {
+ foreach ($extrafields as $e) {
+ if ($e === 'id' || property_exists($return, $e)) {
+ continue;
+ }
+ $return->{$e} = $record->{$fieldprefix . $e};
+ }
+ }
+
+ return $return;
+ }
+
+ /**
+ * Works out the URL for the users picture.
+ *
+ * This method is recommended as it avoids costly redirects of user pictures
+ * if requests are made for non-existent files etc.
+ *
+ * @param moodle_page $page
+ * @param null|renderer_base $renderer
+ * @return moodle_url
+ */
+ public function get_url(
+ moodle_page $page,
+ ?renderer_base $renderer = null,
+ ) {
+ global $CFG;
+
+ if (is_null($renderer)) {
+ $renderer = $page->get_renderer('core');
+ }
+
+ // Sort out the filename and size. Size is only required for the gravatar
+ // implementation presently.
+ if (empty($this->size)) {
+ $filename = 'f2';
+ $size = 35;
+ } else if ($this->size === true || $this->size == 1) {
+ $filename = 'f1';
+ $size = 100;
+ } else if ($this->size > 100) {
+ $filename = 'f3';
+ $size = (int)$this->size;
+ } else if ($this->size >= 50) {
+ $filename = 'f1';
+ $size = (int)$this->size;
+ } else {
+ $filename = 'f2';
+ $size = (int)$this->size;
+ }
+
+ $defaulturl = $renderer->image_url('u/' . $filename); // Default image.
+
+ if (
+ (!empty($CFG->forcelogin) && !isloggedin()) ||
+ (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))
+ ) {
+ // Protect images if login required and not logged in;
+ // also if login is required for profile images and is not logged in or guest
+ // do not use require_login() because it is expensive and not suitable here anyway.
+ return $defaulturl;
+ }
+
+ // First try to detect deleted users - but do not read from database for performance reasons!
+ if (!empty($this->user->deleted) || !str_contains($this->user->email, '@')) {
+ // All deleted users should have email replaced by md5 hash,
+ // all active users are expected to have valid email.
+ return $defaulturl;
+ }
+
+ // Did the user upload a picture?
+ if ($this->user->picture > 0) {
+ if (!empty($this->user->contextid)) {
+ $contextid = $this->user->contextid;
+ } else {
+ $context = context_user::instance($this->user->id, IGNORE_MISSING);
+ if (!$context) {
+ // This must be an incorrectly deleted user, all other users have context.
+ return $defaulturl;
+ }
+ $contextid = $context->id;
+ }
+
+ $path = '/';
+ if (clean_param($page->theme->name, PARAM_THEME) == $page->theme->name) {
+ // We append the theme name to the file path if we have it so that
+ // in the circumstance that the profile picture is not available
+ // when the user actually requests it they still get the profile
+ // picture for the correct theme.
+ $path .= $page->theme->name . '/';
+ }
+ // Set the image URL to the URL for the uploaded file and return.
+ $url = moodle_url::make_pluginfile_url(
+ $contextid,
+ 'user',
+ 'icon',
+ null,
+ $path,
+ $filename,
+ false,
+ $this->includetoken
+ );
+ $url->param('rev', $this->user->picture);
+ return $url;
+ }
+
+ if ($this->user->picture == 0 && !empty($CFG->enablegravatar)) {
+ // Normalise the size variable to acceptable bounds.
+ if ($size < 1 || $size > 512) {
+ $size = 35;
+ }
+ // Hash the users email address.
+ $md5 = md5(strtolower(trim($this->user->email)));
+ // Build a gravatar URL with what we know.
+
+ // Find the best default image URL we can (MDL-35669).
+ if (empty($CFG->gravatardefaulturl)) {
+ $absoluteimagepath = $page->theme->resolve_image_location('u/' . $filename, 'core');
+ if (strpos($absoluteimagepath, $CFG->dirroot) === 0) {
+ $gravatardefault = $CFG->wwwroot . substr($absoluteimagepath, strlen($CFG->dirroot));
+ } else {
+ $gravatardefault = $CFG->wwwroot . '/pix/u/' . $filename . '.png';
+ }
+ } else {
+ $gravatardefault = $CFG->gravatardefaulturl;
+ }
+
+ // If the currently requested page is https then we'll return an
+ // https gravatar page.
+ if (is_https()) {
+ return new moodle_url("https://secure.gravatar.com/avatar/{$md5}", ['s' => $size, 'd' => $gravatardefault]);
+ } else {
+ return new moodle_url("http://www.gravatar.com/avatar/{$md5}", ['s' => $size, 'd' => $gravatardefault]);
+ }
+ }
+
+ return $defaulturl;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(user_picture::class, \user_picture::class);
diff --git a/lib/classes/output/xhtml_container_stack.php b/lib/classes/output/xhtml_container_stack.php
new file mode 100644
index 0000000000000..ccb52ac55112a
--- /dev/null
+++ b/lib/classes/output/xhtml_container_stack.php
@@ -0,0 +1,162 @@
+.
+
+namespace core\output;
+
+use stdClass;
+
+/**
+ * This class keeps track of which HTML tags are currently open.
+ *
+ * This makes it much easier to always generate well formed XHTML output, even
+ * if execution terminates abruptly. Any time you output some opening HTML
+ * without the matching closing HTML, you should push the necessary close tags
+ * onto the stack.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class xhtml_container_stack {
+ /**
+ * @var array Stores the list of open containers.
+ */
+ protected $opencontainers = [];
+
+ /**
+ * @var array In developer debug mode, stores a stack trace of all opens and
+ * closes, so we can output helpful error messages when there is a mismatch.
+ */
+ protected $log = [];
+
+ /**
+ * @var bool Store whether we are developer debug mode. We need this in
+ * several places including in the destructor where we may not have access to $CFG.
+ */
+ protected $isdebugging;
+
+ /**
+ * Constructor
+ */
+ public function __construct() {
+ global $CFG;
+ $this->isdebugging = $CFG->debugdeveloper;
+ }
+
+ /**
+ * Push the close HTML for a recently opened container onto the stack.
+ *
+ * @param string $type The type of container. This is checked when {@see pop()}
+ * is called and must match, otherwise a developer debug warning is output.
+ * @param string $closehtml The HTML required to close the container.
+ */
+ public function push($type, $closehtml) {
+ $container = new stdClass();
+ $container->type = $type;
+ $container->closehtml = $closehtml;
+ if ($this->isdebugging) {
+ $this->log('Open', $type);
+ }
+ array_push($this->opencontainers, $container);
+ }
+
+ /**
+ * Pop the HTML for the next closing container from the stack. The $type
+ * must match the type passed when the container was opened, otherwise a
+ * warning will be output.
+ *
+ * @param string $type The type of container.
+ * @return ?string the HTML required to close the container.
+ */
+ public function pop($type) {
+ if (empty($this->opencontainers)) {
+ debugging('There are no more open containers. This suggests there is a nesting problem.
' .
+ $this->output_log(), DEBUG_DEVELOPER);
+ return;
+ }
+
+ $container = array_pop($this->opencontainers);
+ if ($container->type != $type) {
+ debugging('The type of container to be closed (' . $container->type .
+ ') does not match the type of the next open container (' . $type .
+ '). This suggests there is a nesting problem.
' .
+ $this->output_log(), DEBUG_DEVELOPER);
+ }
+ if ($this->isdebugging) {
+ $this->log('Close', $type);
+ }
+ return $container->closehtml;
+ }
+
+ /**
+ * Close all but the last open container. This is useful in places like error
+ * handling, where you want to close all the open containers (apart from )
+ * before outputting the error message.
+ *
+ * @param bool $shouldbenone assert that the stack should be empty now - causes a
+ * developer debug warning if it isn't.
+ * @return string the HTML required to close any open containers inside .
+ */
+ public function pop_all_but_last($shouldbenone = false) {
+ if ($shouldbenone && count($this->opencontainers) != 1) {
+ debugging('Some HTML tags were opened in the body of the page but not closed.
' .
+ $this->output_log(), DEBUG_DEVELOPER);
+ }
+ $output = '';
+ while (count($this->opencontainers) > 1) {
+ $container = array_pop($this->opencontainers);
+ $output .= $container->closehtml;
+ }
+ return $output;
+ }
+
+ /**
+ * You can call this function if you want to throw away an instance of this
+ * class without properly emptying the stack (for example, in a unit test).
+ * Calling this method stops the destruct method from outputting a developer
+ * debug warning. After calling this method, the instance can no longer be used.
+ */
+ public function discard() {
+ $this->opencontainers = null;
+ }
+
+ /**
+ * Adds an entry to the log.
+ *
+ * @param string $action The name of the action
+ * @param string $type The type of action
+ */
+ protected function log($action, $type) {
+ $this->log[] = '' . $action . ' ' . $type . ' at:' .
+ format_backtrace(debug_backtrace()) . ' ';
+ }
+
+ /**
+ * Outputs the log's contents as a HTML list.
+ *
+ * @return string HTML list of the log
+ */
+ protected function output_log() {
+ return '' . implode("\n", $this->log) . '
';
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(xhtml_container_stack::class, \xhtml_container_stack::class);
diff --git a/lib/classes/task/manager.php b/lib/classes/task/manager.php
index 5aba3f187c937..83d4736a5fe5d 100644
--- a/lib/classes/task/manager.php
+++ b/lib/classes/task/manager.php
@@ -664,83 +664,11 @@ public static function get_failed_adhoc_tasks(int $delay = 0): array {
}
/**
- * Ensure quality of service for the ad hoc task queue.
- *
- * This reshuffles the adhoc tasks queue to balance by type to ensure a
- * level of quality of service per type, while still maintaining the
- * relative order of tasks queued by timestamp.
- *
- * @param array $records array of task records
- * @param array $records array of same task records shuffled
- * @deprecated since Moodle 4.1 MDL-67648 - please do not use this method anymore.
- * @todo MDL-74843 This method will be deleted in Moodle 4.5
- * @see \core\task\manager::get_next_adhoc_task
+ * @deprecated since Moodle 4.1 MDL-67648
*/
- public static function ensure_adhoc_task_qos(array $records): array {
- debugging('The method \core\task\manager::ensure_adhoc_task_qos is deprecated.
- Please use \core\task\manager::get_next_adhoc_task instead.', DEBUG_DEVELOPER);
-
- $count = count($records);
- if ($count == 0) {
- return $records;
- }
-
- $queues = []; // This holds a queue for each type of adhoc task.
- $limits = []; // The relative limits of each type of task.
- $limittotal = 0;
-
- // Split the single queue up into queues per type.
- foreach ($records as $record) {
- $type = $record->classname;
- if (!array_key_exists($type, $queues)) {
- $queues[$type] = [];
- }
- if (!array_key_exists($type, $limits)) {
- $limits[$type] = 1;
- $limittotal += 1;
- }
- $queues[$type][] = $record;
- }
-
- $qos = []; // Our new queue with ensured quality of service.
- $seed = $count % $limittotal; // Which task queue to shuffle from first?
-
- $move = 1; // How many tasks to shuffle at a time.
- do {
- $shuffled = 0;
-
- // Now cycle through task type queues and interleaving the tasks
- // back into a single queue.
- foreach ($limits as $type => $limit) {
-
- // Just interleaving the queue is not enough, because after
- // any task is processed the whole queue is rebuilt again. So
- // we need to deterministically start on different types of
- // tasks so that *on average* we rotate through each type of task.
- //
- // We achieve this by using a $seed to start moving tasks off a
- // different queue each time. The seed is based on the task count
- // modulo the number of types of tasks on the queue. As we count
- // down this naturally cycles through each type of record.
- if ($seed < 1) {
- $shuffled = 1;
- $seed += 1;
- continue;
- }
- $tasks = array_splice($queues[$type], 0, $move);
- $qos = array_merge($qos, $tasks);
-
- // Stop if we didn't move any tasks onto the main queue.
- $shuffled += count($tasks);
- }
- // Generally the only tasks that matter are those that are near the start so
- // after we have shuffled the first few 1 by 1, start shuffling larger groups.
- if (count($qos) >= (4 * count($limits))) {
- $move *= 2;
- }
- } while ($shuffled > 0);
-
- return $qos;
+ #[\core\attribute\deprecated('\core\task\manager::get_next_adhoc_task()', since: '4.1', mdl: 'MDL-67648', final: true)]
+ public static function ensure_adhoc_task_qos(): void {
+ \core\deprecation::emit_deprecation_if_present([self::class, __FUNCTION__]);
}
/**
diff --git a/lib/classes/task/update_geoip2file_task.php b/lib/classes/task/update_geoip2file_task.php
new file mode 100644
index 0000000000000..2e7fb7798c4b7
--- /dev/null
+++ b/lib/classes/task/update_geoip2file_task.php
@@ -0,0 +1,183 @@
+.
+
+namespace core\task;
+
+use core\http_client;
+use moodle_exception;
+use PharData;
+
+/**
+ * Simple task to update the GeoIP database file.
+ *
+ * @package core
+ * @author Trisha Milan
+ * @copyright Monash University 2024
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class update_geoip2file_task extends scheduled_task {
+
+ /**
+ * Get a descriptive name for this task (shown to admins).
+ *
+ * @return string
+ */
+ public function get_name(): string {
+ return get_string('taskupdategeoip2file', 'admin');
+ }
+
+ /**
+ * Execute the task to update the GeoIP2 database file.
+ *
+ * @throws \GuzzleHttp\Exception\GuzzleException
+ * @throws moodle_exception
+ */
+ public function execute(): void {
+ global $CFG;
+
+ if (!$CFG->geoipmaxmindaccid || !$CFG->geoipmaxmindlicensekey) {
+ mtrace("MaxMind account information is incomplete. Please configure the account ID and license key.");
+ return;
+ }
+
+ // Setup base directory path and permissions.
+ $geoip2file = $CFG->geoip2file;
+ $geoipdirectory = dirname($geoip2file);
+ if (!check_dir_exists($geoipdirectory) && !mkdir($geoipdirectory, $CFG->directorypermissions, true)) {
+ throw new moodle_exception("Cannot create output directory $geoipdirectory");
+ }
+
+ $geoippermalink = 'https://download.maxmind.com/geoip/databases/' . $CFG->geoipdbedition . '/download';
+
+ $client = new http_client(['auth' => [$CFG->geoipmaxmindaccid, $CFG->geoipmaxmindlicensekey]]);
+ $response = $client->head($geoippermalink, ['query' => ['suffix' => 'tar.gz']]);
+ $headers = $response->getHeaders();
+ $lastmodified = strtotime($headers['Last-Modified'][0]);
+ if (!$this->is_update_needed($geoip2file, $lastmodified)) {
+ mtrace("No update needed. The GeoIP database is up to date.");
+ return;
+ }
+
+ // Define path for downloading the GeoIP2 archive.
+ $archivefilename = 'GeoIP-City.tar.gz';
+ $tempdirectory = make_request_directory(true);
+ $geoipdownloadpath = $tempdirectory . '/' . $archivefilename;
+
+ mtrace("Downloading $CFG->geoipdbedition database from MaxMind......");
+ $response = $client->request('GET', $geoippermalink, [
+ 'query' => ['suffix' => 'tar.gz'],
+ 'sink' => $geoipdownloadpath,
+ ]);
+ if ($response->getStatusCode() != 200) {
+ throw new moodle_exception("Error downloading file.");
+ }
+
+ mtrace("File downloaded successfully to $geoipdownloadpath");
+ mtrace("Verifying checksum......");
+
+ // Get the latest checksum from MaxMind.
+ $checksumcontent = $client->get($geoippermalink, ['query' => ['suffix' => 'tar.gz.sha256']])->getBody()->getContents();
+ list($checksum) = explode(' ', $checksumcontent);
+ if (!$this->verify_checksum($checksum, $geoipdownloadpath)) {
+ throw new moodle_exception("Checksum verification failed.");
+ }
+
+ mtrace("Checksum verified successfully.");
+ if ($this->update_geoip2file($geoipdownloadpath, $tempdirectory, $geoip2file)) {
+ // Store the last seen timestamp.
+ set_config('geoip_last_seen_timestamp', $lastmodified);
+ mtrace("GeoIP database update successful!");
+ } else {
+ throw new moodle_exception("GeoIP database update failed.");
+ }
+ }
+
+ /**
+ * Determines if an update is needed for the GeoIP2 file based on the last modified date.
+ *
+ * @param string $geoip2file The path to the GeoIP2 file that needs to be checked for updates.
+ * @param string $lastmodified The last modified date to be compared against the stored last seen timestamp.
+ * @return bool
+ */
+ private function is_update_needed(string $geoip2file, string $lastmodified): bool {
+ return !file_exists($geoip2file) || $lastmodified !== get_config('core', 'geoip_last_seen_timestamp');
+ }
+
+ /**
+ * Verify the checksum of the downloaded file against an expected checksum.
+ *
+ * @param string $expectedchecksum The checksum expected for the file.
+ * @param string $geoipdownloadpath The path where the downloaded geoip archive is located.
+ * @return bool Returns true if the checksums match, returns false otherwise.
+ */
+ private function verify_checksum(string $expectedchecksum, string $geoipdownloadpath): bool {
+ $actualchecksum = hash_file('sha256', $geoipdownloadpath);
+ return $expectedchecksum === $actualchecksum;
+ }
+
+ /**
+ * Extract the archive and update the GeoIP2 database file.
+ *
+ * @param string $archivepath The path to the archive file that needs to be extracted.
+ * @param string $targetdirectory Directory where the archive contents will be extracted.
+ * @param string $geoip2file The path to move the extracted GeoIP2 file.
+ * @return bool Returns true if the file was successfully extracted and moved to the specified location,
+ * false if any part of the process fails.
+ */
+ private function update_geoip2file(string $archivepath, string $targetdirectory, string $geoip2file): bool {
+ $archive = new PharData($archivepath);
+ $archivename = $archive->getFilename();
+
+ mtrace("Extracting file......");
+ $archive->extractTo($targetdirectory);
+ $sourcefolder = $targetdirectory . '/' . $archivename;
+
+ // Find the mmdb file.
+ $mmdbfiles = glob($sourcefolder . '/*.mmdb');
+ if (count($mmdbfiles) > 1) {
+ throw new moodle_exception("Multiple .mmdb files found in the extracted folder.");
+ } else if (count($mmdbfiles) === 0) {
+ throw new moodle_exception("GeoIP file does not exist.");
+ }
+
+ // Backup existing GeoIP file before attempting to update.
+ $geoip2filename = basename($geoip2file);
+ $backuppath = $targetdirectory . '/' . 'backup_' . $geoip2filename;
+ if (file_exists($geoip2file)) {
+ if (!rename($geoip2file, $backuppath)) {
+ mtrace("Failed to create a backup of the existing GeoIP database.");
+ }
+ mtrace("Temporary backup of existing GeoIP file has been created.");
+ }
+
+ mtrace("Moving {$mmdbfiles[0]} into $geoip2file");
+ if (!copy($mmdbfiles[0], $geoip2file)) {
+ mtrace("Failed to update $geoip2filename.");
+ // Attempt to restore the original file from the backup.
+ if (file_exists($backuppath)) {
+ mtrace("Attempting to restore from backup.");
+ if (!copy($backuppath, $geoip2file)) {
+ throw new moodle_exception("Failed to restore the GeoIP database from backup.");
+ } else {
+ mtrace("The GeoIP database has been restored from the backup successfully.");
+ }
+ }
+ return false;
+ }
+ mtrace("$geoip2filename updated successfully.");
+ return true;
+ }
+}
diff --git a/lib/classes/update/code_manager.php b/lib/classes/update/code_manager.php
index 3493ad427fb99..9be25ed00a420 100644
--- a/lib/classes/update/code_manager.php
+++ b/lib/classes/update/code_manager.php
@@ -14,16 +14,9 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
namespace core\update;
+use core_collator;
use core_component;
use coding_exception;
use moodle_exception;
@@ -44,7 +37,8 @@
* - archive existing version of the plugin source code
* - move (deploy) the plugin source code into the $CFG->dirroot
*
- * @copyright 2015 David Mudrak
+ * @package core
+ * @copyright 2012 David Mudrak
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class code_manager {
@@ -539,6 +533,8 @@ protected function set_plugin_files_permissions($targetdir, array $files) {
protected function move_extracted_plugin_files($sourcedir, $targetdir, array $files) {
global $CFG;
+ // Iterate sorted file list (to ensure directories precede files within them).
+ core_collator::ksort($files);
foreach ($files as $file => $status) {
if ($status !== true) {
throw new moodle_exception('corrupted_archive_structure', 'core_plugin', '', $file, $status);
@@ -548,12 +544,8 @@ protected function move_extracted_plugin_files($sourcedir, $targetdir, array $fi
$target = $targetdir.'/'.$file;
if (is_dir($source)) {
- continue;
-
+ mkdir($target, $CFG->directorypermissions, true);
} else {
- if (!is_dir(dirname($target))) {
- mkdir(dirname($target), $CFG->directorypermissions, true);
- }
rename($source, $target);
}
}
diff --git a/lib/classes/url.php b/lib/classes/url.php
new file mode 100644
index 0000000000000..af29e06d832da
--- /dev/null
+++ b/lib/classes/url.php
@@ -0,0 +1,875 @@
+.
+
+namespace core;
+
+use core\context\user as context_user;
+use core\exception\coding_exception;
+use core\exception\moodle_exception;
+use Psr\Http\Message\UriInterface;
+
+/**
+ * Class for creating and manipulating urls.
+ *
+ * It can be used in moodle pages where config.php has been included without any further includes.
+ *
+ * It is useful for manipulating urls with long lists of params.
+ * One situation where it will be useful is a page which links to itself to perform various actions
+ * and / or to process form data. A url object:
+ * can be created for a page to refer to itself with all the proper get params being passed from page call to
+ * page call and methods can be used to output a url including all the params, optionally adding and overriding
+ * params and can also be used to
+ * - output the url without any get params
+ * - and output the params as hidden fields to be output within a form
+ *
+ * @copyright 2007 jamiesensei
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ */
+class url {
+ /**
+ * Scheme, ex.: http, https
+ * @var string
+ */
+ protected $scheme = '';
+
+ /**
+ * Hostname.
+ * @var string
+ */
+ protected $host = '';
+
+ /**
+ * Port number, empty means default 80 or 443 in case of http.
+ * @var int
+ */
+ protected $port = '';
+
+ /**
+ * Username for http auth.
+ * @var string
+ */
+ protected $user = '';
+
+ /**
+ * Password for http auth.
+ * @var string
+ */
+ protected $pass = '';
+
+ /**
+ * Script path.
+ * @var string
+ */
+ protected $path = '';
+
+ /**
+ * Optional slash argument value.
+ * @var string
+ */
+ protected $slashargument = '';
+
+ /**
+ * Anchor, may be also empty, null means none.
+ * @var string
+ */
+ protected $anchor = null;
+
+ /**
+ * Url parameters as associative array.
+ * @var array
+ */
+ protected $params = [];
+
+ /**
+ * Create new instance of url.
+ *
+ * @param self|string $url - moodle_url means make a copy of another
+ * moodle_url and change parameters, string means full url or shortened
+ * form (ex.: '/course/view.php'). It is strongly encouraged to not include
+ * query string because it may result in double encoded values. Use the
+ * $params instead. For admin URLs, just use /admin/script.php, this
+ * class takes care of the $CFG->admin issue.
+ * @param null|array $params these params override current params or add new
+ * @param string $anchor The anchor to use as part of the URL if there is one.
+ * @throws moodle_exception
+ */
+ public function __construct(
+ $url,
+ ?array $params = null,
+ $anchor = null,
+ ) {
+ global $CFG;
+
+ if ($url instanceof self) {
+ $this->scheme = $url->scheme;
+ $this->host = $url->host;
+ $this->port = $url->port;
+ $this->user = $url->user;
+ $this->pass = $url->pass;
+ $this->path = $url->path;
+ $this->slashargument = $url->slashargument;
+ $this->params = $url->params;
+ $this->anchor = $url->anchor;
+ } else {
+ $url = $url ?? '';
+ // Detect if anchor used.
+ $apos = strpos($url, '#');
+ if ($apos !== false) {
+ $anchor = substr($url, $apos);
+ $anchor = ltrim($anchor, '#');
+ $this->set_anchor($anchor);
+ $url = substr($url, 0, $apos);
+ }
+
+ // Normalise shortened form of our url ex.: '/course/view.php'.
+ if (strpos($url, '/') === 0) {
+ $url = $CFG->wwwroot . $url;
+ }
+
+ if ($CFG->admin !== 'admin') {
+ if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
+ $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
+ }
+ }
+
+ // Parse the $url.
+ $parts = parse_url($url);
+ if ($parts === false) {
+ throw new moodle_exception('invalidurl');
+ }
+ if (isset($parts['query'])) {
+ // Note: the values may not be correctly decoded, url parameters should be always passed as array.
+ parse_str(str_replace('&', '&', $parts['query']), $this->params);
+ }
+ unset($parts['query']);
+ foreach ($parts as $key => $value) {
+ $this->$key = $value;
+ }
+
+ // Detect slashargument value from path - we do not support directory names ending with .php.
+ $pos = strpos($this->path, '.php/');
+ if ($pos !== false) {
+ $this->slashargument = substr($this->path, $pos + 4);
+ $this->path = substr($this->path, 0, $pos + 4);
+ }
+ }
+
+ $this->params($params);
+ if ($anchor !== null) {
+ $this->anchor = (string)$anchor;
+ }
+ }
+
+ /**
+ * Add an array of params to the params for this url.
+ *
+ * The added params override existing ones if they have the same name.
+ *
+ * @param null|array $params Defaults to null. If null then returns all params.
+ * @return array Array of Params for url.
+ * @throws coding_exception
+ */
+ public function params(?array $params = null) {
+ $params = (array)$params;
+
+ foreach ($params as $key => $value) {
+ if (is_int($key)) {
+ throw new coding_exception('Url parameters can not have numeric keys!');
+ }
+ if (!is_string($value)) {
+ if (is_array($value)) {
+ throw new coding_exception('Url parameters values can not be arrays!');
+ }
+ if (is_object($value) && !method_exists($value, '__toString')) {
+ throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
+ }
+ }
+ $this->params[$key] = (string)$value;
+ }
+ return $this->params;
+ }
+
+ /**
+ * Remove all params if no arguments passed.
+ * Remove selected params if arguments are passed.
+ *
+ * Can be called as either remove_params('param1', 'param2')
+ * or remove_params(array('param1', 'param2')).
+ *
+ * @param string[]|string ...$params either an array of param names, or 1..n string params to remove as args.
+ * @return array url parameters
+ */
+ public function remove_params(...$params) {
+ if (empty($params)) {
+ return $this->params;
+ }
+
+ $firstparam = reset($params);
+ if (is_array($firstparam)) {
+ $params = $firstparam;
+ }
+
+ foreach ($params as $param) {
+ unset($this->params[$param]);
+ }
+ return $this->params;
+ }
+
+ /**
+ * Remove all url parameters.
+ *
+ * @param array $unused Unused param
+ */
+ public function remove_all_params($unused = null) {
+ $this->params = [];
+ $this->slashargument = '';
+ }
+
+ /**
+ * Add a param to the params for this url.
+ *
+ * The added param overrides existing one if they have the same name.
+ *
+ * @param string $paramname name
+ * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
+ * @return mixed string parameter value, null if parameter does not exist
+ */
+ public function param($paramname, $newvalue = '') {
+ if (func_num_args() > 1) {
+ // Set new value.
+ $this->params([$paramname => $newvalue]);
+ }
+ if (isset($this->params[$paramname])) {
+ return $this->params[$paramname];
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Merges parameters and validates them
+ *
+ * @param null|array $overrideparams
+ * @return array merged parameters
+ * @throws coding_exception
+ */
+ protected function merge_overrideparams(?array $overrideparams = null) {
+ $overrideparams = (array)$overrideparams;
+ $params = $this->params;
+ foreach ($overrideparams as $key => $value) {
+ if (is_int($key)) {
+ throw new coding_exception('Overridden parameters can not have numeric keys!');
+ }
+ if (is_array($value)) {
+ throw new coding_exception('Overridden parameters values can not be arrays!');
+ }
+ if (is_object($value) && !method_exists($value, '__toString')) {
+ throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
+ }
+ $params[$key] = (string)$value;
+ }
+ return $params;
+ }
+
+ /**
+ * Get the params as as a query string.
+ *
+ * This method should not be used outside of this method.
+ *
+ * @param bool $escaped Use & as params separator instead of plain &
+ * @param null|array $overrideparams params to add to the output params, these
+ * override existing ones with the same name.
+ * @return string query string that can be added to a url.
+ */
+ public function get_query_string($escaped = true, ?array $overrideparams = null) {
+ $arr = [];
+ if ($overrideparams !== null) {
+ $params = $this->merge_overrideparams($overrideparams);
+ } else {
+ $params = $this->params;
+ }
+ foreach ($params as $key => $val) {
+ if (is_array($val)) {
+ foreach ($val as $index => $value) {
+ $arr[] = rawurlencode($key . '[' . $index . ']') . "=" . rawurlencode($value);
+ }
+ } else {
+ if (isset($val) && $val !== '') {
+ $arr[] = rawurlencode($key) . "=" . rawurlencode($val);
+ } else {
+ $arr[] = rawurlencode($key);
+ }
+ }
+ }
+ if ($escaped) {
+ return implode('&', $arr);
+ } else {
+ return implode('&', $arr);
+ }
+ }
+
+ /**
+ * Get the url params as an array of key => value pairs.
+ *
+ * This helps in handling cases where url params contain arrays.
+ *
+ * @return array params array for templates.
+ */
+ public function export_params_for_template(): array {
+ $data = [];
+ foreach ($this->params as $key => $val) {
+ if (is_array($val)) {
+ foreach ($val as $index => $value) {
+ $data[] = ['name' => $key . '[' . $index . ']', 'value' => $value];
+ }
+ } else {
+ $data[] = ['name' => $key, 'value' => $val];
+ }
+ }
+ return $data;
+ }
+
+ /**
+ * Shortcut for printing of encoded URL.
+ *
+ * @return string
+ */
+ public function __toString() {
+ return $this->out(true);
+ }
+
+ /**
+ * Output url.
+ *
+ * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
+ * the returned URL in HTTP headers, you want $escaped=false.
+ *
+ * @param bool $escaped Use & as params separator instead of plain &
+ * @param null|array $overrideparams params to add to the output url, these override existing ones with the same name.
+ * @return string Resulting URL
+ */
+ public function out($escaped = true, ?array $overrideparams = null) {
+
+ global $CFG;
+
+ if (!is_bool($escaped)) {
+ debugging('Escape parameter must be of type boolean, ' . gettype($escaped) . ' given instead.');
+ }
+
+ $url = $this;
+
+ // Allow url's to be rewritten by a plugin.
+ if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
+ $class = $CFG->urlrewriteclass;
+ $pluginurl = $class::url_rewrite($url);
+ if ($pluginurl instanceof url) {
+ $url = $pluginurl;
+ }
+ }
+
+ return $url->raw_out($escaped, $overrideparams);
+ }
+
+ /**
+ * Output url without any rewrites
+ *
+ * This is identical in signature and use to out() but doesn't call the rewrite handler.
+ *
+ * @param bool $escaped Use & as params separator instead of plain &
+ * @param null|array $overrideparams params to add to the output url, these override existing ones with the same name.
+ * @return string Resulting URL
+ */
+ public function raw_out($escaped = true, ?array $overrideparams = null) {
+ if (!is_bool($escaped)) {
+ debugging('Escape parameter must be of type boolean, ' . gettype($escaped) . ' given instead.');
+ }
+
+ $uri = $this->out_omit_querystring() . $this->slashargument;
+
+ $querystring = $this->get_query_string($escaped, $overrideparams);
+ if ($querystring !== '') {
+ $uri .= '?' . $querystring;
+ }
+
+ $uri .= $this->get_encoded_anchor();
+
+ return $uri;
+ }
+
+ /**
+ * Encode the anchor according to RFC 3986.
+ *
+ * @return string The encoded anchor
+ */
+ public function get_encoded_anchor(): string {
+ if (is_null($this->anchor)) {
+ return '';
+ }
+
+ // RFC 3986 allows the following characters in a fragment without them being encoded:
+ // pct-encoded: "%" HEXDIG HEXDIG
+ // unreserved: ALPHA / DIGIT / "-" / "." / "_" / "~" /
+ // sub-delims: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" / ":" / "@"
+ // fragment: "/" / "?"
+ //
+ // All other characters should be encoded.
+ // These should not be encoded in the fragment unless they were already encoded.
+
+ // The following characters are allowed in the fragment without encoding.
+ // In addition to this list is pct-encoded, but we can't easily handle this with a regular expression.
+ $allowed = 'a-zA-Z0-9\\-._~!$&\'()*+,;=:@\/?';
+ $anchor = '#';
+
+ $remainder = $this->anchor;
+ do {
+ // Split the string on any %.
+ $parts = explode('%', $remainder, 2);
+ $anchorparts = array_shift($parts);
+
+ // The first part can go through our preg_replace_callback to quote any relevant characters.
+ $anchor .= preg_replace_callback(
+ '/[^' . $allowed . ']/',
+ fn ($matches) => rawurlencode($matches[0]),
+ $anchorparts,
+ );
+
+ // The second part _might_ be a valid pct-encoded character.
+ if (count($parts) === 0) {
+ break;
+ }
+
+ // If the second part is a valid pct-encoded character, append it to the anchor.
+ $remainder = array_shift($parts);
+ if (preg_match('/^[a-fA-F0-9]{2}/', $remainder, $matches)) {
+ $anchor .= "%{$matches[0]}";
+ $remainder = substr($remainder, 2);
+ } else {
+ // This was not a valid pct-encoded character. Encode the % and continue with the next part.
+ $anchor .= rawurlencode('%');
+ }
+ } while (strlen($remainder) > 0);
+
+ return $anchor;
+ }
+
+ /**
+ * Returns url without parameters, everything before '?'.
+ *
+ * @param bool $includeanchor if {@see self::anchor} is defined, should it be returned?
+ * @return string
+ */
+ public function out_omit_querystring($includeanchor = false) {
+
+ $uri = $this->scheme ? $this->scheme . ':' . ((strtolower($this->scheme) == 'mailto') ? '' : '//') : '';
+ $uri .= $this->user ? $this->user . ($this->pass ? ':' . $this->pass : '') . '@' : '';
+ $uri .= $this->host ? $this->host : '';
+ $uri .= $this->port ? ':' . $this->port : '';
+ $uri .= $this->path ? $this->path : '';
+ if ($includeanchor) {
+ $uri .= $this->get_encoded_anchor();
+ }
+
+ return $uri;
+ }
+
+ /**
+ * Compares this url with another.
+ *
+ * See documentation of constants for an explanation of the comparison flags.
+ *
+ * @param self $url The moodle_url object to compare
+ * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
+ * @return bool
+ */
+ public function compare(self $url, $matchtype = URL_MATCH_EXACT) {
+
+ $baseself = $this->out_omit_querystring();
+ $baseother = $url->out_omit_querystring();
+
+ // Append index.php if there is no specific file.
+ if (substr($baseself, -1) == '/') {
+ $baseself .= 'index.php';
+ }
+ if (substr($baseother, -1) == '/') {
+ $baseother .= 'index.php';
+ }
+
+ // Compare the two base URLs.
+ if ($baseself != $baseother) {
+ return false;
+ }
+
+ if ($matchtype == URL_MATCH_BASE) {
+ return true;
+ }
+
+ $urlparams = $url->params();
+ foreach ($this->params() as $param => $value) {
+ if ($param == 'sesskey') {
+ continue;
+ }
+ if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
+ return false;
+ }
+ }
+
+ if ($matchtype == URL_MATCH_PARAMS) {
+ return true;
+ }
+
+ foreach ($urlparams as $param => $value) {
+ if ($param == 'sesskey') {
+ continue;
+ }
+ if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
+ return false;
+ }
+ }
+
+ if ($url->anchor !== $this->anchor) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Sets the anchor for the URI (the bit after the hash)
+ *
+ * @param string $anchor null means remove previous
+ */
+ public function set_anchor($anchor) {
+ if (is_null($anchor)) {
+ // Remove.
+ $this->anchor = null;
+ } else {
+ $this->anchor = $anchor;
+ }
+ }
+
+ /**
+ * Sets the scheme for the URI (the bit before ://)
+ *
+ * @param string $scheme
+ */
+ public function set_scheme($scheme) {
+ // See http://www.ietf.org/rfc/rfc3986.txt part 3.1.
+ if (preg_match('/^[a-zA-Z][a-zA-Z0-9+.-]*$/', $scheme)) {
+ $this->scheme = $scheme;
+ } else {
+ throw new coding_exception('Bad URL scheme.');
+ }
+ }
+
+ /**
+ * Sets the url slashargument value.
+ *
+ * @param string $path usually file path
+ * @param string $parameter name of page parameter if slasharguments not supported
+ * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
+ */
+ public function set_slashargument($path, $parameter = 'file', $supported = null) {
+ global $CFG;
+ if (is_null($supported)) {
+ $supported = !empty($CFG->slasharguments);
+ }
+
+ if ($supported) {
+ $parts = explode('/', $path);
+ $parts = array_map('rawurlencode', $parts);
+ $path = implode('/', $parts);
+ $this->slashargument = $path;
+ unset($this->params[$parameter]);
+ } else {
+ $this->slashargument = '';
+ $this->params[$parameter] = $path;
+ }
+ }
+
+ // Static factory methods.
+
+ /**
+ * Create a new url instance from a UriInterface.
+ *
+ * @param UriInterface $uri
+ * @return self
+ */
+ public static function from_uri(UriInterface $uri): self {
+ $url = new self(
+ url: $uri->getScheme() . '://' . $uri->getAuthority() . $uri->getPath(),
+ anchor: $uri->getFragment() ?: null,
+ );
+
+ $params = $uri->getQuery();
+ foreach (explode('&', $params) as $param) {
+ $url->param(...explode('=', $param, 2));
+ }
+
+ return $url;
+ }
+
+ /**
+ * General moodle file url.
+ *
+ * @param string $urlbase the script serving the file
+ * @param string $path
+ * @param bool $forcedownload
+ * @return self
+ */
+ public static function make_file_url($urlbase, $path, $forcedownload = false) {
+ $params = [];
+ if ($forcedownload) {
+ $params['forcedownload'] = 1;
+ }
+ $url = new self($urlbase, $params);
+ $url->set_slashargument($path);
+ return $url;
+ }
+
+ /**
+ * Factory method for creation of url pointing to plugin file.
+ *
+ * Please note this method can be used only from the plugins to
+ * create urls of own files, it must not be used outside of plugins!
+ *
+ * @param int $contextid
+ * @param string $component
+ * @param string $area
+ * @param ?int $itemid
+ * @param string $pathname
+ * @param string $filename
+ * @param bool $forcedownload
+ * @param mixed $includetoken Whether to use a user token when displaying this group image.
+ * True indicates to generate a token for current user, and integer value indicates to generate a token for the
+ * user whose id is the value indicated.
+ * If the group picture is included in an e-mail or some other location where the audience is a specific
+ * user who will not be logged in when viewing, then we use a token to authenticate the user.
+ * @return url
+ */
+ public static function make_pluginfile_url(
+ $contextid,
+ $component,
+ $area,
+ $itemid,
+ $pathname,
+ $filename,
+ $forcedownload = false,
+ $includetoken = false
+ ) {
+ global $CFG, $USER;
+
+ $path = [];
+
+ if ($includetoken) {
+ $urlbase = "$CFG->wwwroot/tokenpluginfile.php";
+ $userid = $includetoken === true ? $USER->id : $includetoken;
+ $token = get_user_key('core_files', $userid);
+ if ($CFG->slasharguments) {
+ $path[] = $token;
+ }
+ } else {
+ $urlbase = "$CFG->wwwroot/pluginfile.php";
+ }
+ $path[] = $contextid;
+ $path[] = $component;
+ $path[] = $area;
+
+ if ($itemid !== null) {
+ $path[] = $itemid;
+ }
+
+ $path = "/" . implode('/', $path) . "{$pathname}{$filename}";
+
+ $url = self::make_file_url($urlbase, $path, $forcedownload, $includetoken);
+ if ($includetoken && empty($CFG->slasharguments)) {
+ $url->param('token', $token);
+ }
+ return $url;
+ }
+
+ /**
+ * Factory method for creation of url pointing to plugin file.
+ * This method is the same that make_pluginfile_url but pointing to the webservice pluginfile.php script.
+ * It should be used only in external functions.
+ *
+ * @since 2.8
+ * @param int $contextid
+ * @param string $component
+ * @param string $area
+ * @param int $itemid
+ * @param string $pathname
+ * @param string $filename
+ * @param bool $forcedownload
+ * @return url
+ */
+ public static function make_webservice_pluginfile_url(
+ $contextid,
+ $component,
+ $area,
+ $itemid,
+ $pathname,
+ $filename,
+ $forcedownload = false
+ ) {
+ global $CFG;
+ $urlbase = "$CFG->wwwroot/webservice/pluginfile.php";
+ if ($itemid === null) {
+ return self::make_file_url($urlbase, "/$contextid/$component/$area" . $pathname . $filename, $forcedownload);
+ } else {
+ return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid" . $pathname . $filename, $forcedownload);
+ }
+ }
+
+ /**
+ * Factory method for creation of url pointing to draft file of current user.
+ *
+ * @param int $draftid draft item id
+ * @param string $pathname
+ * @param string $filename
+ * @param bool $forcedownload
+ * @return url
+ */
+ public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
+ global $CFG, $USER;
+ $urlbase = "$CFG->wwwroot/draftfile.php";
+ $context = context_user::instance($USER->id);
+
+ return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid" . $pathname . $filename, $forcedownload);
+ }
+
+ /**
+ * Factory method for creating of links to legacy course files.
+ *
+ * @param int $courseid
+ * @param string $filepath
+ * @param bool $forcedownload
+ * @return url
+ */
+ public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
+ global $CFG;
+
+ $urlbase = "$CFG->wwwroot/file.php";
+ return self::make_file_url($urlbase, '/' . $courseid . '/' . $filepath, $forcedownload);
+ }
+
+ /**
+ * Checks if URL is relative to $CFG->wwwroot.
+ *
+ * @return bool True if URL is relative to $CFG->wwwroot; otherwise, false.
+ */
+ public function is_local_url(): bool {
+ global $CFG;
+
+ $url = $this->out();
+ // Does URL start with wwwroot? Otherwise, URL isn't relative to wwwroot.
+ return ( ($url === $CFG->wwwroot) || (strpos($url, $CFG->wwwroot . '/') === 0) );
+ }
+
+ /**
+ * Returns URL as relative path from $CFG->wwwroot
+ *
+ * Can be used for passing around urls with the wwwroot stripped
+ *
+ * @param boolean $escaped Use & as params separator instead of plain &
+ * @param ?array $overrideparams params to add to the output url, these override existing ones with the same name.
+ * @return string Resulting URL
+ * @throws coding_exception if called on a non-local url
+ */
+ public function out_as_local_url($escaped = true, ?array $overrideparams = null) {
+ global $CFG;
+
+ // URL should be relative to wwwroot. If not then throw exception.
+ if ($this->is_local_url()) {
+ $url = $this->out($escaped, $overrideparams);
+ $localurl = substr($url, strlen($CFG->wwwroot));
+ return !empty($localurl) ? $localurl : '';
+ } else {
+ throw new coding_exception('out_as_local_url called on a non-local URL');
+ }
+ }
+
+ /**
+ * Returns the 'path' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return '/my/file/is/here.txt'.
+ *
+ * By default the path includes slash-arguments (for example,
+ * '/myfile.php/extra/arguments') so it is what you would expect from a
+ * URL path. If you don't want this behaviour, you can opt to exclude the
+ * slash arguments. (Be careful: if the $CFG variable slasharguments is
+ * disabled, these URLs will have a different format and you may need to
+ * look at the 'file' parameter too.)
+ *
+ * @param bool $includeslashargument If true, includes slash arguments
+ * @return string Path of URL
+ */
+ public function get_path($includeslashargument = true) {
+ return $this->path . ($includeslashargument ? $this->slashargument : '');
+ }
+
+ /**
+ * Returns a given parameter value from the URL.
+ *
+ * @param string $name Name of parameter
+ * @return string Value of parameter or null if not set
+ */
+ public function get_param($name) {
+ if (array_key_exists($name, $this->params)) {
+ return $this->params[$name];
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Returns the 'scheme' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return 'http' (without the colon).
+ *
+ * @return string Scheme of the URL.
+ */
+ public function get_scheme() {
+ return $this->scheme;
+ }
+
+ /**
+ * Returns the 'host' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return 'www.example.org'.
+ *
+ * @return string Host of the URL.
+ */
+ public function get_host() {
+ return $this->host;
+ }
+
+ /**
+ * Returns the 'port' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return '447'.
+ *
+ * @return string Port of the URL.
+ */
+ public function get_port() {
+ return $this->port;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(url::class, \moodle_url::class);
diff --git a/lib/completionlib.php b/lib/completionlib.php
index 95ed97a4f1220..b18d4768b58cc 100644
--- a/lib/completionlib.php
+++ b/lib/completionlib.php
@@ -1631,11 +1631,12 @@ public function get_completion_data(int $coursemoduleid, int $userid, array $def
$data->coursemoduleid = $data->cmvcoursemoduleid;
$data->userid = $data->cmvuserid;
}
+ // When reseting all state in the completion, we need to keep current view state.
+ // We cannot assume the activity has been viewed, so we should check if there is any course_modules_viewed already.
+ $data->viewed = is_null($data->cmvuserid) ? 0 : 1;
+
unset($data->cmvcoursemoduleid);
unset($data->cmvuserid);
-
- // When reseting all state in the completion, we need to keep current view state.
- $data->viewed = 1;
}
return (array)$data;
diff --git a/lib/components.json b/lib/components.json
index 651654cc583b4..72680af683e9d 100644
--- a/lib/components.json
+++ b/lib/components.json
@@ -109,6 +109,7 @@
"privacy": "privacy",
"question": "question",
"rating": "rating",
+ "report": "report",
"reportbuilder": "reportbuilder",
"repository": "repository",
"rss": "rss",
diff --git a/lib/db/access.php b/lib/db/access.php
index 69b687aef83a3..eda798dd5b1ed 100644
--- a/lib/db/access.php
+++ b/lib/db/access.php
@@ -2748,4 +2748,14 @@
'manager' => CAP_ALLOW,
]
],
+
+ // Allow users to edit course welcome messages.
+ 'moodle/course:editcoursewelcomemessage' => [
+ 'captype' => 'write',
+ 'contextlevel' => CONTEXT_COURSE,
+ 'archetypes' => [
+ 'editingteacher' => CAP_ALLOW,
+ 'manager' => CAP_ALLOW,
+ ],
+ ],
);
diff --git a/lib/db/legacyclasses.php b/lib/db/legacyclasses.php
index 75076d95c3217..9a244e4b5a37f 100644
--- a/lib/db/legacyclasses.php
+++ b/lib/db/legacyclasses.php
@@ -27,10 +27,17 @@
defined('MOODLE_INTERNAL') || die();
// Like other files in the db directory this file uses an array.
-// The old class name is the key, the path to the file containing the class is the vlaue.
+// The old class name is the key, the path to the file containing the class is the value.
// The array must be called $legacyclasses.
$legacyclasses = [
\bootstrap_renderer::class => 'output/bootstrap_renderer.php',
+
+ // Core API.
+ \emoticon_manager::class => 'emoticon_manager.php',
+ \lang_string::class => 'lang_string.php',
+ \moodle_url::class => 'url.php',
+
+ // Exception API.
\coding_exception::class => 'exception/coding_exception.php',
\file_serving_exception::class => 'exception/file_serving_exception.php',
\invalid_dataroot_permissions::class => 'exception/invalid_dataroot_permissions.php',
@@ -42,4 +49,113 @@
\require_login_session_timeout_exception::class => 'exception/require_login_session_timeout_exception.php',
\required_capability_exception::class => 'exception/required_capability_exception.php',
\webservice_parameter_exception::class => 'exception/webservice_parameter_exception.php',
+
+ // Output API.
+ \theme_config::class => 'output/theme_config.php',
+ \xhtml_container_stack::class => 'output/xhtml_container_stack.php',
+
+ \renderable::class => 'output/renderable.php',
+ \templatable::class => 'output/templatable.php',
+
+ // Output API: Renderer Factories.
+ \renderer_factory::class => 'output/renderer_factory/renderer_factory_interface.php',
+ \renderer_factory_base::class => 'output/renderer_factory/renderer_factory_base.php',
+ \standard_renderer_factory::class => 'output/renderer_factory/standard_renderer_factory.php',
+ \theme_overridden_renderer_factory::class => 'output/renderer_factory/theme_overridden_renderer_factory.php',
+
+ // Output API: Renderers.
+ \renderer_base::class => 'output/renderer_base.php',
+ \plugin_renderer_base::class => 'output/plugin_renderer_base.php',
+ \core_renderer::class => 'output/core_renderer.php',
+ \core_renderer_cli::class => 'output/core_renderer_cli.php',
+ \core_renderer_ajax::class => 'output/core_renderer_ajax.php',
+ \core_renderer_maintenance::class => 'output/core_renderer_maintenance.php',
+ \page_requirements_manager::class => 'output/requirements/page_requirements_manager.php',
+ \YUI_config::class => 'output/requirements/yui.php',
+ \fragment_requirements_manager::class => 'output/requirements/fragment_requirements_manager.php',
+
+ // Output API: components.
+ \file_picker::class => 'output/file_picker.php',
+ \user_picture::class => 'output/user_picture.php',
+ \help_icon::class => 'output/help_icon.php',
+ \pix_icon_font::class => 'output/pix_icon_font.php',
+ \pix_icon_fontawesome::class => 'output/pix_icon_fontawesome.php',
+ \pix_icon::class => 'output/pix_icon.php',
+ \image_icon::class => 'output/image_icon.php',
+ \pix_emoticon::class => 'output/pix_emoticon.php',
+ \single_button::class => 'output/single_button.php',
+ \single_select::class => 'output/single_select.php',
+ \url_select::class => 'output/url_select.php',
+ \action_link::class => 'output/action_link.php',
+ \html_writer::class => 'output/html_writer.php',
+ \js_writer::class => 'output/js_writer.php',
+ \paging_bar::class => 'output/paging_bar.php',
+ \initials_bar::class => 'output/initials_bar.php',
+ \custom_menu_item::class => 'output/custom_menu_item.php',
+ \custom_menu::class => 'output/custom_menu.php',
+ \tabobject::class => 'output/tabobject.php',
+ \context_header::class => 'output/context_header.php',
+ \tabtree::class => 'output/tabtree.php',
+ \action_menu::class => 'output/action_menu.php',
+ \action_menu_filler::class => 'output/action_menu/filler.php',
+ \action_menu_link::class => 'output/action_menu/link.php',
+ \action_menu_link_primary::class => 'output/action_menu/link_primary.php',
+ \action_menu_link_secondary::class => 'output/action_menu/link_secondary.php',
+ \core\output\local\action_menu\subpanel::class => 'output/action_menu/subpanel.php',
+ \preferences_groups::class => 'output/preferences_groups.php',
+ \preferences_group::class => 'output/preferences_group.php',
+ \progress_bar::class => 'output/progress_bar.php',
+ \component_action::class => 'output/actions/component_action.php',
+ \confirm_action::class => 'output/actions/confirm_action.php',
+ \popup_action::class => 'output/actions/popup_action.php',
+
+ // Block Subsystem.
+ \block_contents::class => [
+ 'core_block',
+ 'output/block_contents.php',
+ ],
+ \block_move_target::class => [
+ 'core_block',
+ 'output/block_move_target.php',
+ ],
+
+ // Table Subsystem.
+ \html_table::class => [
+ 'core_table',
+ 'output/html_table.php',
+ ],
+ \html_table_row::class => [
+ 'core_table',
+ 'output/html_table_row.php',
+ ],
+ \html_table_cell::class => [
+ 'core_table',
+ 'output/html_table_cell.php',
+ ],
+ \flexible_table::class => [
+ 'core_table',
+ 'flexible_table.php',
+ ],
+ \table_sql::class => [
+ 'core_table',
+ 'sql_table.php',
+ ],
+ \table_default_export_format_parent::class => [
+ 'core_table',
+ 'base_export_format.php',
+ ],
+ \table_dataformat_export_format::class => [
+ 'core_table',
+ 'dataformat_export_format.php',
+ ],
+
+ // The progress_trace classes.
+ \combined_progress_trace::class => 'output/progress_trace/combined_progress_trace.php',
+ \error_log_progress_trace::class => 'output/progress_trace/error_log_progress_trace.php',
+ \html_list_progress_trace::class => 'output/progress_trace/html_list_progress_trace.php',
+ \html_progress_trace::class => 'output/progress_trace/html_progress_trace.php',
+ \null_progress_trace::class => 'output/progress_trace/null_progress_trace.php',
+ \progress_trace::class => 'output/progress_trace.php',
+ \progress_trace_buffer::class => 'output/progress_trace/progress_trace_buffer.php',
+ \text_progress_trace::class => 'output/progress_trace/text_progress_trace.php',
];
diff --git a/lib/db/services.php b/lib/db/services.php
index 0fffbe9295f0a..feb0ce346c4d9 100644
--- a/lib/db/services.php
+++ b/lib/db/services.php
@@ -373,7 +373,8 @@
'classpath' => 'cohort/externallib.php',
'description' => 'Deletes all specified cohorts.',
'type' => 'write',
- 'capabilities' => 'moodle/cohort:manage'
+ 'capabilities' => 'moodle/cohort:manage',
+ 'ajax' => true,
),
'core_cohort_get_cohort_members' => array(
'classname' => 'core_cohort_external',
diff --git a/lib/db/tasks.php b/lib/db/tasks.php
index 905c73f06e360..0a9548e4b45dc 100644
--- a/lib/db/tasks.php
+++ b/lib/db/tasks.php
@@ -466,4 +466,14 @@
'month' => '*',
'dayofweek' => '*',
],
+ [
+ 'classname' => 'core\task\update_geoip2file_task',
+ 'blocking' => 0,
+ 'minute' => '0',
+ 'hour' => 'R',
+ 'day' => '*',
+ 'month' => '*',
+ 'dayofweek' => 'R',
+ 'disabled' => true,
+ ],
);
diff --git a/lib/dml/tests/dml_read_slave_test.php b/lib/dml/tests/dml_read_slave_test.php
index 9d7514629263c..5bd00d0ab9471 100644
--- a/lib/dml/tests/dml_read_slave_test.php
+++ b/lib/dml/tests/dml_read_slave_test.php
@@ -291,8 +291,6 @@ public function test_read_excluded_tables(): void {
* so the latency parameter is applied properly.
*
* @return void
- * @covers ::can_use_readonly
- * @covers ::commit_delegated_transaction
*/
public function test_transaction(): void {
$DB = $this->new_db(true);
@@ -339,8 +337,6 @@ public function test_transaction(): void {
* so the latency parameter is applied properly.
*
* @return void
- * @covers ::can_use_readonly
- * @covers ::query_end
*/
public function test_long_update(): void {
$DB = $this->new_db(true);
@@ -382,8 +378,6 @@ public function test_long_update(): void {
* when the latency parameter is applied properly.
*
* @return void
- * @covers ::can_use_readonly
- * @covers ::commit_delegated_transaction
*/
public function test_transaction_with_events(): void {
$this->with_global_db(function () {
diff --git a/lib/dml/tests/dml_test.php b/lib/dml/tests/dml_test.php
index f131a84ce3eff..33383df8aa280 100644
--- a/lib/dml/tests/dml_test.php
+++ b/lib/dml/tests/dml_test.php
@@ -530,8 +530,6 @@ public function test_add_sql_debugging(): void {
/**
* Test the database debugging as SQL comment in anon class
- *
- * @covers ::add_sql_debugging
*/
public function test_sql_debugging_anon_class(): void {
global $CFG;
@@ -3924,8 +3922,6 @@ public function test_sql_ceil(): void {
/**
* Test DML libraries sql_cast_to_char method
- *
- * @covers ::sql_cast_to_char
*/
public function test_cast_to_char(): void {
$DB = $this->tdb;
diff --git a/lib/dml/tests/pgsql_native_moodle_database_test.php b/lib/dml/tests/pgsql_native_moodle_database_test.php
index 476d9eae76a3d..a2e12ae7ecaf6 100644
--- a/lib/dml/tests/pgsql_native_moodle_database_test.php
+++ b/lib/dml/tests/pgsql_native_moodle_database_test.php
@@ -395,9 +395,6 @@ public function new_connection($ssl) {
/**
* Test SSL connection.
- *
- * @return void
- * @covers ::raw_connect
*/
public function test_ssl_connection(): void {
$pgconnerr = 'pg_connect(): Unable to connect to PostgreSQL server:';
diff --git a/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature b/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature
index 8b96d75ed4358..74b4a2e387db8 100644
--- a/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature
+++ b/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature
@@ -7,7 +7,9 @@ Feature: Tiny noautolink
Background:
Given I log in as "admin"
And I navigate to "Plugins > Text editors > TinyMCE editor > General settings" in site administration
- And I click on "Enable No auto-link" "link"
+ And I toggle the "Enable No auto-link" admin switch "on"
+ When I open my profile in edit mode
+ And I set the field "Description" to "https://moodle.org
"
@javascript
Scenario: Add and remove auto-link prevention to URLs
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js
index 085863073762b..a08c57003f0d1 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js
@@ -1,3 +1,3 @@
-define("tiny_recordrtc/base_recorder",["exports","core/str","./common","core/pending","./options","editor_tiny/uploader","core/toast","core/modal_events","core/templates","core/notification","core/prefetch","core/local/modal/alert"],(function(_exports,_str,_common,_pending,_options,_uploader,_toast,ModalEvents,Templates,_notification,_prefetch,_alert){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_pending=_interopRequireDefault(_pending),_uploader=_interopRequireDefault(_uploader),ModalEvents=_interopRequireWildcard(ModalEvents),Templates=_interopRequireWildcard(Templates),_alert=_interopRequireDefault(_alert);return _exports.default=class{constructor(editor,modal){var obj,key,value;value=!1,(key="stopRequested")in(obj=this)?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,this.ready=!1,this.checkAndWarnAboutBrowserCompatibility()&&(this.editor=editor,this.config=(0,_options.getData)(editor).params,this.modal=modal,this.modalRoot=modal.getRoot()[0],this.startStopButton=this.modalRoot.querySelector('button[data-action="startstop"]'),this.uploadButton=this.modalRoot.querySelector('button[data-action="upload"]'),this.setRecordButtonState(!1),this.player=this.configurePlayer(),this.registerEventListeners(),this.ready=!0,this.captureUserMedia(),this.prefetchContent())}isReady(){return this.ready}configurePlayer(){throw new Error("configurePlayer() must be implemented in ".concat(this.constructor.name))}getSupportedTypes(){throw new Error("getSupportedTypes() must be implemented in ".concat(this.constructor.name))}getRecordingOptions(){throw new Error("getRecordingOptions() must be implemented in ".concat(this.constructor.name))}getFileName(prefix){throw new Error("getFileName() must be implemented in ".concat(this.constructor.name))}getMediaConstraints(){throw new Error("getMediaConstraints() must be implemented in ".concat(this.constructor.name))}playOnCapture(){return!1}getTimeLimit(){throw new Error("getTimeLimit() must be implemented in ".concat(this.constructor.name))}getEmbedTemplateName(){throw new Error("getEmbedTemplateName() must be implemented in ".concat(this.constructor.name))}static getModalClass(){throw new Error("getModalClass() must be implemented in ".concat(this.constructor.name))}getParsedRecordingOptions(){const compatTypes=this.getSupportedTypes().reduce(((result,type)=>(result.push(type),result.push(type.replace("=",":")),result)),[]).filter((type=>window.MediaRecorder.isTypeSupported(type))),options=this.getRecordingOptions();return 0!==compatTypes.length&&(options.mimeType=compatTypes[0]),window.console.info("Selected codec ".concat(options.mimeType," from ").concat(compatTypes.length," options."),compatTypes),options}async captureUserMedia(){try{const stream=await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());this.handleCaptureSuccess(stream)}catch(error){this.handleCaptureFailure(error)}}prefetchContent(){(0,_prefetch.prefetchStrings)(_common.component,["uploading","recordagain_title","recordagain_desc","discard_title","discard_desc","confirm_yes","recordinguploaded","maxfilesizehit","maxfilesizehit_title","uploadfailed"]),(0,_prefetch.prefetchTemplates)([this.getEmbedTemplateName(),"tiny_recordrtc/timeremaining"])}async displayAlert(title,content){const pendingPromise=new _pending.default("core/confirm:alert"),modal=await _alert.default.create({title:title,body:content,removeOnClose:!0});return modal.show(),pendingPromise.resolve(),modal}handleCaptureSuccess(stream){this.player.srcObject=stream,this.playOnCapture()&&(this.player.muted=!0,this.player.play()),this.stream=stream,this.setupPlayerSource(),this.setRecordButtonState(!0)}setupPlayerSource(){this.player.srcObject||(this.player.srcObject=this.stream,this.player.muted=!0,this.player.play())}setRecordButtonState(enabled){this.startStopButton.disabled=!enabled}setRecordButtonVisibility(visible){this.getButtonContainer("start-stop").classList.toggle("hide",!visible)}setUploadButtonState(enabled){this.uploadButton.disabled=!enabled}setUploadButtonVisibility(visible){this.getButtonContainer("upload").classList.toggle("hide",!visible)}handleCaptureFailure(error){var subject="gum".concat(error.name.replace("Error","").toLowerCase());this.displayAlert((0,_str.getString)("".concat(subject,"_title"),_common.component),(0,_str.getString)(subject,_common.component))}close(){this.modal.hide()}registerEventListeners(){this.modalRoot.addEventListener("click",this.handleModalClick.bind(this)),this.modal.getRoot().on(ModalEvents.outsideClick,this.outsideClickHandler.bind(this)),this.modal.getRoot().on(ModalEvents.hidden,(()=>{this.cleanupStream(),this.requestRecordingStop()}))}async outsideClickHandler(event){if(this.isRecording())event.preventDefault();else if(this.hasData()){event.preventDefault();try{await(0,_notification.saveCancelPromise)(await(0,_str.getString)("discard_title",_common.component),await(0,_str.getString)("discard_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),this.modal.hide()}catch(error){}}}handleModalClick(event){const button=event.target.closest("button");if(button&&button.dataset.action){const action=button.dataset.action;"startstop"===action&&this.handleRecordingStartStopRequested(),"upload"===action&&this.uploadRecording()}}handleRecordingStartStopRequested(){var _this$mediaRecorder;"recording"===(null===(_this$mediaRecorder=this.mediaRecorder)||void 0===_this$mediaRecorder?void 0:_this$mediaRecorder.state)?this.requestRecordingStop():this.startRecording()}async onMediaStopped(){var _this$getButtonContai;this.blob=new Blob(this.data.chunks,{type:this.mediaRecorder.mimeType}),this.player.srcObject=null,this.player.src=URL.createObjectURL(this.blob),this.setRecordButtonTextFromString("recordagain"),this.player.muted=!1,this.player.controls=!0,null===(_this$getButtonContai=this.getButtonContainer("player"))||void 0===_this$getButtonContai||_this$getButtonContai.classList.toggle("hide",!1),this.setUploadButtonVisibility(!0),this.setUploadButtonState(!0)}async uploadRecording(){if(0===this.data.chunks.length)return void this.displayAlert("norecordingfound");const fileName=this.getFileName((1e3*Math.random()).toString().replace(".",""));try{this.setRecordButtonVisibility(!1),this.setUploadButtonState(!1);const fileURL=await(0,_uploader.default)(this.editor,"media",this.blob,fileName,(progress=>{this.setUploadButtonTextProgress(progress)}));this.insertMedia(fileURL),this.close(),(0,_toast.add)(await(0,_str.getString)("recordinguploaded",_common.component))}catch(error){this.setUploadButtonState(!0),(0,_toast.add)(await(0,_str.getString)("uploadfailed",_common.component,{error:error}),{type:"error"})}}getButtonContainer(purpose){return this.modalRoot.querySelector('[data-purpose="'.concat(purpose,'-container"]'))}static isBrowserCompatible(){return this.checkSecure()&&this.hasUserMedia()}static async display(editor){const ModalClass=this.getModalClass(),modal=await ModalClass.create({templateContext:{},large:!0,removeOnClose:!0});return new this(editor,modal).isReady()&&modal.show(),modal}checkAndWarnAboutBrowserCompatibility(){return this.constructor.checkSecure()?!!this.constructor.hasUserMedia||((0,_str.getStrings)(["nowebrtc_title","nowebrtc"].map((key=>({key:key,component:_common.component})))).then((_ref2=>{let[title,message]=_ref2;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1):((0,_str.getStrings)(["insecurealert_title","insecurealert"].map((key=>({key:key,component:_common.component})))).then((_ref=>{let[title,message]=_ref;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1)}static hasUserMedia(){return navigator.mediaDevices&&window.MediaRecorder}static checkSecure(){return window.isSecureContext}async setStopRecordingButton(){const{html:html,js:js}=await Templates.renderForPromise("tiny_recordrtc/timeremaining",this.getTimeRemaining());Templates.replaceNodeContents(this.startStopButton,html,js),this.buttonTimer=setInterval(this.updateRecordButtonTime.bind(this),500)}updateRecordButtonTime(){const{remaining:remaining,minutes:minutes,seconds:seconds}=this.getTimeRemaining();remaining<0?this.requestRecordingStop():(this.startStopButton.querySelector('[data-type="minutes"]').textContent=minutes,this.startStopButton.querySelector('[data-type="seconds"]').textContent=seconds)}async setRecordButtonTextFromString(string){this.startStopButton.textContent=await(0,_str.getString)(string,_common.component)}async setUploadButtonTextProgress(progress){this.uploadButton.textContent=await(0,_str.getString)("uploading",_common.component,{progress:Math.round(100*progress)/100})}async resetUploadButtonText(){this.uploadButton.textContent=await(0,_str.getString)("upload",_common.component)}clearButtonTimer(){this.buttonTimer&&clearInterval(this.buttonTimer),this.buttonTimer=null}getTimeRemaining(){const now=(new Date).getTime(),remaining=Math.floor(this.getTimeLimit()-(now-this.startTime)/1e3),formatter=new Intl.NumberFormat(navigator.language,{minimumIntegerDigits:2}),seconds=formatter.format(remaining%60);return{remaining:remaining,minutes:formatter.format(Math.floor((remaining-seconds)/60)),seconds:seconds}}getMaxUploadSize(){return this.config.maxrecsize}requestRecordingStop(){this.mediaRecorder&&"inactive"!==this.mediaRecorder.state?this.stopRequested=!0:this.cleanupStream()}stopRecorder(){this.mediaRecorder.stop(),this.player.muted=!1}cleanupStream(){this.stream&&this.stream.getTracks().filter((track=>"ended"!==track.readyState)).forEach((track=>track.stop()))}handleStopped(){this.onMediaStopped(),this.clearButtonTimer()}handleStarted(){this.startTime=(new Date).getTime(),this.setStopRecordingButton()}handleDataAvailable(event){if(this.isRecording()){const newSize=this.data.blobSize+event.data.size;newSize>=this.getMaxUploadSize()?(this.stopRecorder(),this.displayFileLimitHitMessage()):(this.data.chunks.push(event.data),this.data.blobSize=newSize,this.stopRequested&&this.stopRecorder())}}async displayFileLimitHitMessage(){(0,_toast.add)(await(0,_str.getString)("maxfilesizehit",_common.component),{title:await(0,_str.getString)("maxfilesizehit_title",_common.component),type:"error"})}isRecording(){var _this$mediaRecorder2;return"recording"===(null===(_this$mediaRecorder2=this.mediaRecorder)||void 0===_this$mediaRecorder2?void 0:_this$mediaRecorder2.state)}hasData(){var _this$data;return!(null===(_this$data=this.data)||void 0===_this$data||!_this$data.blobSize)}async startRecording(){if(this.mediaRecorder){if(this.isRecording()&&this.mediaRecorder.stop(),this.hasData()){if(!await this.recordAgainConfirmation())return;this.setUploadButtonVisibility(!1),this.stream.active||await this.captureUserMedia()}this.mediaRecorder=null}this.mediaRecorder=new MediaRecorder(this.stream,this.getParsedRecordingOptions()),this.mediaRecorder.addEventListener("dataavailable",this.handleDataAvailable.bind(this)),this.mediaRecorder.addEventListener("stop",this.handleStopped.bind(this)),this.mediaRecorder.addEventListener("start",this.handleStarted.bind(this)),this.data={chunks:[],blobSize:0},this.setupPlayerSource(),this.stopRequested=!1,this.mediaRecorder.start(50)}async recordAgainConfirmation(){try{return await(0,_notification.saveCancelPromise)(await(0,_str.getString)("recordagain_title",_common.component),await(0,_str.getString)("recordagain_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),!0}catch{return!1}}async insertMedia(source){const{html:html}=await Templates.renderForPromise(this.getEmbedTemplateName(),this.getEmbedTemplateContext({source:source}));this.editor.insertContent(html)}getEmbedTemplateContext(templateContext){return templateContext}},_exports.default}));
+define("tiny_recordrtc/base_recorder",["exports","core/str","./common","core/pending","./options","editor_tiny/uploader","core/toast","core/modal_events","core/templates","core/notification","core/prefetch","core/local/modal/alert"],(function(_exports,_str,_common,_pending,_options,_uploader,_toast,ModalEvents,Templates,_notification,_prefetch,_alert){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_pending=_interopRequireDefault(_pending),_uploader=_interopRequireDefault(_uploader),ModalEvents=_interopRequireWildcard(ModalEvents),Templates=_interopRequireWildcard(Templates),_alert=_interopRequireDefault(_alert);return _exports.default=class{constructor(editor,modal){_defineProperty(this,"stopRequested",!1),_defineProperty(this,"buttonTimer",null),_defineProperty(this,"pauseTime",null),_defineProperty(this,"startTime",null),this.ready=!1,this.checkAndWarnAboutBrowserCompatibility()&&(this.editor=editor,this.config=(0,_options.getData)(editor).params,this.modal=modal,this.modalRoot=modal.getRoot()[0],this.startStopButton=this.modalRoot.querySelector('button[data-action="startstop"]'),this.uploadButton=this.modalRoot.querySelector('button[data-action="upload"]'),this.pauseResumeButton=this.modalRoot.querySelector('button[data-action="pauseresume"]'),this.setRecordButtonState(!1),this.player=this.configurePlayer(),this.registerEventListeners(),this.ready=!0,this.captureUserMedia(),this.prefetchContent())}isReady(){return this.ready}configurePlayer(){throw new Error("configurePlayer() must be implemented in ".concat(this.constructor.name))}getSupportedTypes(){throw new Error("getSupportedTypes() must be implemented in ".concat(this.constructor.name))}getRecordingOptions(){throw new Error("getRecordingOptions() must be implemented in ".concat(this.constructor.name))}getFileName(prefix){throw new Error("getFileName() must be implemented in ".concat(this.constructor.name))}getMediaConstraints(){throw new Error("getMediaConstraints() must be implemented in ".concat(this.constructor.name))}playOnCapture(){return!1}getTimeLimit(){throw new Error("getTimeLimit() must be implemented in ".concat(this.constructor.name))}getEmbedTemplateName(){throw new Error("getEmbedTemplateName() must be implemented in ".concat(this.constructor.name))}static getModalClass(){throw new Error("getModalClass() must be implemented in ".concat(this.constructor.name))}getParsedRecordingOptions(){const compatTypes=this.getSupportedTypes().reduce(((result,type)=>(result.push(type),result.push(type.replace("=",":")),result)),[]).filter((type=>window.MediaRecorder.isTypeSupported(type))),options=this.getRecordingOptions();return 0!==compatTypes.length&&(options.mimeType=compatTypes[0]),window.console.info("Selected codec ".concat(options.mimeType," from ").concat(compatTypes.length," options."),compatTypes),options}async captureUserMedia(){try{const stream=await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());this.handleCaptureSuccess(stream)}catch(error){this.handleCaptureFailure(error)}}prefetchContent(){(0,_prefetch.prefetchStrings)(_common.component,["uploading","recordagain_title","recordagain_desc","discard_title","discard_desc","confirm_yes","recordinguploaded","maxfilesizehit","maxfilesizehit_title","uploadfailed","pause","resume"]),(0,_prefetch.prefetchTemplates)([this.getEmbedTemplateName(),"tiny_recordrtc/timeremaining"])}async displayAlert(title,content){const pendingPromise=new _pending.default("core/confirm:alert"),modal=await _alert.default.create({title:title,body:content,removeOnClose:!0});return modal.show(),pendingPromise.resolve(),modal}handleCaptureSuccess(stream){this.player.srcObject=stream,this.playOnCapture()&&(this.player.muted=!0,this.player.play()),this.stream=stream,this.setupPlayerSource(),this.setRecordButtonState(!0)}setupPlayerSource(){this.player.srcObject||(this.player.srcObject=this.stream,this.player.muted=!0,this.player.play())}setRecordButtonState(enabled){this.startStopButton.disabled=!enabled}setRecordButtonVisibility(visible){this.getButtonContainer("start-stop").classList.toggle("hide",!visible)}setPauseButtonVisibility(visible){this.pauseResumeButton&&this.pauseResumeButton.classList.toggle("hidden",!visible)}setUploadButtonState(enabled){this.uploadButton.disabled=!enabled}setUploadButtonVisibility(visible){this.getButtonContainer("upload").classList.toggle("hide",!visible)}setPlayerState(state){var _this$getButtonContai;this.player.muted=!state,this.player.controls=state,null===(_this$getButtonContai=this.getButtonContainer("player"))||void 0===_this$getButtonContai||_this$getButtonContai.classList.toggle("hide",!state)}handleCaptureFailure(error){var subject="gum".concat(error.name.replace("Error","").toLowerCase());this.displayAlert((0,_str.getString)("".concat(subject,"_title"),_common.component),(0,_str.getString)(subject,_common.component))}close(){this.modal.hide()}registerEventListeners(){this.modalRoot.addEventListener("click",this.handleModalClick.bind(this)),this.modal.getRoot().on(ModalEvents.outsideClick,this.outsideClickHandler.bind(this)),this.modal.getRoot().on(ModalEvents.hidden,(()=>{this.cleanupStream(),this.requestRecordingStop()}))}async outsideClickHandler(event){if(this.isRecording()||this.isPaused())event.preventDefault();else if(this.hasData()){event.preventDefault();try{await(0,_notification.saveCancelPromise)(await(0,_str.getString)("discard_title",_common.component),await(0,_str.getString)("discard_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),this.modal.hide()}catch(error){}}}handleModalClick(event){const button=event.target.closest("button");if(button&&button.dataset.action){const action=button.dataset.action;"startstop"===action&&this.handleRecordingStartStopRequested(),"upload"===action&&this.uploadRecording(),"pauseresume"===action&&this.handleRecordingPauseResumeRequested()}}handleRecordingStartStopRequested(){this.isRecording()||this.isPaused()?this.requestRecordingStop():this.startRecording()}handleRecordingPauseResumeRequested(){this.isRecording()?this.mediaRecorder.pause():this.isPaused()&&this.mediaRecorder.resume()}async onMediaStopped(){this.blob=new Blob(this.data.chunks,{type:this.mediaRecorder.mimeType}),this.player.srcObject=null,this.player.src=URL.createObjectURL(this.blob),this.setRecordButtonTextFromString("recordagain"),this.setUploadButtonVisibility(!0),this.setPlayerState(!0),this.setUploadButtonState(!0),this.setPauseButtonVisibility(!1),"inactive"===this.mediaRecorder.state&&this.setPauseButtonTextFromString("pause")}async uploadRecording(){if(0===this.data.chunks.length)return void this.displayAlert("norecordingfound");const fileName=this.getFileName((1e3*Math.random()).toString().replace(".",""));try{this.setRecordButtonVisibility(!1),this.setUploadButtonState(!1);const fileURL=await(0,_uploader.default)(this.editor,"media",this.blob,fileName,(progress=>{this.setUploadButtonTextProgress(progress)}));this.insertMedia(fileURL),this.close(),(0,_toast.add)(await(0,_str.getString)("recordinguploaded",_common.component))}catch(error){this.setUploadButtonState(!0),(0,_toast.add)(await(0,_str.getString)("uploadfailed",_common.component,{error:error}),{type:"error"})}}getButtonContainer(purpose){return this.modalRoot.querySelector('[data-purpose="'.concat(purpose,'-container"]'))}static isBrowserCompatible(){return this.checkSecure()&&this.hasUserMedia()}static async display(editor){const ModalClass=this.getModalClass(),modal=await ModalClass.create({templateContext:{isallowedpausing:(0,_options.isPausingAllowed)(editor)},large:!0,removeOnClose:!0});return new this(editor,modal).isReady()&&modal.show(),modal}checkAndWarnAboutBrowserCompatibility(){return this.constructor.checkSecure()?!!this.constructor.hasUserMedia||((0,_str.getStrings)(["nowebrtc_title","nowebrtc"].map((key=>({key:key,component:_common.component})))).then((_ref2=>{let[title,message]=_ref2;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1):((0,_str.getStrings)(["insecurealert_title","insecurealert"].map((key=>({key:key,component:_common.component})))).then((_ref=>{let[title,message]=_ref;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1)}static hasUserMedia(){return navigator.mediaDevices&&window.MediaRecorder}static checkSecure(){return window.isSecureContext}async setStopRecordingButton(){const{html:html,js:js}=await Templates.renderForPromise("tiny_recordrtc/timeremaining",this.getTimeRemaining());Templates.replaceNodeContents(this.startStopButton,html,js),this.startButtonTimer()}updateRecordButtonTime(){const{remaining:remaining,minutes:minutes,seconds:seconds}=this.getTimeRemaining();remaining<0?this.requestRecordingStop():(this.startStopButton.querySelector('[data-type="minutes"]').textContent=minutes,this.startStopButton.querySelector('[data-type="seconds"]').textContent=seconds)}async setRecordButtonTextFromString(string){this.startStopButton.textContent=await(0,_str.getString)(string,_common.component)}async setPauseButtonTextFromString(string){this.pauseResumeButton&&(this.pauseResumeButton.textContent=await(0,_str.getString)(string,_common.component))}async setUploadButtonTextProgress(progress){this.uploadButton.textContent=await(0,_str.getString)("uploading",_common.component,{progress:Math.round(100*progress)/100})}async resetUploadButtonText(){this.uploadButton.textContent=await(0,_str.getString)("upload",_common.component)}clearButtonTimer(){this.buttonTimer&&clearInterval(this.buttonTimer),this.buttonTimer=null,this.pauseTime=null,this.startTime=null}pauseButtonTimer(){this.pauseTime=(new Date).getTime(),this.buttonTimer&&clearInterval(this.buttonTimer)}startButtonTimer(){if(null!==this.pauseTime){const pauseDuration=(new Date).getTime()-this.pauseTime;this.startTime+=pauseDuration,this.pauseTime=null}this.buttonTimer=setInterval(this.updateRecordButtonTime.bind(this),500)}getTimeRemaining(){let now=(new Date).getTime();null!==this.pauseTime&&(now=this.pauseTime);const remaining=Math.floor(this.getTimeLimit()-(now-this.startTime)/1e3),formatter=new Intl.NumberFormat(navigator.language,{minimumIntegerDigits:2}),seconds=formatter.format(remaining%60);return{remaining:remaining,minutes:formatter.format(Math.floor((remaining-seconds)/60)),seconds:seconds}}getMaxUploadSize(){return this.config.maxrecsize}requestRecordingStop(){this.mediaRecorder&&"inactive"!==this.mediaRecorder.state?(this.stopRequested=!0,this.isPaused()&&this.stopRecorder()):this.cleanupStream()}stopRecorder(){this.isPaused()&&(this.pauseTime=null),this.mediaRecorder.stop(),this.player.muted=!1}cleanupStream(){this.stream&&this.stream.getTracks().filter((track=>"ended"!==track.readyState)).forEach((track=>track.stop()))}handleStopped(){this.onMediaStopped(),this.clearButtonTimer()}handleStarted(){this.startTime=(new Date).getTime(),(0,_options.isPausingAllowed)(this.editor)&&!this.isPaused()&&this.setPauseButtonVisibility(!0),this.setStopRecordingButton()}handlePaused(){this.pauseButtonTimer(),this.setPauseButtonTextFromString("resume")}handleResume(){this.startButtonTimer(),this.setPauseButtonTextFromString("pause")}handleDataAvailable(event){if(this.isRecording()||this.isPaused()){const newSize=this.data.blobSize+event.data.size;newSize>=this.getMaxUploadSize()?(this.stopRecorder(),this.displayFileLimitHitMessage()):(this.data.chunks.push(event.data),this.data.blobSize=newSize,this.stopRequested&&this.stopRecorder())}}async displayFileLimitHitMessage(){(0,_toast.add)(await(0,_str.getString)("maxfilesizehit",_common.component),{title:await(0,_str.getString)("maxfilesizehit_title",_common.component),type:"error"})}isRecording(){var _this$mediaRecorder;return"recording"===(null===(_this$mediaRecorder=this.mediaRecorder)||void 0===_this$mediaRecorder?void 0:_this$mediaRecorder.state)}isPaused(){var _this$mediaRecorder2;return"paused"===(null===(_this$mediaRecorder2=this.mediaRecorder)||void 0===_this$mediaRecorder2?void 0:_this$mediaRecorder2.state)}hasData(){var _this$data;return!(null===(_this$data=this.data)||void 0===_this$data||!_this$data.blobSize)}async startRecording(){if(this.mediaRecorder){if((this.isRecording()||this.isPaused())&&this.mediaRecorder.stop(),this.hasData()){if(!await this.recordAgainConfirmation())return;this.setUploadButtonVisibility(!1),this.setPlayerState(!1),this.stream.active||await this.captureUserMedia()}this.mediaRecorder=null}this.mediaRecorder=new MediaRecorder(this.stream,this.getParsedRecordingOptions()),this.mediaRecorder.addEventListener("dataavailable",this.handleDataAvailable.bind(this)),this.mediaRecorder.addEventListener("stop",this.handleStopped.bind(this)),this.mediaRecorder.addEventListener("start",this.handleStarted.bind(this)),this.mediaRecorder.addEventListener("pause",this.handlePaused.bind(this)),this.mediaRecorder.addEventListener("resume",this.handleResume.bind(this)),this.data={chunks:[],blobSize:0},this.setupPlayerSource(),this.stopRequested=!1,this.mediaRecorder.start(50)}async recordAgainConfirmation(){try{return await(0,_notification.saveCancelPromise)(await(0,_str.getString)("recordagain_title",_common.component),await(0,_str.getString)("recordagain_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),!0}catch{return!1}}async insertMedia(source){const{html:html}=await Templates.renderForPromise(this.getEmbedTemplateName(),this.getEmbedTemplateContext({source:source}));this.editor.insertContent(html)}getEmbedTemplateContext(templateContext){return templateContext}},_exports.default}));
//# sourceMappingURL=base_recorder.min.js.map
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map
index a9dbd3cebb052..9eb02d8395575 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map
@@ -1 +1 @@
-{"version":3,"file":"base_recorder.min.js","sources":["../src/base_recorder.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {getString, getStrings} from 'core/str';\nimport {component} from './common';\nimport Pending from 'core/pending';\nimport {getData} from './options';\nimport uploadFile from 'editor_tiny/uploader';\nimport {add as addToast} from 'core/toast';\nimport * as ModalEvents from 'core/modal_events';\nimport * as Templates from 'core/templates';\nimport {saveCancelPromise} from 'core/notification';\nimport {prefetchStrings, prefetchTemplates} from 'core/prefetch';\nimport AlertModal from 'core/local/modal/alert';\n\n/**\n * The RecordRTC base class for audio, video, and any other future types\n */\nexport default class {\n\n stopRequested = false;\n\n /**\n * Constructor for the RecordRTC class\n *\n * @param {TinyMCE} editor The Editor to which the content will be inserted\n * @param {Modal} modal The Moodle Modal that contains the interface used for recording\n */\n constructor(editor, modal) {\n this.ready = false;\n\n if (!this.checkAndWarnAboutBrowserCompatibility()) {\n return;\n }\n\n this.editor = editor;\n this.config = getData(editor).params;\n this.modal = modal;\n this.modalRoot = modal.getRoot()[0];\n this.startStopButton = this.modalRoot.querySelector('button[data-action=\"startstop\"]');\n this.uploadButton = this.modalRoot.querySelector('button[data-action=\"upload\"]');\n\n // Disable the record button untilt he stream is acquired.\n this.setRecordButtonState(false);\n\n this.player = this.configurePlayer();\n this.registerEventListeners();\n this.ready = true;\n\n this.captureUserMedia();\n this.prefetchContent();\n }\n\n /**\n * Check whether the browser is compatible.\n *\n * @returns {boolean}\n */\n isReady() {\n return this.ready;\n }\n\n // Disable eslint's valid-jsdoc rule as the following methods are abstract and mnust be overridden by the child class.\n\n /* eslint-disable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the Player element for this type.\n *\n * @returns {HTMLElement} The player element, typically an audio or video tag.\n */\n configurePlayer() {\n throw new Error(`configurePlayer() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the list of supported mimetypes for this recorder.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/isTypeSupported}\n *\n * @returns {string[]} The list of supported mimetypes.\n */\n getSupportedTypes() {\n throw new Error(`getSupportedTypes() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get any recording options passed into the MediaRecorder.\n * Please note that the mimeType will be fetched from {@link getSupportedTypes()}.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder#options}\n * @returns {Object}\n */\n getRecordingOptions() {\n throw new Error(`getRecordingOptions() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a filename for the generated file.\n *\n * Typically this function will take a prefix and add a type-specific suffix such as the extension to it.\n *\n * @param {string} prefix The prefix for the filename generated by the recorder.\n * @returns {string}\n */\n getFileName(prefix) {\n throw new Error(`getFileName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a list of constraints as required by the getUserMedia() function.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#constraints}\n *\n * @returns {Object}\n */\n getMediaConstraints() {\n throw new Error(`getMediaConstraints() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Whether to start playing the recording as it is captured.\n * @returns {boolean} Whether to start playing the recording as it is captured.\n */\n playOnCapture() {\n return false;\n }\n\n /**\n * Get the time limit for this recording type.\n *\n * @returns {number} The time limit in seconds.\n */\n getTimeLimit() {\n throw new Error(`getTimeLimit() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the name of the template used when embedding the URL in the editor content.\n *\n * @returns {string}\n */\n getEmbedTemplateName() {\n throw new Error(`getEmbedTemplateName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Fetch the Class of the Modal to be displayed.\n *\n * @returns {Modal}\n */\n static getModalClass() {\n throw new Error(`getModalClass() must be implemented in ${this.constructor.name}`);\n }\n\n /* eslint-enable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the options for the MediaRecorder.\n *\n * @returns {object} The options for the MediaRecorder instance.\n */\n getParsedRecordingOptions() {\n const requestedTypes = this.getSupportedTypes();\n const possibleTypes = requestedTypes.reduce((result, type) => {\n result.push(type);\n // Safari seems to use codecs: instead of codecs=.\n // It is safe to add both, so we do, but we want them to remain in order.\n result.push(type.replace('=', ':'));\n return result;\n }, []);\n\n const compatTypes = possibleTypes.filter((type) => window.MediaRecorder.isTypeSupported(type));\n\n const options = this.getRecordingOptions();\n if (compatTypes.length !== 0) {\n options.mimeType = compatTypes[0];\n }\n window.console.info(\n `Selected codec ${options.mimeType} from ${compatTypes.length} options.`,\n compatTypes,\n );\n\n return options;\n }\n\n /**\n * Start capturing the User Media and handle success or failure of the capture.\n */\n async captureUserMedia() {\n try {\n const stream = await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());\n this.handleCaptureSuccess(stream);\n } catch (error) {\n this.handleCaptureFailure(error);\n }\n }\n\n /**\n * Prefetch some of the content that will be used in the UI.\n *\n * Note: not all of the strings used are pre-fetched.\n * Some of the strings will be fetched because their template is used.\n */\n prefetchContent() {\n prefetchStrings(component, [\n 'uploading',\n 'recordagain_title',\n 'recordagain_desc',\n 'discard_title',\n 'discard_desc',\n 'confirm_yes',\n 'recordinguploaded',\n 'maxfilesizehit',\n 'maxfilesizehit_title',\n 'uploadfailed',\n ]);\n\n prefetchTemplates([\n this.getEmbedTemplateName(),\n 'tiny_recordrtc/timeremaining',\n ]);\n }\n\n /**\n * Display an error message to the user.\n *\n * @param {Promise} title The error title\n * @param {Promise} content The error message\n * @returns {Promise}\n */\n async displayAlert(title, content) {\n const pendingPromise = new Pending('core/confirm:alert');\n const modal = await AlertModal.create({\n title: title,\n body: content,\n removeOnClose: true,\n });\n\n modal.show();\n pendingPromise.resolve();\n\n return modal;\n }\n\n /**\n * Handle successful capture of the User Media.\n *\n * @param {MediaStream} stream The stream as captured by the User Media.\n */\n handleCaptureSuccess(stream) {\n // Set audio player source to microphone stream.\n this.player.srcObject = stream;\n\n if (this.playOnCapture()) {\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n\n this.stream = stream;\n this.setupPlayerSource();\n this.setRecordButtonState(true);\n }\n\n /**\n * Setup the player to use the stream as a source.\n */\n setupPlayerSource() {\n if (!this.player.srcObject) {\n this.player.srcObject = this.stream;\n\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n }\n\n /**\n * Enable the record button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setRecordButtonState(enabled) {\n this.startStopButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the record button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setRecordButtonVisibility(visible) {\n const container = this.getButtonContainer('start-stop');\n container.classList.toggle('hide', !visible);\n }\n\n /**\n * Enable the upload button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setUploadButtonState(enabled) {\n this.uploadButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the upload button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setUploadButtonVisibility(visible) {\n const container = this.getButtonContainer('upload');\n container.classList.toggle('hide', !visible);\n }\n /**\n * Handle failure to capture the User Media.\n *\n * @param {Error} error\n */\n handleCaptureFailure(error) {\n // Changes 'CertainError' -> 'gumcertain' to match language string names.\n var subject = `gum${error.name.replace('Error', '').toLowerCase()}`;\n this.displayAlert(\n getString(`${subject}_title`, component),\n getString(subject, component)\n );\n }\n\n /**\n * Close the modal and stop recording.\n */\n close() {\n // Closing the modal will destroy it and remove it from the DOM.\n // It will also stop the recording via the hidden Modal Event.\n this.modal.hide();\n }\n\n /**\n * Register event listeners for the modal.\n */\n registerEventListeners() {\n this.modalRoot.addEventListener('click', this.handleModalClick.bind(this));\n this.modal.getRoot().on(ModalEvents.outsideClick, this.outsideClickHandler.bind(this));\n this.modal.getRoot().on(ModalEvents.hidden, () => {\n this.cleanupStream();\n this.requestRecordingStop();\n });\n }\n\n /**\n * Prevent the Modal from closing when recording is on process.\n *\n * @param {MouseEvent} event The click event\n */\n async outsideClickHandler(event) {\n if (this.isRecording()) {\n // The user is recording.\n // Do not distract with a confirmation, just prevent closing.\n event.preventDefault();\n } else if (this.hasData()) {\n // If there is a blobsize then there is data that may be lost.\n // Ask the user to confirm they want to close the modal.\n // We prevent default here, and then close the modal if they confirm.\n event.preventDefault();\n\n try {\n await saveCancelPromise(\n await getString(\"discard_title\", component),\n await getString(\"discard_desc\", component),\n await getString(\"confirm_yes\", component),\n );\n this.modal.hide();\n } catch (error) {\n // Do nothing, the modal will not close.\n }\n }\n }\n\n /**\n * Handle a click within the Modal.\n *\n * @param {MouseEvent} event The click event\n */\n handleModalClick(event) {\n const button = event.target.closest('button');\n if (button && button.dataset.action) {\n const action = button.dataset.action;\n if (action === 'startstop') {\n this.handleRecordingStartStopRequested();\n }\n\n if (action === 'upload') {\n this.uploadRecording();\n }\n }\n }\n\n /**\n * Handle the click event for the recording start/stop button.\n */\n handleRecordingStartStopRequested() {\n if (this.mediaRecorder?.state === 'recording') {\n this.requestRecordingStop();\n } else {\n this.startRecording();\n }\n }\n\n /**\n * Handle the media stream after it has finished.\n */\n async onMediaStopped() {\n // Set source of audio player.\n this.blob = new Blob(this.data.chunks, {\n type: this.mediaRecorder.mimeType\n });\n this.player.srcObject = null;\n this.player.src = URL.createObjectURL(this.blob);\n\n // Change the label to \"Record again\".\n this.setRecordButtonTextFromString('recordagain');\n\n // Show audio player with controls enabled, and unmute.\n this.player.muted = false;\n this.player.controls = true;\n this.getButtonContainer('player')?.classList.toggle('hide', false);\n\n // Show upload button.\n this.setUploadButtonVisibility(true);\n this.setUploadButtonState(true);\n }\n\n /**\n * Upload the recording and insert it into the editor content.\n */\n async uploadRecording() {\n // Trigger error if no recording has been made.\n if (this.data.chunks.length === 0) {\n this.displayAlert('norecordingfound');\n return;\n }\n\n const fileName = this.getFileName((Math.random() * 1000).toString().replace('.', ''));\n\n // Upload recording to server.\n try {\n // Once uploading starts, do not allow any further changes to the recording.\n this.setRecordButtonVisibility(false);\n\n // Disable the upload button.\n this.setUploadButtonState(false);\n\n // Upload the recording.\n const fileURL = await uploadFile(this.editor, 'media', this.blob, fileName, (progress) => {\n this.setUploadButtonTextProgress(progress);\n });\n this.insertMedia(fileURL);\n this.close();\n addToast(await getString('recordinguploaded', component));\n } catch (error) {\n // Show a toast and unhide the button.\n this.setUploadButtonState(true);\n\n addToast(await getString('uploadfailed', component, {error}), {\n type: 'error',\n });\n\n }\n }\n\n /**\n * Helper to get the container that a button is in.\n *\n * @param {string} purpose The button purpose\n * @returns {HTMLElement}\n */\n getButtonContainer(purpose) {\n return this.modalRoot.querySelector(`[data-purpose=\"${purpose}-container\"]`);\n }\n\n /**\n * Check whether the browser is compatible with capturing media.\n *\n * @returns {boolean}\n */\n static isBrowserCompatible() {\n return this.checkSecure() && this.hasUserMedia();\n }\n\n static async display(editor) {\n const ModalClass = this.getModalClass();\n const modal = await ModalClass.create({\n templateContext: {},\n large: true,\n removeOnClose: true,\n });\n\n // Set up the VideoRecorder.\n const recorder = new this(editor, modal);\n if (recorder.isReady()) {\n modal.show();\n }\n return modal;\n }\n\n /**\n * Check whether the browser is compatible with capturing media, and display a warning if not.\n *\n * @returns {boolean}\n */\n checkAndWarnAboutBrowserCompatibility() {\n if (!this.constructor.checkSecure()) {\n getStrings(['insecurealert_title', 'insecurealert'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n if (!this.constructor.hasUserMedia) {\n getStrings(['nowebrtc_title', 'nowebrtc'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n return true;\n }\n\n /**\n * Check whether the browser supports WebRTC.\n *\n * @returns {boolean}\n */\n static hasUserMedia() {\n return (navigator.mediaDevices && window.MediaRecorder);\n }\n\n /**\n * Check whether the hostname is either hosted over SSL, or from a valid localhost hostname.\n *\n * The UserMedia API can only be used in secure contexts as noted.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#privacy_and_security}\n *\n * @returns {boolean} Whether the plugin can be loaded.\n */\n static checkSecure() {\n // Note: We can now use window.isSecureContext.\n // https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts#feature_detection\n // https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext\n return window.isSecureContext;\n }\n\n /**\n * Update the content of the stop recording button timer.\n */\n async setStopRecordingButton() {\n const {html, js} = await Templates.renderForPromise('tiny_recordrtc/timeremaining', this.getTimeRemaining());\n Templates.replaceNodeContents(this.startStopButton, html, js);\n this.buttonTimer = setInterval(this.updateRecordButtonTime.bind(this), 500);\n }\n\n /**\n * Update the time on the stop recording button.\n */\n updateRecordButtonTime() {\n const {remaining, minutes, seconds} = this.getTimeRemaining();\n if (remaining < 0) {\n this.requestRecordingStop();\n } else {\n this.startStopButton.querySelector('[data-type=\"minutes\"]').textContent = minutes;\n this.startStopButton.querySelector('[data-type=\"seconds\"]').textContent = seconds;\n }\n }\n\n /**\n * Set the text of the record button using a language string.\n *\n * @param {string} string The string identifier\n */\n async setRecordButtonTextFromString(string) {\n this.startStopButton.textContent = await getString(string, component);\n }\n\n /**\n * Set the upload button text progress.\n *\n * @param {number} progress The progress\n */\n async setUploadButtonTextProgress(progress) {\n this.uploadButton.textContent = await getString('uploading', component, {\n progress: Math.round(progress * 100) / 100,\n });\n }\n\n async resetUploadButtonText() {\n this.uploadButton.textContent = await getString('upload', component);\n }\n\n /**\n * Clear the timer for the stop recording button.\n */\n clearButtonTimer() {\n if (this.buttonTimer) {\n clearInterval(this.buttonTimer);\n }\n this.buttonTimer = null;\n }\n\n /**\n * Get the time remaining for the recording.\n *\n * @returns {Object} The minutes and seconds remaining.\n */\n getTimeRemaining() {\n // All times are in milliseconds\n const now = new Date().getTime();\n const remaining = Math.floor(this.getTimeLimit() - ((now - this.startTime) / 1000));\n\n const formatter = new Intl.NumberFormat(navigator.language, {minimumIntegerDigits: 2});\n const seconds = formatter.format(remaining % 60);\n const minutes = formatter.format(Math.floor((remaining - seconds) / 60));\n return {\n remaining,\n minutes,\n seconds,\n };\n }\n\n /**\n * Get the maximum file size that can be uploaded.\n *\n * @returns {number} The max byte size\n */\n getMaxUploadSize() {\n return this.config.maxrecsize;\n }\n\n /**\n * Stop the recording.\n * Please note that this should only stop the recording.\n * Anything related to processing the recording should be handled by the\n * mediaRecorder's stopped event handler which is processed after it has stopped.\n */\n requestRecordingStop() {\n if (this.mediaRecorder && this.mediaRecorder.state !== 'inactive') {\n this.stopRequested = true;\n } else {\n // There is no recording to stop, but the stream must still be cleaned up.\n this.cleanupStream();\n }\n }\n\n stopRecorder() {\n this.mediaRecorder.stop();\n\n // Unmute the player so that the audio is heard during playback.\n this.player.muted = false;\n }\n\n /**\n * Clean up the stream.\n *\n * This involves stopping any track which is still active.\n */\n cleanupStream() {\n if (this.stream) {\n this.stream.getTracks()\n .filter((track) => track.readyState !== 'ended')\n .forEach((track) => track.stop());\n }\n }\n\n /**\n * Handle the mediaRecorder `stop` event.\n */\n handleStopped() {\n // Handle the stream data.\n this.onMediaStopped();\n\n // Clear the button timer.\n this.clearButtonTimer();\n }\n\n /**\n * Handle the mediaRecorder `start` event.\n *\n * This event is called when the recording starts.\n */\n handleStarted() {\n this.startTime = new Date().getTime();\n this.setStopRecordingButton();\n }\n\n /**\n * Handle the mediaRecorder `dataavailable` event.\n *\n * @param {Event} event\n */\n handleDataAvailable(event) {\n if (this.isRecording()) {\n const newSize = this.data.blobSize + event.data.size;\n // Recording stops when either the maximum upload size is reached, or the time limit expires.\n // The time limit is checked in the `updateButtonTime` function.\n if (newSize >= this.getMaxUploadSize()) {\n this.stopRecorder();\n this.displayFileLimitHitMessage();\n } else {\n // Push recording slice to array.\n this.data.chunks.push(event.data);\n\n // Size of all recorded data so far.\n this.data.blobSize = newSize;\n\n if (this.stopRequested) {\n this.stopRecorder();\n }\n }\n }\n }\n\n async displayFileLimitHitMessage() {\n addToast(await getString('maxfilesizehit', component), {\n title: await getString('maxfilesizehit_title', component),\n type: 'error',\n });\n }\n\n /**\n * Check whether the recording is in progress.\n *\n * @returns {boolean}\n */\n isRecording() {\n return this.mediaRecorder?.state === 'recording';\n }\n\n /**\n * Whether any data has been recorded.\n *\n * @returns {boolean}\n */\n hasData() {\n return !!this.data?.blobSize;\n }\n\n /**\n * Start the recording\n */\n async startRecording() {\n if (this.mediaRecorder) {\n // Stop the existing recorder if it exists.\n if (this.isRecording()) {\n this.mediaRecorder.stop();\n }\n\n if (this.hasData()) {\n const resetRecording = await this.recordAgainConfirmation();\n if (!resetRecording) {\n // User cancelled at the confirmation to reset the data, so exit early.\n return;\n }\n this.setUploadButtonVisibility(false);\n if (!this.stream.active) {\n await this.captureUserMedia();\n }\n }\n\n this.mediaRecorder = null;\n }\n\n // The options for the recording codecs and bitrates.\n this.mediaRecorder = new MediaRecorder(this.stream, this.getParsedRecordingOptions());\n\n this.mediaRecorder.addEventListener('dataavailable', this.handleDataAvailable.bind(this));\n this.mediaRecorder.addEventListener('stop', this.handleStopped.bind(this));\n this.mediaRecorder.addEventListener('start', this.handleStarted.bind(this));\n\n this.data = {\n chunks: [],\n blobSize: 0\n };\n this.setupPlayerSource();\n this.stopRequested = false;\n\n // Capture in 50ms chunks.\n this.mediaRecorder.start(50);\n }\n\n /**\n * Confirm whether the user wants to reset the existing recoring.\n *\n * @returns {Promise} Whether the user confirmed the reset.\n */\n async recordAgainConfirmation() {\n try {\n await saveCancelPromise(\n await getString(\"recordagain_title\", component),\n await getString(\"recordagain_desc\", component),\n await getString(\"confirm_yes\", component)\n );\n return true;\n } catch {\n return false;\n }\n }\n\n /**\n * Insert the HTML to embed the recording into the editor content.\n *\n * @param {string} source The URL to view the media.\n */\n async insertMedia(source) {\n const {html} = await Templates.renderForPromise(\n this.getEmbedTemplateName(),\n this.getEmbedTemplateContext({\n source,\n })\n );\n this.editor.insertContent(html);\n }\n\n /**\n * Add or modify the template parameters for the specified type.\n *\n * @param {Object} templateContext The Tempalte context to use\n * @returns {Object} The finalised template context\n */\n getEmbedTemplateContext(templateContext) {\n return templateContext;\n }\n}\n"],"names":["constructor","editor","modal","ready","this","checkAndWarnAboutBrowserCompatibility","config","params","modalRoot","getRoot","startStopButton","querySelector","uploadButton","setRecordButtonState","player","configurePlayer","registerEventListeners","captureUserMedia","prefetchContent","isReady","Error","name","getSupportedTypes","getRecordingOptions","getFileName","prefix","getMediaConstraints","playOnCapture","getTimeLimit","getEmbedTemplateName","getParsedRecordingOptions","compatTypes","reduce","result","type","push","replace","filter","window","MediaRecorder","isTypeSupported","options","length","mimeType","console","info","stream","navigator","mediaDevices","getUserMedia","handleCaptureSuccess","error","handleCaptureFailure","component","title","content","pendingPromise","Pending","AlertModal","create","body","removeOnClose","show","resolve","srcObject","muted","play","setupPlayerSource","enabled","disabled","setRecordButtonVisibility","visible","getButtonContainer","classList","toggle","setUploadButtonState","setUploadButtonVisibility","subject","toLowerCase","displayAlert","close","hide","addEventListener","handleModalClick","bind","on","ModalEvents","outsideClick","outsideClickHandler","hidden","cleanupStream","requestRecordingStop","event","isRecording","preventDefault","hasData","button","target","closest","dataset","action","handleRecordingStartStopRequested","uploadRecording","mediaRecorder","state","startRecording","blob","Blob","data","chunks","src","URL","createObjectURL","setRecordButtonTextFromString","controls","fileName","Math","random","toString","fileURL","progress","setUploadButtonTextProgress","insertMedia","purpose","checkSecure","hasUserMedia","ModalClass","getModalClass","templateContext","large","map","key","then","_ref2","message","catch","_ref","isSecureContext","html","js","Templates","renderForPromise","getTimeRemaining","replaceNodeContents","buttonTimer","setInterval","updateRecordButtonTime","remaining","minutes","seconds","textContent","string","round","clearButtonTimer","clearInterval","now","Date","getTime","floor","startTime","formatter","Intl","NumberFormat","language","minimumIntegerDigits","format","getMaxUploadSize","maxrecsize","stopRequested","stopRecorder","stop","getTracks","track","readyState","forEach","handleStopped","onMediaStopped","handleStarted","setStopRecordingButton","handleDataAvailable","newSize","blobSize","size","displayFileLimitHitMessage","_this$data","recordAgainConfirmation","active","start","source","getEmbedTemplateContext","insertContent"],"mappings":"mrDAiDIA,YAAYC,OAAQC,gCARJ,+IASPC,OAAQ,EAERC,KAAKC,+CAILJ,OAASA,YACTK,QAAS,oBAAQL,QAAQM,YACzBL,MAAQA,WACRM,UAAYN,MAAMO,UAAU,QAC5BC,gBAAkBN,KAAKI,UAAUG,cAAc,wCAC/CC,aAAeR,KAAKI,UAAUG,cAAc,qCAG5CE,sBAAqB,QAErBC,OAASV,KAAKW,uBACdC,8BACAb,OAAQ,OAERc,wBACAC,mBAQTC,iBACWf,KAAKD,MAYhBY,wBACU,IAAIK,yDAAkDhB,KAAKJ,YAAYqB,OASjFC,0BACU,IAAIF,2DAAoDhB,KAAKJ,YAAYqB,OAUnFE,4BACU,IAAIH,6DAAsDhB,KAAKJ,YAAYqB,OAWrFG,YAAYC,cACF,IAAIL,qDAA8ChB,KAAKJ,YAAYqB,OAS7EK,4BACU,IAAIN,6DAAsDhB,KAAKJ,YAAYqB,OAOrFM,uBACW,EAQXC,qBACU,IAAIR,sDAA+ChB,KAAKJ,YAAYqB,OAQ9EQ,6BACU,IAAIT,8DAAuDhB,KAAKJ,YAAYqB,oCAS5E,IAAID,uDAAgDhB,KAAKJ,YAAYqB,OAU/ES,kCAUUC,YATiB3B,KAAKkB,oBACSU,QAAO,CAACC,OAAQC,QACjDD,OAAOE,KAAKD,MAGZD,OAAOE,KAAKD,KAAKE,QAAQ,IAAK,MACvBH,SACR,IAE+BI,QAAQH,MAASI,OAAOC,cAAcC,gBAAgBN,QAElFO,QAAUrC,KAAKmB,6BACM,IAAvBQ,YAAYW,SACZD,QAAQE,SAAWZ,YAAY,IAEnCO,OAAOM,QAAQC,8BACOJ,QAAQE,0BAAiBZ,YAAYW,oBACvDX,aAGGU,2CAQGK,aAAeC,UAAUC,aAAaC,aAAa7C,KAAKsB,4BACzDwB,qBAAqBJ,QAC5B,MAAOK,YACAC,qBAAqBD,QAUlCjC,gDACoBmC,kBAAW,CACvB,YACA,oBACA,mBACA,gBACA,eACA,cACA,oBACA,iBACA,uBACA,iDAGc,CACdjD,KAAKyB,uBACL,oDAWWyB,MAAOC,eAChBC,eAAiB,IAAIC,iBAAQ,sBAC7BvD,YAAcwD,eAAWC,OAAO,CAClCL,MAAOA,MACPM,KAAML,QACNM,eAAe,WAGnB3D,MAAM4D,OACNN,eAAeO,UAER7D,MAQXgD,qBAAqBJ,aAEZhC,OAAOkD,UAAYlB,OAEpB1C,KAAKuB,uBAEAb,OAAOmD,OAAQ,OAEfnD,OAAOoD,aAGXpB,OAASA,YACTqB,yBACAtD,sBAAqB,GAM9BsD,oBACS/D,KAAKU,OAAOkD,iBACRlD,OAAOkD,UAAY5D,KAAK0C,YAGxBhC,OAAOmD,OAAQ,OAEfnD,OAAOoD,QASpBrD,qBAAqBuD,cACZ1D,gBAAgB2D,UAAYD,QAQrCE,0BAA0BC,SACJnE,KAAKoE,mBAAmB,cAChCC,UAAUC,OAAO,QAASH,SAQxCI,qBAAqBP,cACZxD,aAAayD,UAAYD,QAQlCQ,0BAA0BL,SACJnE,KAAKoE,mBAAmB,UAChCC,UAAUC,OAAO,QAASH,SAOxCnB,qBAAqBD,WAEb0B,qBAAgB1B,MAAM9B,KAAKe,QAAQ,QAAS,IAAI0C,oBAC/CC,cACD,4BAAaF,kBAAiBxB,oBAC9B,kBAAUwB,QAASxB,oBAO3B2B,aAGS9E,MAAM+E,OAMfjE,8BACSR,UAAU0E,iBAAiB,QAAS9E,KAAK+E,iBAAiBC,KAAKhF,YAC/DF,MAAMO,UAAU4E,GAAGC,YAAYC,aAAcnF,KAAKoF,oBAAoBJ,KAAKhF,YAC3EF,MAAMO,UAAU4E,GAAGC,YAAYG,QAAQ,UACnCC,qBACAC,oDASaC,UAClBxF,KAAKyF,cAGLD,MAAME,sBACH,GAAI1F,KAAK2F,UAAW,CAIvBH,MAAME,2BAGI,yCACI,kBAAU,gBAAiBzC,yBAC3B,kBAAU,eAAgBA,yBAC1B,kBAAU,cAAeA,yBAE9BnD,MAAM+E,OACb,MAAO9B,UAWjBgC,iBAAiBS,aACPI,OAASJ,MAAMK,OAAOC,QAAQ,aAChCF,QAAUA,OAAOG,QAAQC,OAAQ,OAC3BA,OAASJ,OAAOG,QAAQC,OACf,cAAXA,aACKC,oCAGM,WAAXD,aACKE,mBAQjBD,4DACsC,gDAAzBE,wEAAeC,YACfb,4BAEAc,uEASJC,KAAO,IAAIC,KAAKvG,KAAKwG,KAAKC,OAAQ,CACnC3E,KAAM9B,KAAKmG,cAAc5D,gBAExB7B,OAAOkD,UAAY,UACnBlD,OAAOgG,IAAMC,IAAIC,gBAAgB5G,KAAKsG,WAGtCO,8BAA8B,oBAG9BnG,OAAOmD,OAAQ,OACfnD,OAAOoG,UAAW,qCAClB1C,mBAAmB,kEAAWC,UAAUC,OAAO,QAAQ,QAGvDE,2BAA0B,QAC1BD,sBAAqB,8BAQM,IAA5BvE,KAAKwG,KAAKC,OAAOnE,wBACZqC,aAAa,0BAIhBoC,SAAW/G,KAAKoB,aAA6B,IAAhB4F,KAAKC,UAAiBC,WAAWlF,QAAQ,IAAK,cAKxEkC,2BAA0B,QAG1BK,sBAAqB,SAGpB4C,cAAgB,qBAAWnH,KAAKH,OAAQ,QAASG,KAAKsG,KAAMS,UAAWK,gBACpEC,4BAA4BD,kBAEhCE,YAAYH,cACZvC,6BACU,kBAAU,oBAAqB3B,oBAChD,MAAOF,YAEAwB,sBAAqB,wBAEX,kBAAU,eAAgBtB,kBAAW,CAACF,MAAAA,QAAS,CAC1DjB,KAAM,WAYlBsC,mBAAmBmD,gBACRvH,KAAKI,UAAUG,uCAAgCgH,6DAS/CvH,KAAKwH,eAAiBxH,KAAKyH,oCAGjB5H,cACX6H,WAAa1H,KAAK2H,gBAClB7H,YAAc4H,WAAWnE,OAAO,CAClCqE,gBAAiB,GACjBC,OAAO,EACPpE,eAAe,WAIF,IAAIzD,KAAKH,OAAQC,OACrBiB,WACTjB,MAAM4D,OAEH5D,MAQXG,+CACSD,KAAKJ,YAAY4H,gBAOjBxH,KAAKJ,YAAY6H,mCACP,CAAC,iBAAkB,YAAYK,KAAKC,OAAUA,IAAAA,IAAK9E,UAAAA,uBACzD+E,MAAKC,YAAE/E,MAAOgF,sBAAa,cAASA,QAAS,CAAChF,MAAAA,MAAOpB,KAAM,aAC3DqG,SACE,wBAVI,CAAC,sBAAuB,iBAAiBL,KAAKC,OAAUA,IAAAA,IAAK9E,UAAAA,uBACnE+E,MAAKI,WAAElF,MAAOgF,qBAAa,cAASA,QAAS,CAAChF,MAAAA,MAAOpB,KAAM,aAC3DqG,SACE,gCAmBHxF,UAAUC,cAAgBV,OAAOC,0CAelCD,OAAOmG,qDAORC,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,+BAAgCzI,KAAK0I,oBACzFF,UAAUG,oBAAoB3I,KAAKM,gBAAiBgI,KAAMC,SACrDK,YAAcC,YAAY7I,KAAK8I,uBAAuB9D,KAAKhF,MAAO,KAM3E8I,+BACUC,UAACA,UAADC,QAAYA,QAAZC,QAAqBA,SAAWjJ,KAAK0I,mBACvCK,UAAY,OACPxD,6BAEAjF,gBAAgBC,cAAc,yBAAyB2I,YAAcF,aACrE1I,gBAAgBC,cAAc,yBAAyB2I,YAAcD,6CAS9CE,aAC3B7I,gBAAgB4I,kBAAoB,kBAAUC,OAAQlG,qDAQ7BmE,eACzB5G,aAAa0I,kBAAoB,kBAAU,YAAajG,kBAAW,CACpEmE,SAAUJ,KAAKoC,MAAiB,IAAXhC,UAAkB,yCAKtC5G,aAAa0I,kBAAoB,kBAAU,SAAUjG,mBAM9DoG,mBACQrJ,KAAK4I,aACLU,cAActJ,KAAK4I,kBAElBA,YAAc,KAQvBF,yBAEUa,KAAM,IAAIC,MAAOC,UACjBV,UAAY/B,KAAK0C,MAAM1J,KAAKwB,gBAAmB+H,IAAMvJ,KAAK2J,WAAa,KAEvEC,UAAY,IAAIC,KAAKC,aAAanH,UAAUoH,SAAU,CAACC,qBAAsB,IAC7Ef,QAAUW,UAAUK,OAAOlB,UAAY,UAEtC,CACHA,UAAAA,UACAC,QAHYY,UAAUK,OAAOjD,KAAK0C,OAAOX,UAAYE,SAAW,KAIhEA,QAAAA,SASRiB,0BACWlK,KAAKE,OAAOiK,WASvB5E,uBACQvF,KAAKmG,eAA8C,aAA7BnG,KAAKmG,cAAcC,WACpCgE,eAAgB,OAGhB9E,gBAIb+E,oBACSlE,cAAcmE,YAGd5J,OAAOmD,OAAQ,EAQxByB,gBACQtF,KAAK0C,aACAA,OAAO6H,YACPtI,QAAQuI,OAA+B,UAArBA,MAAMC,aACxBC,SAASF,OAAUA,MAAMF,SAOtCK,qBAESC,sBAGAvB,mBAQTwB,qBACSlB,WAAY,IAAIH,MAAOC,eACvBqB,yBAQTC,oBAAoBvF,UACZxF,KAAKyF,cAAe,OACduF,QAAUhL,KAAKwG,KAAKyE,SAAWzF,MAAMgB,KAAK0E,KAG5CF,SAAWhL,KAAKkK,yBACXG,oBACAc,oCAGA3E,KAAKC,OAAO1E,KAAKyD,MAAMgB,WAGvBA,KAAKyE,SAAWD,QAEjBhL,KAAKoK,oBACAC,yEAOF,kBAAU,iBAAkBpH,mBAAY,CACnDC,YAAa,kBAAU,uBAAwBD,mBAC/CnB,KAAM,UASd2D,6CACyC,iDAAzBU,0EAAeC,OAQ/BT,oDACa3F,KAAKwG,6BAAL4E,WAAWH,oCAOhBjL,KAAKmG,cAAe,IAEhBnG,KAAKyF,oBACAU,cAAcmE,OAGnBtK,KAAK2F,UAAW,WACa3F,KAAKqL,sCAK7B7G,2BAA0B,GAC1BxE,KAAK0C,OAAO4I,cACPtL,KAAKa,wBAIdsF,cAAgB,UAIpBA,cAAgB,IAAIhE,cAAcnC,KAAK0C,OAAQ1C,KAAK0B,kCAEpDyE,cAAcrB,iBAAiB,gBAAiB9E,KAAK+K,oBAAoB/F,KAAKhF,YAC9EmG,cAAcrB,iBAAiB,OAAQ9E,KAAK2K,cAAc3F,KAAKhF,YAC/DmG,cAAcrB,iBAAiB,QAAS9E,KAAK6K,cAAc7F,KAAKhF,YAEhEwG,KAAO,CACRC,OAAQ,GACRwE,SAAU,QAETlH,yBACAqG,eAAgB,OAGhBjE,cAAcoF,MAAM,qDAUf,yCACI,kBAAU,oBAAqBtI,yBAC/B,kBAAU,mBAAoBA,yBAC9B,kBAAU,cAAeA,qBAE5B,EACT,aACS,qBASGuI,cACRlD,KAACA,YAAcE,UAAUC,iBAC3BzI,KAAKyB,uBACLzB,KAAKyL,wBAAwB,CACzBD,OAAAA,eAGH3L,OAAO6L,cAAcpD,MAS9BmD,wBAAwB7D,wBACbA"}
\ No newline at end of file
+{"version":3,"file":"base_recorder.min.js","sources":["../src/base_recorder.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {getString, getStrings} from 'core/str';\nimport {component} from './common';\nimport Pending from 'core/pending';\nimport {getData, isPausingAllowed} from './options';\nimport uploadFile from 'editor_tiny/uploader';\nimport {add as addToast} from 'core/toast';\nimport * as ModalEvents from 'core/modal_events';\nimport * as Templates from 'core/templates';\nimport {saveCancelPromise} from 'core/notification';\nimport {prefetchStrings, prefetchTemplates} from 'core/prefetch';\nimport AlertModal from 'core/local/modal/alert';\n\n/**\n * The RecordRTC base class for audio, video, and any other future types\n */\nexport default class {\n\n stopRequested = false;\n buttonTimer = null;\n pauseTime = null;\n startTime = null;\n\n /**\n * Constructor for the RecordRTC class\n *\n * @param {TinyMCE} editor The Editor to which the content will be inserted\n * @param {Modal} modal The Moodle Modal that contains the interface used for recording\n */\n constructor(editor, modal) {\n this.ready = false;\n\n if (!this.checkAndWarnAboutBrowserCompatibility()) {\n return;\n }\n\n this.editor = editor;\n this.config = getData(editor).params;\n this.modal = modal;\n this.modalRoot = modal.getRoot()[0];\n this.startStopButton = this.modalRoot.querySelector('button[data-action=\"startstop\"]');\n this.uploadButton = this.modalRoot.querySelector('button[data-action=\"upload\"]');\n this.pauseResumeButton = this.modalRoot.querySelector('button[data-action=\"pauseresume\"]');\n\n // Disable the record button untilt he stream is acquired.\n this.setRecordButtonState(false);\n\n this.player = this.configurePlayer();\n this.registerEventListeners();\n this.ready = true;\n\n this.captureUserMedia();\n this.prefetchContent();\n }\n\n /**\n * Check whether the browser is compatible.\n *\n * @returns {boolean}\n */\n isReady() {\n return this.ready;\n }\n\n // Disable eslint's valid-jsdoc rule as the following methods are abstract and mnust be overridden by the child class.\n\n /* eslint-disable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the Player element for this type.\n *\n * @returns {HTMLElement} The player element, typically an audio or video tag.\n */\n configurePlayer() {\n throw new Error(`configurePlayer() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the list of supported mimetypes for this recorder.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/isTypeSupported}\n *\n * @returns {string[]} The list of supported mimetypes.\n */\n getSupportedTypes() {\n throw new Error(`getSupportedTypes() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get any recording options passed into the MediaRecorder.\n * Please note that the mimeType will be fetched from {@link getSupportedTypes()}.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder#options}\n * @returns {Object}\n */\n getRecordingOptions() {\n throw new Error(`getRecordingOptions() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a filename for the generated file.\n *\n * Typically this function will take a prefix and add a type-specific suffix such as the extension to it.\n *\n * @param {string} prefix The prefix for the filename generated by the recorder.\n * @returns {string}\n */\n getFileName(prefix) {\n throw new Error(`getFileName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a list of constraints as required by the getUserMedia() function.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#constraints}\n *\n * @returns {Object}\n */\n getMediaConstraints() {\n throw new Error(`getMediaConstraints() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Whether to start playing the recording as it is captured.\n * @returns {boolean} Whether to start playing the recording as it is captured.\n */\n playOnCapture() {\n return false;\n }\n\n /**\n * Get the time limit for this recording type.\n *\n * @returns {number} The time limit in seconds.\n */\n getTimeLimit() {\n throw new Error(`getTimeLimit() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the name of the template used when embedding the URL in the editor content.\n *\n * @returns {string}\n */\n getEmbedTemplateName() {\n throw new Error(`getEmbedTemplateName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Fetch the Class of the Modal to be displayed.\n *\n * @returns {Modal}\n */\n static getModalClass() {\n throw new Error(`getModalClass() must be implemented in ${this.constructor.name}`);\n }\n\n /* eslint-enable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the options for the MediaRecorder.\n *\n * @returns {object} The options for the MediaRecorder instance.\n */\n getParsedRecordingOptions() {\n const requestedTypes = this.getSupportedTypes();\n const possibleTypes = requestedTypes.reduce((result, type) => {\n result.push(type);\n // Safari seems to use codecs: instead of codecs=.\n // It is safe to add both, so we do, but we want them to remain in order.\n result.push(type.replace('=', ':'));\n return result;\n }, []);\n\n const compatTypes = possibleTypes.filter((type) => window.MediaRecorder.isTypeSupported(type));\n\n const options = this.getRecordingOptions();\n if (compatTypes.length !== 0) {\n options.mimeType = compatTypes[0];\n }\n window.console.info(\n `Selected codec ${options.mimeType} from ${compatTypes.length} options.`,\n compatTypes,\n );\n\n return options;\n }\n\n /**\n * Start capturing the User Media and handle success or failure of the capture.\n */\n async captureUserMedia() {\n try {\n const stream = await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());\n this.handleCaptureSuccess(stream);\n } catch (error) {\n this.handleCaptureFailure(error);\n }\n }\n\n /**\n * Prefetch some of the content that will be used in the UI.\n *\n * Note: not all of the strings used are pre-fetched.\n * Some of the strings will be fetched because their template is used.\n */\n prefetchContent() {\n prefetchStrings(component, [\n 'uploading',\n 'recordagain_title',\n 'recordagain_desc',\n 'discard_title',\n 'discard_desc',\n 'confirm_yes',\n 'recordinguploaded',\n 'maxfilesizehit',\n 'maxfilesizehit_title',\n 'uploadfailed',\n 'pause',\n 'resume',\n ]);\n\n prefetchTemplates([\n this.getEmbedTemplateName(),\n 'tiny_recordrtc/timeremaining',\n ]);\n }\n\n /**\n * Display an error message to the user.\n *\n * @param {Promise} title The error title\n * @param {Promise} content The error message\n * @returns {Promise}\n */\n async displayAlert(title, content) {\n const pendingPromise = new Pending('core/confirm:alert');\n const modal = await AlertModal.create({\n title: title,\n body: content,\n removeOnClose: true,\n });\n\n modal.show();\n pendingPromise.resolve();\n\n return modal;\n }\n\n /**\n * Handle successful capture of the User Media.\n *\n * @param {MediaStream} stream The stream as captured by the User Media.\n */\n handleCaptureSuccess(stream) {\n // Set audio player source to microphone stream.\n this.player.srcObject = stream;\n\n if (this.playOnCapture()) {\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n\n this.stream = stream;\n this.setupPlayerSource();\n this.setRecordButtonState(true);\n }\n\n /**\n * Setup the player to use the stream as a source.\n */\n setupPlayerSource() {\n if (!this.player.srcObject) {\n this.player.srcObject = this.stream;\n\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n }\n\n /**\n * Enable the record button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setRecordButtonState(enabled) {\n this.startStopButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the record button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setRecordButtonVisibility(visible) {\n const container = this.getButtonContainer('start-stop');\n container.classList.toggle('hide', !visible);\n }\n\n /**\n * Configure button visibility for the pause button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setPauseButtonVisibility(visible) {\n if (this.pauseResumeButton) {\n this.pauseResumeButton.classList.toggle('hidden', !visible);\n }\n }\n\n /**\n * Enable the upload button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setUploadButtonState(enabled) {\n this.uploadButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the upload button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setUploadButtonVisibility(visible) {\n const container = this.getButtonContainer('upload');\n container.classList.toggle('hide', !visible);\n }\n\n /**\n * Sets the state of the audio player, including visibility, muting, and controls.\n *\n * @param {boolean} state A boolean indicating the audio player state.\n */\n setPlayerState(state) {\n // Mute or unmute the audio player and show or hide controls.\n this.player.muted = !state;\n this.player.controls = state;\n // Toggle the 'hide' class on the player button container based on state.\n this.getButtonContainer('player')?.classList.toggle('hide', !state);\n }\n\n /**\n * Handle failure to capture the User Media.\n *\n * @param {Error} error\n */\n handleCaptureFailure(error) {\n // Changes 'CertainError' -> 'gumcertain' to match language string names.\n var subject = `gum${error.name.replace('Error', '').toLowerCase()}`;\n this.displayAlert(\n getString(`${subject}_title`, component),\n getString(subject, component)\n );\n }\n\n /**\n * Close the modal and stop recording.\n */\n close() {\n // Closing the modal will destroy it and remove it from the DOM.\n // It will also stop the recording via the hidden Modal Event.\n this.modal.hide();\n }\n\n /**\n * Register event listeners for the modal.\n */\n registerEventListeners() {\n this.modalRoot.addEventListener('click', this.handleModalClick.bind(this));\n this.modal.getRoot().on(ModalEvents.outsideClick, this.outsideClickHandler.bind(this));\n this.modal.getRoot().on(ModalEvents.hidden, () => {\n this.cleanupStream();\n this.requestRecordingStop();\n });\n }\n\n /**\n * Prevent the Modal from closing when recording is on process.\n *\n * @param {MouseEvent} event The click event\n */\n async outsideClickHandler(event) {\n if (this.isRecording() || this.isPaused()) {\n // The user is recording.\n // Do not distract with a confirmation, just prevent closing.\n event.preventDefault();\n } else if (this.hasData()) {\n // If there is a blobsize then there is data that may be lost.\n // Ask the user to confirm they want to close the modal.\n // We prevent default here, and then close the modal if they confirm.\n event.preventDefault();\n\n try {\n await saveCancelPromise(\n await getString(\"discard_title\", component),\n await getString(\"discard_desc\", component),\n await getString(\"confirm_yes\", component),\n );\n this.modal.hide();\n } catch (error) {\n // Do nothing, the modal will not close.\n }\n }\n }\n\n /**\n * Handle a click within the Modal.\n *\n * @param {MouseEvent} event The click event\n */\n handleModalClick(event) {\n const button = event.target.closest('button');\n if (button && button.dataset.action) {\n const action = button.dataset.action;\n if (action === 'startstop') {\n this.handleRecordingStartStopRequested();\n }\n\n if (action === 'upload') {\n this.uploadRecording();\n }\n\n if (action === 'pauseresume') {\n this.handleRecordingPauseResumeRequested();\n }\n }\n }\n\n /**\n * Handle the click event for the recording start/stop button.\n */\n handleRecordingStartStopRequested() {\n if (this.isRecording() || this.isPaused()) {\n this.requestRecordingStop();\n } else {\n this.startRecording();\n }\n }\n\n /**\n * Handle the click event for the recording pause/resume button.\n */\n handleRecordingPauseResumeRequested() {\n if (this.isRecording()) {\n // Pause recording.\n this.mediaRecorder.pause();\n } else if (this.isPaused()) {\n // Resume recording.\n this.mediaRecorder.resume();\n }\n }\n\n /**\n * Handle the media stream after it has finished.\n */\n async onMediaStopped() {\n // Set source of audio player.\n this.blob = new Blob(this.data.chunks, {\n type: this.mediaRecorder.mimeType\n });\n this.player.srcObject = null;\n this.player.src = URL.createObjectURL(this.blob);\n\n // Change the label to \"Record again\".\n this.setRecordButtonTextFromString('recordagain');\n\n // Show upload button.\n this.setUploadButtonVisibility(true);\n this.setPlayerState(true);\n this.setUploadButtonState(true);\n\n // Hide the pause button.\n this.setPauseButtonVisibility(false);\n if (this.mediaRecorder.state === 'inactive') {\n this.setPauseButtonTextFromString('pause');\n }\n }\n\n /**\n * Upload the recording and insert it into the editor content.\n */\n async uploadRecording() {\n // Trigger error if no recording has been made.\n if (this.data.chunks.length === 0) {\n this.displayAlert('norecordingfound');\n return;\n }\n\n const fileName = this.getFileName((Math.random() * 1000).toString().replace('.', ''));\n\n // Upload recording to server.\n try {\n // Once uploading starts, do not allow any further changes to the recording.\n this.setRecordButtonVisibility(false);\n\n // Disable the upload button.\n this.setUploadButtonState(false);\n\n // Upload the recording.\n const fileURL = await uploadFile(this.editor, 'media', this.blob, fileName, (progress) => {\n this.setUploadButtonTextProgress(progress);\n });\n this.insertMedia(fileURL);\n this.close();\n addToast(await getString('recordinguploaded', component));\n } catch (error) {\n // Show a toast and unhide the button.\n this.setUploadButtonState(true);\n\n addToast(await getString('uploadfailed', component, {error}), {\n type: 'error',\n });\n\n }\n }\n\n /**\n * Helper to get the container that a button is in.\n *\n * @param {string} purpose The button purpose\n * @returns {HTMLElement}\n */\n getButtonContainer(purpose) {\n return this.modalRoot.querySelector(`[data-purpose=\"${purpose}-container\"]`);\n }\n\n /**\n * Check whether the browser is compatible with capturing media.\n *\n * @returns {boolean}\n */\n static isBrowserCompatible() {\n return this.checkSecure() && this.hasUserMedia();\n }\n\n static async display(editor) {\n const ModalClass = this.getModalClass();\n const modal = await ModalClass.create({\n templateContext: {\n isallowedpausing: isPausingAllowed(editor),\n },\n large: true,\n removeOnClose: true,\n });\n\n // Set up the VideoRecorder.\n const recorder = new this(editor, modal);\n if (recorder.isReady()) {\n modal.show();\n }\n return modal;\n }\n\n /**\n * Check whether the browser is compatible with capturing media, and display a warning if not.\n *\n * @returns {boolean}\n */\n checkAndWarnAboutBrowserCompatibility() {\n if (!this.constructor.checkSecure()) {\n getStrings(['insecurealert_title', 'insecurealert'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n if (!this.constructor.hasUserMedia) {\n getStrings(['nowebrtc_title', 'nowebrtc'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n return true;\n }\n\n /**\n * Check whether the browser supports WebRTC.\n *\n * @returns {boolean}\n */\n static hasUserMedia() {\n return (navigator.mediaDevices && window.MediaRecorder);\n }\n\n /**\n * Check whether the hostname is either hosted over SSL, or from a valid localhost hostname.\n *\n * The UserMedia API can only be used in secure contexts as noted.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#privacy_and_security}\n *\n * @returns {boolean} Whether the plugin can be loaded.\n */\n static checkSecure() {\n // Note: We can now use window.isSecureContext.\n // https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts#feature_detection\n // https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext\n return window.isSecureContext;\n }\n\n /**\n * Update the content of the stop recording button timer.\n */\n async setStopRecordingButton() {\n const {html, js} = await Templates.renderForPromise('tiny_recordrtc/timeremaining', this.getTimeRemaining());\n Templates.replaceNodeContents(this.startStopButton, html, js);\n this.startButtonTimer();\n }\n\n /**\n * Update the time on the stop recording button.\n */\n updateRecordButtonTime() {\n const {remaining, minutes, seconds} = this.getTimeRemaining();\n if (remaining < 0) {\n this.requestRecordingStop();\n } else {\n this.startStopButton.querySelector('[data-type=\"minutes\"]').textContent = minutes;\n this.startStopButton.querySelector('[data-type=\"seconds\"]').textContent = seconds;\n }\n }\n\n /**\n * Set the text of the record button using a language string.\n *\n * @param {string} string The string identifier\n */\n async setRecordButtonTextFromString(string) {\n this.startStopButton.textContent = await getString(string, component);\n }\n\n /**\n * Set the text of the pause button using a language string.\n *\n * @param {string} string The string identifier\n */\n async setPauseButtonTextFromString(string) {\n if (this.pauseResumeButton) {\n this.pauseResumeButton.textContent = await getString(string, component);\n }\n }\n\n /**\n * Set the upload button text progress.\n *\n * @param {number} progress The progress\n */\n async setUploadButtonTextProgress(progress) {\n this.uploadButton.textContent = await getString('uploading', component, {\n progress: Math.round(progress * 100) / 100,\n });\n }\n\n async resetUploadButtonText() {\n this.uploadButton.textContent = await getString('upload', component);\n }\n\n /**\n * Clear the timer for the stop recording button.\n */\n clearButtonTimer() {\n if (this.buttonTimer) {\n clearInterval(this.buttonTimer);\n }\n this.buttonTimer = null;\n this.pauseTime = null;\n this.startTime = null;\n }\n\n /**\n * Pause the timer for the stop recording button.\n */\n pauseButtonTimer() {\n // Stop the countdown timer.\n this.pauseTime = new Date().getTime(); // Store pause time.\n if (this.buttonTimer) {\n clearInterval(this.buttonTimer);\n }\n }\n\n /**\n * Start the timer for the start recording button.\n * If the recording was paused, the timer will resume from the pause time.\n */\n startButtonTimer() {\n if (this.pauseTime !== null) {\n // Resume from pause.\n const pauseDuration = new Date().getTime() - this.pauseTime;\n // Adjust start time by pause duration.\n this.startTime += pauseDuration;\n this.pauseTime = null;\n }\n this.buttonTimer = setInterval(this.updateRecordButtonTime.bind(this), 500);\n }\n\n /**\n * Get the time remaining for the recording.\n *\n * @returns {Object} The minutes and seconds remaining.\n */\n getTimeRemaining() {\n // All times are in milliseconds.\n let now = new Date().getTime();\n if (this.pauseTime !== null) {\n // If paused, use pauseTime instead of current time.\n now = this.pauseTime;\n }\n const remaining = Math.floor(this.getTimeLimit() - ((now - this.startTime) / 1000));\n\n const formatter = new Intl.NumberFormat(navigator.language, {minimumIntegerDigits: 2});\n const seconds = formatter.format(remaining % 60);\n const minutes = formatter.format(Math.floor((remaining - seconds) / 60));\n return {\n remaining,\n minutes,\n seconds,\n };\n }\n\n /**\n * Get the maximum file size that can be uploaded.\n *\n * @returns {number} The max byte size\n */\n getMaxUploadSize() {\n return this.config.maxrecsize;\n }\n\n /**\n * Stop the recording.\n * Please note that this should only stop the recording.\n * Anything related to processing the recording should be handled by the\n * mediaRecorder's stopped event handler which is processed after it has stopped.\n */\n requestRecordingStop() {\n if (this.mediaRecorder && this.mediaRecorder.state !== 'inactive') {\n this.stopRequested = true;\n if (this.isPaused()) {\n this.stopRecorder();\n }\n } else {\n // There is no recording to stop, but the stream must still be cleaned up.\n this.cleanupStream();\n }\n }\n\n stopRecorder() {\n if (this.isPaused()) {\n this.pauseTime = null;\n }\n this.mediaRecorder.stop();\n\n // Unmute the player so that the audio is heard during playback.\n this.player.muted = false;\n }\n\n /**\n * Clean up the stream.\n *\n * This involves stopping any track which is still active.\n */\n cleanupStream() {\n if (this.stream) {\n this.stream.getTracks()\n .filter((track) => track.readyState !== 'ended')\n .forEach((track) => track.stop());\n }\n }\n\n /**\n * Handle the mediaRecorder `stop` event.\n */\n handleStopped() {\n // Handle the stream data.\n this.onMediaStopped();\n\n // Clear the button timer.\n this.clearButtonTimer();\n }\n\n /**\n * Handle the mediaRecorder `start` event.\n *\n * This event is called when the recording starts.\n */\n handleStarted() {\n this.startTime = new Date().getTime();\n if (isPausingAllowed(this.editor) && !this.isPaused()) {\n this.setPauseButtonVisibility(true);\n }\n this.setStopRecordingButton();\n }\n\n /**\n * Handle the mediaRecorder `pause` event.\n *\n * This event is called when the recording pauses.\n */\n handlePaused() {\n this.pauseButtonTimer();\n this.setPauseButtonTextFromString('resume');\n }\n\n /**\n * Handle the mediaRecorder `resume` event.\n *\n * This event is called when the recording resumes.\n */\n handleResume() {\n this.startButtonTimer();\n this.setPauseButtonTextFromString('pause');\n }\n\n /**\n * Handle the mediaRecorder `dataavailable` event.\n *\n * @param {Event} event\n */\n handleDataAvailable(event) {\n if (this.isRecording() || this.isPaused()) {\n const newSize = this.data.blobSize + event.data.size;\n // Recording stops when either the maximum upload size is reached, or the time limit expires.\n // The time limit is checked in the `updateButtonTime` function.\n if (newSize >= this.getMaxUploadSize()) {\n this.stopRecorder();\n this.displayFileLimitHitMessage();\n } else {\n // Push recording slice to array.\n this.data.chunks.push(event.data);\n\n // Size of all recorded data so far.\n this.data.blobSize = newSize;\n\n if (this.stopRequested) {\n this.stopRecorder();\n }\n }\n }\n }\n\n async displayFileLimitHitMessage() {\n addToast(await getString('maxfilesizehit', component), {\n title: await getString('maxfilesizehit_title', component),\n type: 'error',\n });\n }\n\n /**\n * Check whether the recording is in progress.\n *\n * @returns {boolean}\n */\n isRecording() {\n return this.mediaRecorder?.state === 'recording';\n }\n\n /**\n * Check whether the recording is paused.\n *\n * @returns {boolean}\n */\n isPaused() {\n return this.mediaRecorder?.state === 'paused';\n }\n\n /**\n * Whether any data has been recorded.\n *\n * @returns {boolean}\n */\n hasData() {\n return !!this.data?.blobSize;\n }\n\n /**\n * Start the recording\n */\n async startRecording() {\n if (this.mediaRecorder) {\n // Stop the existing recorder if it exists.\n if (this.isRecording() || this.isPaused()) {\n this.mediaRecorder.stop();\n }\n\n if (this.hasData()) {\n const resetRecording = await this.recordAgainConfirmation();\n if (!resetRecording) {\n // User cancelled at the confirmation to reset the data, so exit early.\n return;\n }\n this.setUploadButtonVisibility(false);\n this.setPlayerState(false);\n if (!this.stream.active) {\n await this.captureUserMedia();\n }\n }\n\n this.mediaRecorder = null;\n }\n\n // The options for the recording codecs and bitrates.\n this.mediaRecorder = new MediaRecorder(this.stream, this.getParsedRecordingOptions());\n\n this.mediaRecorder.addEventListener('dataavailable', this.handleDataAvailable.bind(this));\n this.mediaRecorder.addEventListener('stop', this.handleStopped.bind(this));\n this.mediaRecorder.addEventListener('start', this.handleStarted.bind(this));\n this.mediaRecorder.addEventListener('pause', this.handlePaused.bind(this));\n this.mediaRecorder.addEventListener('resume', this.handleResume.bind(this));\n\n this.data = {\n chunks: [],\n blobSize: 0\n };\n this.setupPlayerSource();\n this.stopRequested = false;\n\n // Capture in 50ms chunks.\n this.mediaRecorder.start(50);\n }\n\n /**\n * Confirm whether the user wants to reset the existing recoring.\n *\n * @returns {Promise} Whether the user confirmed the reset.\n */\n async recordAgainConfirmation() {\n try {\n await saveCancelPromise(\n await getString(\"recordagain_title\", component),\n await getString(\"recordagain_desc\", component),\n await getString(\"confirm_yes\", component)\n );\n return true;\n } catch {\n return false;\n }\n }\n\n /**\n * Insert the HTML to embed the recording into the editor content.\n *\n * @param {string} source The URL to view the media.\n */\n async insertMedia(source) {\n const {html} = await Templates.renderForPromise(\n this.getEmbedTemplateName(),\n this.getEmbedTemplateContext({\n source,\n })\n );\n this.editor.insertContent(html);\n }\n\n /**\n * Add or modify the template parameters for the specified type.\n *\n * @param {Object} templateContext The Tempalte context to use\n * @returns {Object} The finalised template context\n */\n getEmbedTemplateContext(templateContext) {\n return templateContext;\n }\n}\n"],"names":["constructor","editor","modal","ready","this","checkAndWarnAboutBrowserCompatibility","config","params","modalRoot","getRoot","startStopButton","querySelector","uploadButton","pauseResumeButton","setRecordButtonState","player","configurePlayer","registerEventListeners","captureUserMedia","prefetchContent","isReady","Error","name","getSupportedTypes","getRecordingOptions","getFileName","prefix","getMediaConstraints","playOnCapture","getTimeLimit","getEmbedTemplateName","getParsedRecordingOptions","compatTypes","reduce","result","type","push","replace","filter","window","MediaRecorder","isTypeSupported","options","length","mimeType","console","info","stream","navigator","mediaDevices","getUserMedia","handleCaptureSuccess","error","handleCaptureFailure","component","title","content","pendingPromise","Pending","AlertModal","create","body","removeOnClose","show","resolve","srcObject","muted","play","setupPlayerSource","enabled","disabled","setRecordButtonVisibility","visible","getButtonContainer","classList","toggle","setPauseButtonVisibility","setUploadButtonState","setUploadButtonVisibility","setPlayerState","state","controls","subject","toLowerCase","displayAlert","close","hide","addEventListener","handleModalClick","bind","on","ModalEvents","outsideClick","outsideClickHandler","hidden","cleanupStream","requestRecordingStop","event","isRecording","isPaused","preventDefault","hasData","button","target","closest","dataset","action","handleRecordingStartStopRequested","uploadRecording","handleRecordingPauseResumeRequested","startRecording","mediaRecorder","pause","resume","blob","Blob","data","chunks","src","URL","createObjectURL","setRecordButtonTextFromString","setPauseButtonTextFromString","fileName","Math","random","toString","fileURL","progress","setUploadButtonTextProgress","insertMedia","purpose","checkSecure","hasUserMedia","ModalClass","getModalClass","templateContext","isallowedpausing","large","map","key","then","_ref2","message","catch","_ref","isSecureContext","html","js","Templates","renderForPromise","getTimeRemaining","replaceNodeContents","startButtonTimer","updateRecordButtonTime","remaining","minutes","seconds","textContent","string","round","clearButtonTimer","buttonTimer","clearInterval","pauseTime","startTime","pauseButtonTimer","Date","getTime","pauseDuration","setInterval","now","floor","formatter","Intl","NumberFormat","language","minimumIntegerDigits","format","getMaxUploadSize","maxrecsize","stopRequested","stopRecorder","stop","getTracks","track","readyState","forEach","handleStopped","onMediaStopped","handleStarted","setStopRecordingButton","handlePaused","handleResume","handleDataAvailable","newSize","blobSize","size","displayFileLimitHitMessage","_this$data","recordAgainConfirmation","active","start","source","getEmbedTemplateContext","insertContent"],"mappings":"u1DAoDIA,YAAYC,OAAQC,6CAXJ,sCACF,uCACF,uCACA,WASHC,OAAQ,EAERC,KAAKC,+CAILJ,OAASA,YACTK,QAAS,oBAAQL,QAAQM,YACzBL,MAAQA,WACRM,UAAYN,MAAMO,UAAU,QAC5BC,gBAAkBN,KAAKI,UAAUG,cAAc,wCAC/CC,aAAeR,KAAKI,UAAUG,cAAc,qCAC5CE,kBAAoBT,KAAKI,UAAUG,cAAc,0CAGjDG,sBAAqB,QAErBC,OAASX,KAAKY,uBACdC,8BACAd,OAAQ,OAERe,wBACAC,mBAQTC,iBACWhB,KAAKD,MAYhBa,wBACU,IAAIK,yDAAkDjB,KAAKJ,YAAYsB,OASjFC,0BACU,IAAIF,2DAAoDjB,KAAKJ,YAAYsB,OAUnFE,4BACU,IAAIH,6DAAsDjB,KAAKJ,YAAYsB,OAWrFG,YAAYC,cACF,IAAIL,qDAA8CjB,KAAKJ,YAAYsB,OAS7EK,4BACU,IAAIN,6DAAsDjB,KAAKJ,YAAYsB,OAOrFM,uBACW,EAQXC,qBACU,IAAIR,sDAA+CjB,KAAKJ,YAAYsB,OAQ9EQ,6BACU,IAAIT,8DAAuDjB,KAAKJ,YAAYsB,oCAS5E,IAAID,uDAAgDjB,KAAKJ,YAAYsB,OAU/ES,kCAUUC,YATiB5B,KAAKmB,oBACSU,QAAO,CAACC,OAAQC,QACjDD,OAAOE,KAAKD,MAGZD,OAAOE,KAAKD,KAAKE,QAAQ,IAAK,MACvBH,SACR,IAE+BI,QAAQH,MAASI,OAAOC,cAAcC,gBAAgBN,QAElFO,QAAUtC,KAAKoB,6BACM,IAAvBQ,YAAYW,SACZD,QAAQE,SAAWZ,YAAY,IAEnCO,OAAOM,QAAQC,8BACOJ,QAAQE,0BAAiBZ,YAAYW,oBACvDX,aAGGU,2CAQGK,aAAeC,UAAUC,aAAaC,aAAa9C,KAAKuB,4BACzDwB,qBAAqBJ,QAC5B,MAAOK,YACAC,qBAAqBD,QAUlCjC,gDACoBmC,kBAAW,CACvB,YACA,oBACA,mBACA,gBACA,eACA,cACA,oBACA,iBACA,uBACA,eACA,QACA,2CAGc,CACdlD,KAAK0B,uBACL,oDAWWyB,MAAOC,eAChBC,eAAiB,IAAIC,iBAAQ,sBAC7BxD,YAAcyD,eAAWC,OAAO,CAClCL,MAAOA,MACPM,KAAML,QACNM,eAAe,WAGnB5D,MAAM6D,OACNN,eAAeO,UAER9D,MAQXiD,qBAAqBJ,aAEZhC,OAAOkD,UAAYlB,OAEpB3C,KAAKwB,uBAEAb,OAAOmD,OAAQ,OAEfnD,OAAOoD,aAGXpB,OAASA,YACTqB,yBACAtD,sBAAqB,GAM9BsD,oBACShE,KAAKW,OAAOkD,iBACRlD,OAAOkD,UAAY7D,KAAK2C,YAGxBhC,OAAOmD,OAAQ,OAEfnD,OAAOoD,QASpBrD,qBAAqBuD,cACZ3D,gBAAgB4D,UAAYD,QAQrCE,0BAA0BC,SACJpE,KAAKqE,mBAAmB,cAChCC,UAAUC,OAAO,QAASH,SAQxCI,yBAAyBJ,SACjBpE,KAAKS,wBACAA,kBAAkB6D,UAAUC,OAAO,UAAWH,SAS3DK,qBAAqBR,cACZzD,aAAa0D,UAAYD,QAQlCS,0BAA0BN,SACJpE,KAAKqE,mBAAmB,UAChCC,UAAUC,OAAO,QAASH,SAQxCO,eAAeC,sCAENjE,OAAOmD,OAASc,WAChBjE,OAAOkE,SAAWD,yCAElBP,mBAAmB,kEAAWC,UAAUC,OAAO,QAASK,OAQjE3B,qBAAqBD,WAEb8B,qBAAgB9B,MAAM9B,KAAKe,QAAQ,QAAS,IAAI8C,oBAC/CC,cACD,4BAAaF,kBAAiB5B,oBAC9B,kBAAU4B,QAAS5B,oBAO3B+B,aAGSnF,MAAMoF,OAMfrE,8BACST,UAAU+E,iBAAiB,QAASnF,KAAKoF,iBAAiBC,KAAKrF,YAC/DF,MAAMO,UAAUiF,GAAGC,YAAYC,aAAcxF,KAAKyF,oBAAoBJ,KAAKrF,YAC3EF,MAAMO,UAAUiF,GAAGC,YAAYG,QAAQ,UACnCC,qBACAC,oDASaC,UAClB7F,KAAK8F,eAAiB9F,KAAK+F,WAG3BF,MAAMG,sBACH,GAAIhG,KAAKiG,UAAW,CAIvBJ,MAAMG,2BAGI,yCACI,kBAAU,gBAAiB9C,yBAC3B,kBAAU,eAAgBA,yBAC1B,kBAAU,cAAeA,yBAE9BpD,MAAMoF,OACb,MAAOlC,UAWjBoC,iBAAiBS,aACPK,OAASL,MAAMM,OAAOC,QAAQ,aAChCF,QAAUA,OAAOG,QAAQC,OAAQ,OAC3BA,OAASJ,OAAOG,QAAQC,OACf,cAAXA,aACKC,oCAGM,WAAXD,aACKE,kBAGM,gBAAXF,aACKG,uCAQjBF,oCACQvG,KAAK8F,eAAiB9F,KAAK+F,gBACtBH,4BAEAc,iBAObD,sCACQzG,KAAK8F,mBAEAa,cAAcC,QACZ5G,KAAK+F,iBAEPY,cAAcE,qCASlBC,KAAO,IAAIC,KAAK/G,KAAKgH,KAAKC,OAAQ,CACnClF,KAAM/B,KAAK2G,cAAcnE,gBAExB7B,OAAOkD,UAAY,UACnBlD,OAAOuG,IAAMC,IAAIC,gBAAgBpH,KAAK8G,WAGtCO,8BAA8B,oBAG9B3C,2BAA0B,QAC1BC,gBAAe,QACfF,sBAAqB,QAGrBD,0BAAyB,GACG,aAA7BxE,KAAK2G,cAAc/B,YACd0C,6BAA6B,oCASN,IAA5BtH,KAAKgH,KAAKC,OAAO1E,wBACZyC,aAAa,0BAIhBuC,SAAWvH,KAAKqB,aAA6B,IAAhBmG,KAAKC,UAAiBC,WAAWzF,QAAQ,IAAK,cAKxEkC,2BAA0B,QAG1BM,sBAAqB,SAGpBkD,cAAgB,qBAAW3H,KAAKH,OAAQ,QAASG,KAAK8G,KAAMS,UAAWK,gBACpEC,4BAA4BD,kBAEhCE,YAAYH,cACZ1C,6BACU,kBAAU,oBAAqB/B,oBAChD,MAAOF,YAEAyB,sBAAqB,wBAEX,kBAAU,eAAgBvB,kBAAW,CAACF,MAAAA,QAAS,CAC1DjB,KAAM,WAYlBsC,mBAAmB0D,gBACR/H,KAAKI,UAAUG,uCAAgCwH,6DAS/C/H,KAAKgI,eAAiBhI,KAAKiI,oCAGjBpI,cACXqI,WAAalI,KAAKmI,gBAClBrI,YAAcoI,WAAW1E,OAAO,CAClC4E,gBAAiB,CACbC,kBAAkB,6BAAiBxI,SAEvCyI,OAAO,EACP5E,eAAe,WAIF,IAAI1D,KAAKH,OAAQC,OACrBkB,WACTlB,MAAM6D,OAEH7D,MAQXG,+CACSD,KAAKJ,YAAYoI,gBAOjBhI,KAAKJ,YAAYqI,mCACP,CAAC,iBAAkB,YAAYM,KAAKC,OAAUA,IAAAA,IAAKtF,UAAAA,uBACzDuF,MAAKC,YAAEvF,MAAOwF,sBAAa,cAASA,QAAS,CAACxF,MAAAA,MAAOpB,KAAM,aAC3D6G,SACE,wBAVI,CAAC,sBAAuB,iBAAiBL,KAAKC,OAAUA,IAAAA,IAAKtF,UAAAA,uBACnEuF,MAAKI,WAAE1F,MAAOwF,qBAAa,cAASA,QAAS,CAACxF,MAAAA,MAAOpB,KAAM,aAC3D6G,SACE,gCAmBHhG,UAAUC,cAAgBV,OAAOC,0CAelCD,OAAO2G,qDAORC,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,+BAAgClJ,KAAKmJ,oBACzFF,UAAUG,oBAAoBpJ,KAAKM,gBAAiByI,KAAMC,SACrDK,mBAMTC,+BACUC,UAACA,UAADC,QAAYA,QAAZC,QAAqBA,SAAWzJ,KAAKmJ,mBACvCI,UAAY,OACP3D,6BAEAtF,gBAAgBC,cAAc,yBAAyBmJ,YAAcF,aACrElJ,gBAAgBC,cAAc,yBAAyBmJ,YAAcD,6CAS9CE,aAC3BrJ,gBAAgBoJ,kBAAoB,kBAAUC,OAAQzG,sDAQ5ByG,QAC3B3J,KAAKS,yBACAA,kBAAkBiJ,kBAAoB,kBAAUC,OAAQzG,sDASnC0E,eACzBpH,aAAakJ,kBAAoB,kBAAU,YAAaxG,kBAAW,CACpE0E,SAAUJ,KAAKoC,MAAiB,IAAXhC,UAAkB,yCAKtCpH,aAAakJ,kBAAoB,kBAAU,SAAUxG,mBAM9D2G,mBACQ7J,KAAK8J,aACLC,cAAc/J,KAAK8J,kBAElBA,YAAc,UACdE,UAAY,UACZC,UAAY,KAMrBC,wBAESF,WAAY,IAAIG,MAAOC,UACxBpK,KAAK8J,aACLC,cAAc/J,KAAK8J,aAQ3BT,sBAC2B,OAAnBrJ,KAAKgK,UAAoB,OAEnBK,eAAgB,IAAIF,MAAOC,UAAYpK,KAAKgK,eAE7CC,WAAaI,mBACbL,UAAY,UAEhBF,YAAcQ,YAAYtK,KAAKsJ,uBAAuBjE,KAAKrF,MAAO,KAQ3EmJ,uBAEQoB,KAAM,IAAIJ,MAAOC,UACE,OAAnBpK,KAAKgK,YAELO,IAAMvK,KAAKgK,iBAETT,UAAY/B,KAAKgD,MAAMxK,KAAKyB,gBAAmB8I,IAAMvK,KAAKiK,WAAa,KAEvEQ,UAAY,IAAIC,KAAKC,aAAa/H,UAAUgI,SAAU,CAACC,qBAAsB,IAC7EpB,QAAUgB,UAAUK,OAAOvB,UAAY,UAEtC,CACHA,UAAAA,UACAC,QAHYiB,UAAUK,OAAOtD,KAAKgD,OAAOjB,UAAYE,SAAW,KAIhEA,QAAAA,SASRsB,0BACW/K,KAAKE,OAAO8K,WASvBpF,uBACQ5F,KAAK2G,eAA8C,aAA7B3G,KAAK2G,cAAc/B,YACpCqG,eAAgB,EACjBjL,KAAK+F,iBACAmF,qBAIJvF,gBAIbuF,eACQlL,KAAK+F,kBACAiE,UAAY,WAEhBrD,cAAcwE,YAGdxK,OAAOmD,OAAQ,EAQxB6B,gBACQ3F,KAAK2C,aACAA,OAAOyI,YACPlJ,QAAQmJ,OAA+B,UAArBA,MAAMC,aACxBC,SAASF,OAAUA,MAAMF,SAOtCK,qBAESC,sBAGA5B,mBAQT6B,qBACSzB,WAAY,IAAIE,MAAOC,WACxB,6BAAiBpK,KAAKH,UAAYG,KAAK+F,iBAClCvB,0BAAyB,QAE7BmH,yBAQTC,oBACS1B,wBACA5C,6BAA6B,UAQtCuE,oBACSxC,wBACA/B,6BAA6B,SAQtCwE,oBAAoBjG,UACZ7F,KAAK8F,eAAiB9F,KAAK+F,WAAY,OACjCgG,QAAU/L,KAAKgH,KAAKgF,SAAWnG,MAAMmB,KAAKiF,KAG5CF,SAAW/L,KAAK+K,yBACXG,oBACAgB,oCAGAlF,KAAKC,OAAOjF,KAAK6D,MAAMmB,WAGvBA,KAAKgF,SAAWD,QAEjB/L,KAAKiL,oBACAC,yEAOF,kBAAU,iBAAkBhI,mBAAY,CACnDC,YAAa,kBAAU,uBAAwBD,mBAC/CnB,KAAM,UASd+D,4CACyC,gDAAzBa,wEAAe/B,OAQ/BmB,0CACyC,8CAAzBY,0EAAe/B,OAQ/BqB,oDACajG,KAAKgH,6BAALmF,WAAWH,oCAOhBhM,KAAK2G,cAAe,KAEhB3G,KAAK8F,eAAiB9F,KAAK+F,kBACtBY,cAAcwE,OAGnBnL,KAAKiG,UAAW,WACajG,KAAKoM,sCAK7B1H,2BAA0B,QAC1BC,gBAAe,GACf3E,KAAK2C,OAAO0J,cACPrM,KAAKc,wBAId6F,cAAgB,UAIpBA,cAAgB,IAAIvE,cAAcpC,KAAK2C,OAAQ3C,KAAK2B,kCAEpDgF,cAAcxB,iBAAiB,gBAAiBnF,KAAK8L,oBAAoBzG,KAAKrF,YAC9E2G,cAAcxB,iBAAiB,OAAQnF,KAAKwL,cAAcnG,KAAKrF,YAC/D2G,cAAcxB,iBAAiB,QAASnF,KAAK0L,cAAcrG,KAAKrF,YAChE2G,cAAcxB,iBAAiB,QAASnF,KAAK4L,aAAavG,KAAKrF,YAC/D2G,cAAcxB,iBAAiB,SAAUnF,KAAK6L,aAAaxG,KAAKrF,YAEhEgH,KAAO,CACRC,OAAQ,GACR+E,SAAU,QAEThI,yBACAiH,eAAgB,OAGhBtE,cAAc2F,MAAM,qDAUf,yCACI,kBAAU,oBAAqBpJ,yBAC/B,kBAAU,mBAAoBA,yBAC9B,kBAAU,cAAeA,qBAE5B,EACT,aACS,qBASGqJ,cACRxD,KAACA,YAAcE,UAAUC,iBAC3BlJ,KAAK0B,uBACL1B,KAAKwM,wBAAwB,CACzBD,OAAAA,eAGH1M,OAAO4M,cAAc1D,MAS9ByD,wBAAwBpE,wBACbA"}
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js
index cdee95028bbc7..01505c3737aad 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js
@@ -1,4 +1,4 @@
-define("tiny_recordrtc/options",["exports","./common","editor_tiny/options"],(function(_exports,_common,_options){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.register=_exports.isVideoAllowed=_exports.isScreenAllowed=_exports.isAudioAllowed=_exports.getData=void 0;
+define("tiny_recordrtc/options",["exports","./common","editor_tiny/options"],(function(_exports,_common,_options){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.register=_exports.isVideoAllowed=_exports.isScreenAllowed=_exports.isPausingAllowed=_exports.isAudioAllowed=_exports.getData=void 0;
/**
* Options helper for Tiny Record RTC plugin.
*
@@ -6,6 +6,6 @@ define("tiny_recordrtc/options",["exports","./common","editor_tiny/options"],(fu
* @copyright 2022, Stevani Andolo
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-const dataName=(0,_options.getPluginOptionName)(_common.pluginName,"data"),videoAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"videoAllowed"),audioAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"audioAllowed"),screenAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"screenAllowed");_exports.register=editor=>{const registerOption=editor.options.register;registerOption(dataName,{processor:"object"}),registerOption(videoAllowedName,{processor:"boolean",default:!1}),registerOption(audioAllowedName,{processor:"boolean",default:!1}),registerOption(screenAllowedName,{processor:"boolean",default:!1})};_exports.getData=editor=>editor.options.get(dataName);_exports.isAudioAllowed=editor=>editor.options.get(audioAllowedName);_exports.isVideoAllowed=editor=>editor.options.get(videoAllowedName);_exports.isScreenAllowed=editor=>editor.options.get(screenAllowedName)}));
+const dataName=(0,_options.getPluginOptionName)(_common.pluginName,"data"),videoAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"videoAllowed"),audioAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"audioAllowed"),screenAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"screenAllowed"),pausingAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"pausingAllowed");_exports.register=editor=>{const registerOption=editor.options.register;registerOption(dataName,{processor:"object"}),registerOption(videoAllowedName,{processor:"boolean",default:!1}),registerOption(audioAllowedName,{processor:"boolean",default:!1}),registerOption(screenAllowedName,{processor:"boolean",default:!1}),registerOption(pausingAllowedName,{processor:"boolean",default:!1})};_exports.getData=editor=>editor.options.get(dataName);_exports.isAudioAllowed=editor=>editor.options.get(audioAllowedName);_exports.isVideoAllowed=editor=>editor.options.get(videoAllowedName);_exports.isScreenAllowed=editor=>editor.options.get(screenAllowedName);_exports.isPausingAllowed=editor=>editor.options.get(pausingAllowedName)}));
//# sourceMappingURL=options.min.js.map
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map
index 2ec39ef318450..b720b51ccbc2c 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map
@@ -1 +1 @@
-{"version":3,"file":"options.min.js","sources":["../src/options.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {pluginName} from './common';\nimport {getPluginOptionName} from 'editor_tiny/options';\n\nconst dataName = getPluginOptionName(pluginName, 'data');\nconst videoAllowedName = getPluginOptionName(pluginName, 'videoAllowed');\nconst audioAllowedName = getPluginOptionName(pluginName, 'audioAllowed');\nconst screenAllowedName = getPluginOptionName(pluginName, 'screenAllowed');\n\nexport const register = (editor) => {\n const registerOption = editor.options.register;\n\n registerOption(dataName, {\n processor: 'object',\n });\n\n registerOption(videoAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(audioAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(screenAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n};\n\nexport const getData = (editor) => editor.options.get(dataName);\n\n/**\n * Whether video may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isAudioAllowed = (editor) => editor.options.get(audioAllowedName);\n\n/**\n * Whether audio may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isVideoAllowed = (editor) => editor.options.get(videoAllowedName);\n\n/**\n * Whether screen may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isScreenAllowed = (editor) => editor.options.get(screenAllowedName);\n"],"names":["dataName","pluginName","videoAllowedName","audioAllowedName","screenAllowedName","editor","registerOption","options","register","processor","get"],"mappings":";;;;;;;;MA0BMA,UAAW,gCAAoBC,mBAAY,QAC3CC,kBAAmB,gCAAoBD,mBAAY,gBACnDE,kBAAmB,gCAAoBF,mBAAY,gBACnDG,mBAAoB,gCAAoBH,mBAAY,mCAEjCI,eACfC,eAAiBD,OAAOE,QAAQC,SAEtCF,eAAeN,SAAU,CACrBS,UAAW,WAGfH,eAAeJ,iBAAkB,CAC7BO,UAAW,mBACA,IAGfH,eAAeH,iBAAkB,CAC7BM,UAAW,mBACA,IAGfH,eAAeF,kBAAmB,CAC9BK,UAAW,mBACA,sBAIKJ,QAAWA,OAAOE,QAAQG,IAAIV,kCAQvBK,QAAWA,OAAOE,QAAQG,IAAIP,0CAQ9BE,QAAWA,OAAOE,QAAQG,IAAIR,2CAQ7BG,QAAWA,OAAOE,QAAQG,IAAIN"}
\ No newline at end of file
+{"version":3,"file":"options.min.js","sources":["../src/options.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {pluginName} from './common';\nimport {getPluginOptionName} from 'editor_tiny/options';\n\nconst dataName = getPluginOptionName(pluginName, 'data');\nconst videoAllowedName = getPluginOptionName(pluginName, 'videoAllowed');\nconst audioAllowedName = getPluginOptionName(pluginName, 'audioAllowed');\nconst screenAllowedName = getPluginOptionName(pluginName, 'screenAllowed');\nconst pausingAllowedName = getPluginOptionName(pluginName, 'pausingAllowed');\n\nexport const register = (editor) => {\n const registerOption = editor.options.register;\n\n registerOption(dataName, {\n processor: 'object',\n });\n\n registerOption(videoAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(audioAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(screenAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(pausingAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n};\n\nexport const getData = (editor) => editor.options.get(dataName);\n\n/**\n * Whether video may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isAudioAllowed = (editor) => editor.options.get(audioAllowedName);\n\n/**\n * Whether audio may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isVideoAllowed = (editor) => editor.options.get(videoAllowedName);\n\n/**\n * Whether screen may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isScreenAllowed = (editor) => editor.options.get(screenAllowedName);\n\n/**\n * Whether pausing is allowed in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isPausingAllowed = (editor) => editor.options.get(pausingAllowedName);\n"],"names":["dataName","pluginName","videoAllowedName","audioAllowedName","screenAllowedName","pausingAllowedName","editor","registerOption","options","register","processor","get"],"mappings":";;;;;;;;MA0BMA,UAAW,gCAAoBC,mBAAY,QAC3CC,kBAAmB,gCAAoBD,mBAAY,gBACnDE,kBAAmB,gCAAoBF,mBAAY,gBACnDG,mBAAoB,gCAAoBH,mBAAY,iBACpDI,oBAAqB,gCAAoBJ,mBAAY,oCAElCK,eACfC,eAAiBD,OAAOE,QAAQC,SAEtCF,eAAeP,SAAU,CACrBU,UAAW,WAGfH,eAAeL,iBAAkB,CAC7BQ,UAAW,mBACA,IAGfH,eAAeJ,iBAAkB,CAC7BO,UAAW,mBACA,IAGfH,eAAeH,kBAAmB,CAC9BM,UAAW,mBACA,IAGfH,eAAeF,mBAAoB,CAC/BK,UAAW,mBACA,sBAIKJ,QAAWA,OAAOE,QAAQG,IAAIX,kCAQvBM,QAAWA,OAAOE,QAAQG,IAAIR,0CAQ9BG,QAAWA,OAAOE,QAAQG,IAAIT,2CAQ7BI,QAAWA,OAAOE,QAAQG,IAAIP,6CAQ7BE,QAAWA,OAAOE,QAAQG,IAAIN"}
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js
index 216450ff110ff..d1f7dbf134bf6 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js
@@ -1,3 +1,3 @@
-define("tiny_recordrtc/screen_recorder",["exports","./base_recorder","tiny_recordrtc/modal","tiny_recordrtc/common","core/str"],(function(_exports,_base_recorder,_modal,_common,_str){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_base_recorder=_interopRequireDefault(_base_recorder),_modal=_interopRequireDefault(_modal);class Screen extends _base_recorder.default{configurePlayer(){return this.modalRoot.querySelector("video")}getSupportedTypes(){return["video/webm;codecs=vp9,opus","video/webm;codecs=vp8,opus","video/mp4;codecs=h264,opus","video/mp4;codecs=h264,wav","video/mp4;codecs=v9,opus"]}getRecordingOptions(){return{videoBitsPerSecond:parseInt(this.config.screenbitrate),videoWidth:parseInt(this.config.videoscreenwidth),videoHeight:parseInt(this.config.videoscreenheight)}}getMediaConstraints(){return{audio:!0,systemAudio:"exclude",video:{displaySurface:"monitor",frameRate:{ideal:24},width:{max:parseInt(this.config.videoscreenwidth)},height:{max:parseInt(this.config.videoscreenheight)}}}}playOnCapture(){return!0}getRecordingType(){return"screen"}getTimeLimit(){return this.config.screentimelimit}getEmbedTemplateName(){return"tiny_recordrtc/embed_screen"}getFileName(prefix){return"".concat(prefix,"-video.").concat(this.getFileExtension())}getFileExtension(){return window.MediaRecorder.isTypeSupported("audio/webm")?"webm":window.MediaRecorder.isTypeSupported("audio/mp4")?"mp4":(window.console.warn("Unknown file type for MediaRecorder API"),"")}async captureUserMedia(){const audioPromise=navigator.mediaDevices.getUserMedia({audio:!0}),screenPromise=navigator.mediaDevices.getDisplayMedia(this.getMediaConstraints());await Promise.allSettled([audioPromise,screenPromise]).then(this.combineAudioAndScreenRecording.bind(this))}combineAudioAndScreenRecording(results){const[audioData,screenData]=results;if("fulfilled"!==screenData.status)return void this.handleCaptureFailure(screenData.reason);const screenStream=screenData.value;if(screenStream.getVideoTracks()[0].addEventListener("ended",this.handleStopScreenSharing.bind(this)),"fulfilled"!==audioData.status)return void this.handleCaptureSuccess(screenStream);const audioStream=audioData.value,composedStream=new MediaStream;screenStream.getTracks().forEach((function(track){"video"===track.kind?composedStream.addTrack(track):track.stop()})),audioStream.getAudioTracks().forEach((function(micTrack){composedStream.addTrack(micTrack)})),this.handleCaptureSuccess(composedStream)}handleStopScreenSharing(){this.isRecording()?(this.requestRecordingStop(),this.cleanupStream()):(this.setRecordButtonState(!1),this.displayAlert((0,_str.getString)("screensharingstopped_title",_common.component),(0,_str.getString)("screensharingstopped",_common.component)))}handleRecordingStartStopRequested(){this.isRecording()?(this.requestRecordingStop(),this.cleanupStream()):this.startRecording()}static getModalClass(){var _class;return _defineProperty(_class=class extends _modal.default{},"TYPE","".concat(_common.component,"/screen_recorder")),_defineProperty(_class,"TEMPLATE","".concat(_common.component,"/screen_recorder")),_class}}return _exports.default=Screen,_exports.default}));
+define("tiny_recordrtc/screen_recorder",["exports","./base_recorder","tiny_recordrtc/modal","tiny_recordrtc/common","core/str"],(function(_exports,_base_recorder,_modal,_common,_str){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_base_recorder=_interopRequireDefault(_base_recorder),_modal=_interopRequireDefault(_modal);class Screen extends _base_recorder.default{configurePlayer(){return this.modalRoot.querySelector("video")}getSupportedTypes(){return["video/webm;codecs=vp9,opus","video/webm;codecs=vp8,opus","video/mp4;codecs=h264,opus","video/mp4;codecs=h264,wav","video/mp4;codecs=v9,opus"]}getRecordingOptions(){return{videoBitsPerSecond:parseInt(this.config.screenbitrate),videoWidth:parseInt(this.config.videoscreenwidth),videoHeight:parseInt(this.config.videoscreenheight)}}getMediaConstraints(){return{audio:!0,systemAudio:"exclude",video:{displaySurface:"monitor",frameRate:{ideal:24},width:{max:parseInt(this.config.videoscreenwidth)},height:{max:parseInt(this.config.videoscreenheight)}}}}playOnCapture(){return!0}getRecordingType(){return"screen"}getTimeLimit(){return this.config.screentimelimit}getEmbedTemplateName(){return"tiny_recordrtc/embed_screen"}getFileName(prefix){return"".concat(prefix,"-video.").concat(this.getFileExtension())}getFileExtension(){return window.MediaRecorder.isTypeSupported("audio/webm")?"webm":window.MediaRecorder.isTypeSupported("audio/mp4")?"mp4":(window.console.warn("Unknown file type for MediaRecorder API"),"")}async captureUserMedia(){const audioPromise=navigator.mediaDevices.getUserMedia({audio:!0}),screenPromise=navigator.mediaDevices.getDisplayMedia(this.getMediaConstraints());await Promise.allSettled([audioPromise,screenPromise]).then(this.combineAudioAndScreenRecording.bind(this))}combineAudioAndScreenRecording(results){const[audioData,screenData]=results;if("fulfilled"!==screenData.status)return void this.handleCaptureFailure(screenData.reason);const screenStream=screenData.value;if(screenStream.getVideoTracks()[0].addEventListener("ended",this.handleStopScreenSharing.bind(this)),"fulfilled"!==audioData.status)return void this.handleCaptureSuccess(screenStream);const audioStream=audioData.value,composedStream=new MediaStream;screenStream.getTracks().forEach((function(track){"video"===track.kind?composedStream.addTrack(track):track.stop()})),audioStream.getAudioTracks().forEach((function(micTrack){composedStream.addTrack(micTrack)})),this.handleCaptureSuccess(composedStream)}handleStopScreenSharing(){this.isRecording()||this.isPaused()?(this.requestRecordingStop(),this.cleanupStream()):(this.setRecordButtonState(!1),this.displayAlert((0,_str.getString)("screensharingstopped_title",_common.component),(0,_str.getString)("screensharingstopped",_common.component)))}handleRecordingStartStopRequested(){this.isRecording()||this.isPaused()?(this.requestRecordingStop(),this.cleanupStream()):this.startRecording()}static getModalClass(){var _class;return _defineProperty(_class=class extends _modal.default{},"TYPE","".concat(_common.component,"/screen_recorder")),_defineProperty(_class,"TEMPLATE","".concat(_common.component,"/screen_recorder")),_class}}return _exports.default=Screen,_exports.default}));
//# sourceMappingURL=screen_recorder.min.js.map
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map
index 2f4db9eacb3d6..22804ddc6847e 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map
@@ -1 +1 @@
-{"version":3,"file":"screen_recorder.min.js","sources":["../src/screen_recorder.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see
-
+
+ {{#isallowedpausing}}
+
+ {{/isallowedpausing}}
diff --git a/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache b/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache
index dadd10ab72e83..fd340292987cb 100644
--- a/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache
+++ b/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache
@@ -21,6 +21,7 @@
Example context (json):
{
+ "isallowedpausing": true
}
}}
{{< core/modal }}
@@ -47,10 +48,15 @@
-
+
+ {{#isallowedpausing}}
+
+ {{/isallowedpausing}}
diff --git a/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache b/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache
index 0c80b8e1ef4f2..2e2b00b9b297d 100644
--- a/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache
+++ b/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache
@@ -21,6 +21,7 @@
Example context (json):
{
+ "isallowedpausing": true
}
}}
{{!
@@ -53,10 +54,15 @@
-
+
+ {{#isallowedpausing}}
+
+ {{/isallowedpausing}}
diff --git a/lib/editor/tiny/plugins/recordrtc/version.php b/lib/editor/tiny/plugins/recordrtc/version.php
index 10d0922a14d16..e83c9049480a3 100644
--- a/lib/editor/tiny/plugins/recordrtc/version.php
+++ b/lib/editor/tiny/plugins/recordrtc/version.php
@@ -24,6 +24,6 @@
defined('MOODLE_INTERNAL') || die();
-$plugin->version = 2024042400;
+$plugin->version = 2024053100;
$plugin->requires = 2024041600;
$plugin->component = 'tiny_recordrtc';
diff --git a/lib/editor/tiny/tests/behat/manage_subplugins.feature b/lib/editor/tiny/tests/behat/manage_subplugins.feature
index 6b0e0c030b93e..09448a88fa7fa 100644
--- a/lib/editor/tiny/tests/behat/manage_subplugins.feature
+++ b/lib/editor/tiny/tests/behat/manage_subplugins.feature
@@ -8,23 +8,11 @@ Feature: An administrator can manage TinyMCE subplugins
Scenario: An administrator can control the enabled state of TinyMCE subplugins using JavaScript
Given I am logged in as "admin"
And I navigate to "Plugins > Text editors > TinyMCE editor > General settings" in site administration
- When I click on "Disable Equation editor" "link"
- Then I should see "Equation editor disabled."
- And "Disable Equation editor" "link" should not exist
- But "Enable Equation editor" "link" should exist
- When I click on "Enable Equation editor" "link"
- Then I should see "Equation editor enabled."
- And "Enable Equation editor" "link" should not exist
- But "Disable Equation editor" "link" should exist
-
- Scenario: An administrator can control the enabled state of TinyMCE subplugins without JavaScript
- Given I am logged in as "admin"
- And I navigate to "Plugins > Text editors > TinyMCE editor > General settings" in site administration
- When I click on "Disable Equation editor" "link"
- Then I should see "Equation editor disabled."
- And "Disable Equation editor" "link" should not exist
- But "Enable Equation editor" "link" should exist
- When I click on "Enable Equation editor" "link"
- Then I should see "Equation editor enabled."
- And "Enable Equation editor" "link" should not exist
- But "Disable Equation editor" "link" should exist
+ When I toggle the "Disable Equation editor" admin switch "off"
+ And I should see "Equation editor disabled."
+ And I reload the page
+ Then I should see "Enable Equation editor"
+ And I toggle the "Enable Equation editor" admin switch "on"
+ And I should see "Equation editor enabled."
+ And I reload the page
+ Then I should see "Disable Equation editor"
diff --git a/lib/external/tests/external_api_test.php b/lib/external/tests/external_api_test.php
index f806785b77971..49bbedae95a5d 100644
--- a/lib/external/tests/external_api_test.php
+++ b/lib/external/tests/external_api_test.php
@@ -332,7 +332,7 @@ public function test_get_context_from_params(): void {
/**
* Test \core_external\external_api::get_context()_from_params parameter validation.
*
- * @covers \core_external\external_api::get_context
+ * @covers \core_external\external_api::get_context_from_params
*/
public function test_get_context_params(): void {
global $USER;
@@ -345,7 +345,7 @@ public function test_get_context_params(): void {
/**
* Test \core_external\external_api::get_context()_from_params parameter validation.
*
- * @covers \core_external\external_api::get_context
+ * @covers \core_external\external_api::get_context_from_params
*/
public function test_get_context_params2(): void {
global $USER;
@@ -357,7 +357,7 @@ public function test_get_context_params2(): void {
/**
* Test \core_external\external_api::get_context()_from_params parameter validation.
- * @covers \core_external\external_api::get_context
+ * @covers \core_external\external_api::get_context_from_params
*/
public function test_get_context_params3(): void {
global $USER;
diff --git a/lib/filestorage/tests/stored_file_test.php b/lib/filestorage/tests/stored_file_test.php
index bd07c47c2834a..76d1606a5f364 100644
--- a/lib/filestorage/tests/stored_file_test.php
+++ b/lib/filestorage/tests/stored_file_test.php
@@ -33,7 +33,6 @@ class stored_file_test extends advanced_testcase {
/**
* Test that the rotate_image() method does not rotate
* an image that is not supposed to be rotated.
- * @covers ::rotate_image()
*/
public function test_rotate_image_does_not_rotate_image(): void {
global $CFG;
@@ -62,7 +61,6 @@ public function test_rotate_image_does_not_rotate_image(): void {
/**
* Test that the rotate_image() method rotates an image
* that is supposed to be rotated.
- * @covers ::rotate_image()
*/
public function test_rotate_image_rotates_image(): void {
global $CFG;
@@ -94,8 +92,6 @@ public function test_rotate_image_rotates_image(): void {
/**
* Ensure that get_content_file_handle returns a valid file handle.
- *
- * @covers ::get_psr_stream
*/
public function test_get_psr_stream(): void {
global $CFG;
diff --git a/lib/form/button.php b/lib/form/button.php
index fdbb4ffe1ea75..b5a44aab17db6 100644
--- a/lib/form/button.php
+++ b/lib/form/button.php
@@ -26,7 +26,6 @@
*/
require_once("HTML/QuickForm/button.php");
-require_once(__DIR__ . '/../outputcomponents.php');
require_once('templatable_form_element.php');
/**
diff --git a/lib/form/templatable_form_element.php b/lib/form/templatable_form_element.php
index 07fb98e2d7f96..e94e5baf5bc2d 100644
--- a/lib/form/templatable_form_element.php
+++ b/lib/form/templatable_form_element.php
@@ -21,18 +21,6 @@
* @copyright 2016 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-defined('MOODLE_INTERNAL') || die();
-
-// Some form elements are used before $CFG is created - do not rely on it here.
-require_once(__DIR__ . '/../outputcomponents.php');
-
-/**
- * templatable_form_element trait.
- *
- * @package core_form
- * @copyright 2016 Damyon Wiese
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
trait templatable_form_element {
/**
diff --git a/lib/installlib.php b/lib/installlib.php
index 8e9c5af1ec8c9..416c7e8b8ea49 100644
--- a/lib/installlib.php
+++ b/lib/installlib.php
@@ -162,7 +162,7 @@ function install_helpbutton($url, $title='') {
echo "";
- echo "![\"$title\"](\"pix/help.gif\" "\\"$title\\"/")
";
+ echo "";
echo "\n";
}
diff --git a/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php b/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
index 97b73d21c7aa1..0544004355b55 100644
--- a/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
+++ b/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
@@ -508,8 +508,7 @@ public function getCode()
break;
case 'id_name':
switch ($token[0]) {
- // named arguments...
- case ':':
+ case $token[0] === ':' && $context !== 'instanceof':
if ($lastState === 'closure' && $context === 'root') {
$state = 'closure';
$code .= $id_start.$token;
diff --git a/lib/minify/matthiasmullie-minify/src/CSS.php b/lib/minify/matthiasmullie-minify/src/CSS.php
index 09cedeee3a064..4f56320c47459 100644
--- a/lib/minify/matthiasmullie-minify/src/CSS.php
+++ b/lib/minify/matthiasmullie-minify/src/CSS.php
@@ -106,8 +106,8 @@ protected function moveImportsToTop($content)
/**
* Combine CSS from import statements.
*
- * Import statements will be loaded and their content merged into the original
- * file, to save HTTP requests.
+ * \@import's will be loaded and their content merged into the original file,
+ * to save HTTP requests.
*
* @param string $source The file to combine imports for
* @param string $content The CSS content to combine imports for
@@ -316,7 +316,9 @@ public function execute($path = null, $parents = array())
$css = $this->replace($css);
$css = $this->stripWhitespace($css);
- $css = $this->shortenColors($css);
+ $css = $this->convertLegacyColors($css);
+ $css = $this->cleanupModernColors($css);
+ $css = $this->shortenHEXColors($css);
$css = $this->shortenZeroes($css);
$css = $this->shortenFontWeights($css);
$css = $this->stripEmptyTags($css);
@@ -480,64 +482,153 @@ protected function move(ConverterInterface $converter, $content)
}
/**
- * Shorthand hex color codes.
- * #FF0000 -> #F00.
+ * Shorthand HEX color codes.
+ * #FF0000FF -> #f00 -> red
+ * #FF00FF00 -> transparent.
*
- * @param string $content The CSS content to shorten the hex color codes for
+ * @param string $content The CSS content to shorten the HEX color codes for
*
* @return string
*/
- protected function shortenColors($content)
+ protected function shortenHexColors($content)
{
- $content = preg_replace('/(?<=[: ])#([0-9a-z])\\1([0-9a-z])\\2([0-9a-z])\\3(?:([0-9a-z])\\4)?(?=[; }])/i', '#$1$2$3$4', $content);
+ // shorten repeating patterns within HEX ..
+ $content = preg_replace('/(?<=[: ])#([0-9a-f])\\1([0-9a-f])\\2([0-9a-f])\\3(?:([0-9a-f])\\4)?(?=[; }])/i', '#$1$2$3$4', $content);
- // remove alpha channel if it's pointless...
- $content = preg_replace('/(?<=[: ])#([0-9a-z]{6})ff?(?=[; }])/i', '#$1', $content);
- $content = preg_replace('/(?<=[: ])#([0-9a-z]{3})f?(?=[; }])/i', '#$1', $content);
+ // remove alpha channel if it's pointless ..
+ $content = preg_replace('/(?<=[: ])#([0-9a-f]{6})ff(?=[; }])/i', '#$1', $content);
+ $content = preg_replace('/(?<=[: ])#([0-9a-f]{3})f(?=[; }])/i', '#$1', $content);
+
+ // replace `transparent` with shortcut ..
+ $content = preg_replace('/(?<=[: ])#[0-9a-f]{6}00(?=[; }])/i', '#fff0', $content);
$colors = array(
+ // make these more readable
+ '#00f' => 'blue',
+ '#dc143c' => 'crimson',
+ '#0ff' => 'cyan',
+ '#8b0000' => 'darkred',
+ '#696969' => 'dimgray',
+ '#ff69b4' => 'hotpink',
+ '#0f0' => 'lime',
+ '#fdf5e6' => 'oldlace',
+ '#87ceeb' => 'skyblue',
+ '#d8bfd8' => 'thistle',
// we can shorten some even more by replacing them with their color name
- '#F0FFFF' => 'azure',
- '#F5F5DC' => 'beige',
- '#A52A2A' => 'brown',
- '#FF7F50' => 'coral',
- '#FFD700' => 'gold',
+ '#f0ffff' => 'azure',
+ '#f5f5dc' => 'beige',
+ '#ffe4c4' => 'bisque',
+ '#a52a2a' => 'brown',
+ '#ff7f50' => 'coral',
+ '#ffd700' => 'gold',
'#808080' => 'gray',
'#008000' => 'green',
- '#4B0082' => 'indigo',
- '#FFFFF0' => 'ivory',
- '#F0E68C' => 'khaki',
- '#FAF0E6' => 'linen',
+ '#4b0082' => 'indigo',
+ '#fffff0' => 'ivory',
+ '#f0e68c' => 'khaki',
+ '#faf0e6' => 'linen',
'#800000' => 'maroon',
'#000080' => 'navy',
'#808000' => 'olive',
- '#CD853F' => 'peru',
- '#FFC0CB' => 'pink',
- '#DDA0DD' => 'plum',
+ '#ffa500' => 'orange',
+ '#da70d6' => 'orchid',
+ '#cd853f' => 'peru',
+ '#ffc0cb' => 'pink',
+ '#dda0dd' => 'plum',
'#800080' => 'purple',
- '#F00' => 'red',
- '#FA8072' => 'salmon',
- '#A0522D' => 'sienna',
- '#C0C0C0' => 'silver',
- '#FFFAFA' => 'snow',
- '#D2B48C' => 'tan',
- '#FF6347' => 'tomato',
- '#EE82EE' => 'violet',
- '#F5DEB3' => 'wheat',
+ '#f00' => 'red',
+ '#fa8072' => 'salmon',
+ '#a0522d' => 'sienna',
+ '#c0c0c0' => 'silver',
+ '#fffafa' => 'snow',
+ '#d2b48c' => 'tan',
+ '#008080' => 'teal',
+ '#ff6347' => 'tomato',
+ '#ee82ee' => 'violet',
+ '#f5deb3' => 'wheat',
// or the other way around
- 'WHITE' => '#fff',
- 'BLACK' => '#000',
+ 'black' => '#000',
+ 'fuchsia' => '#f0f',
+ 'magenta' => '#f0f',
+ 'white' => '#fff',
+ 'yellow' => '#ff0',
+ // and also `transparent`
+ 'transparent' => '#fff0',
);
return preg_replace_callback(
'/(?<=[: ])(' . implode('|', array_keys($colors)) . ')(?=[; }])/i',
function ($match) use ($colors) {
- return $colors[strtoupper($match[0])];
+ return $colors[strtolower($match[0])];
+ },
+ $content
+ );
+ }
+
+ /**
+ * Convert RGB|HSL color codes.
+ * rgb(255,0,0,.5) -> rgb(255 0 0 / .5).
+ * rgb(255,0,0) -> #f00.
+ *
+ * @param string $content The CSS content to shorten the RGB color codes for
+ *
+ * @return string
+ */
+ protected function convertLegacyColors($content)
+ {
+ /*
+ https://drafts.csswg.org/css-color/#color-syntax-legacy
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl
+ */
+
+ // convert legacy color syntax
+ $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content);
+ $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*\)/i', '$1($2 $3 $4)', $content);
+ $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content);
+ $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*\)/i', '$1($2 $3 $4)', $content);
+
+ // convert `rgb` to `hex`
+ $dec = '([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])';
+ return preg_replace_callback(
+ "/rgb\($dec $dec $dec\)/i",
+ function ($match) {
+ return sprintf('#%02x%02x%02x', $match[1], $match[2], $match[3]);
},
$content
);
}
+ /**
+ * Cleanup RGB|HSL|HWB|LCH|LAB
+ * rgb(255 0 0 / 1) -> rgb(255 0 0).
+ * rgb(255 0 0 / 0) -> transparent.
+ *
+ * @param string $content The CSS content to cleanup HSL|HWB|LCH|LAB
+ *
+ * @return string
+ */
+ protected function cleanupModernColors($content)
+ {
+ /*
+ https://drafts.csswg.org/css-color/#color-syntax-modern
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hwb
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lch
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lab
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklab
+ */
+ $tag = '(rgb|hsl|hwb|(?:(?:ok)?(?:lch|lab)))';
+
+ // remove alpha channel if it's pointless ..
+ $content = preg_replace('/' . $tag . '\(\s*([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+\/\s+1(?:(?:\.\d?)*|00%)?\s*\)/i', '$1($2 $3 $4)', $content);
+
+ // replace `transparent` with shortcut ..
+ $content = preg_replace('/' . $tag . '\(\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+\/\s+0(?:[\.0%]*)?\s*\)/i', '#fff0', $content);
+
+ return $content;
+ }
+
/**
* Shorten CSS font weights.
*
diff --git a/lib/minify/matthiasmullie-minify/src/JS.php b/lib/minify/matthiasmullie-minify/src/JS.php
index d592b08bb33f5..9cf43a2e742a3 100644
--- a/lib/minify/matthiasmullie-minify/src/JS.php
+++ b/lib/minify/matthiasmullie-minify/src/JS.php
@@ -122,9 +122,6 @@ class JS extends Minify
*/
protected $operatorsAfter = array();
- /**
- * {@inheritdoc}
- */
public function __construct()
{
call_user_func_array(array('\\MatthiasMullie\Minify\\Minify', '__construct'), func_get_args());
diff --git a/lib/minify/matthiasmullie-minify/src/Minify.php b/lib/minify/matthiasmullie-minify/src/Minify.php
index f77478bebb71f..29e6eb8c00af5 100644
--- a/lib/minify/matthiasmullie-minify/src/Minify.php
+++ b/lib/minify/matthiasmullie-minify/src/Minify.php
@@ -270,7 +270,7 @@ protected function stripMultilineComments()
$minifier = $this;
$callback = function ($match) use ($minifier) {
$count = count($minifier->extracted);
- $placeholder = '/*'.$count.'*/';
+ $placeholder = '/*' . $count . '*/';
$minifier->extracted[$placeholder] = $match[0];
return $placeholder;
@@ -494,14 +494,20 @@ protected function canImportFile($path)
$parsed = parse_url($path);
if (
// file is elsewhere
- isset($parsed['host']) ||
+ isset($parsed['host'])
// file responds to queries (may change, or need to bypass cache)
- isset($parsed['query'])
+ || isset($parsed['query'])
) {
return false;
}
- return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path);
+ try {
+ return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path);
+ }
+ // catch openbasedir exceptions which are not caught by @ on is_file()
+ catch (\Exception $e) {
+ return false;
+ }
}
/**
@@ -534,9 +540,9 @@ protected function openFileForWriting($path)
protected function writeToFile($handler, $content, $path = '')
{
if (
- !is_resource($handler) ||
- ($result = @fwrite($handler, $content)) === false ||
- ($result < strlen($content))
+ !is_resource($handler)
+ || ($result = @fwrite($handler, $content)) === false
+ || ($result < strlen($content))
) {
throw new IOException('The file "' . $path . '" could not be written to. Check your disk space and file permissions.');
}
diff --git a/lib/modinfolib.php b/lib/modinfolib.php
index 06ed6cc8ddc65..5c6899cf94d7b 100644
--- a/lib/modinfolib.php
+++ b/lib/modinfolib.php
@@ -93,6 +93,12 @@ class course_modinfo {
*/
private $delegatedsections;
+ /**
+ * Index of sections delegated by course modules, indexed by course module instance.
+ * @var null|section_info[]
+ */
+ private ?array $delegatedbycm = null;
+
/**
* User ID
* @var int
@@ -139,6 +145,7 @@ class course_modinfo {
'cms' => 'get_cms',
'instances' => 'get_instances',
'groups' => 'get_groups_all',
+ 'delegatedbycm' => 'get_sections_delegated_by_cm',
);
/**
@@ -410,6 +417,33 @@ public function has_delegated_sections(): bool {
return !empty($this->delegatedsections);
}
+ /**
+ * Gets data about section delegated by course modules.
+ *
+ * @return section_info[] sections array indexed by course module ID
+ */
+ public function get_sections_delegated_by_cm(): array {
+ if (!is_null($this->delegatedbycm)) {
+ return $this->delegatedbycm;
+ }
+ $this->delegatedbycm = [];
+ foreach ($this->delegatedsections as $componentsections) {
+ foreach ($componentsections as $section) {
+ $delegateinstance = $section->get_component_instance();
+ // We only return sections delegated by course modules. Sections delegated to other
+ // types of components must implement their own methods to get the section.
+ if (!$delegateinstance || !($delegateinstance instanceof \core_courseformat\sectiondelegatemodule)) {
+ continue;
+ }
+ if (!$cm = $delegateinstance->get_cm()) {
+ continue;
+ }
+ $this->delegatedbycm[$cm->id] = $section;
+ }
+ }
+ return $this->delegatedbycm;
+ }
+
/**
* Static cache for generated course_modinfo instances
*
@@ -2171,6 +2205,19 @@ public function get_course_module_record($additionalfields = false) {
return $cmrecord;
}
+ /**
+ * Returns the section delegated by this module, if any.
+ *
+ * @return ?section_info
+ */
+ public function get_delegated_section_info(): ?section_info {
+ $delegatedsections = $this->modinfo->get_sections_delegated_by_cm();
+ if (!array_key_exists($this->id, $delegatedsections)) {
+ return null;
+ }
+ return $delegatedsections[$this->id];
+ }
+
// Set functions
////////////////
@@ -2602,10 +2649,13 @@ private function update_user_visible() {
$this->availableinfo = '';
}
+ $capabilities = [
+ 'moodle/course:manageactivities',
+ 'moodle/course:activityvisibility',
+ 'moodle/course:viewhiddenactivities',
+ ];
$this->uservisibleoncoursepage = $this->uservisible &&
- ($this->visibleoncoursepage ||
- has_capability('moodle/course:manageactivities', $this->get_context(), $userid) ||
- has_capability('moodle/course:activityvisibility', $this->get_context(), $userid));
+ ($this->visibleoncoursepage || has_any_capability($capabilities, $this->get_context(), $userid));
// Activity that is not available, not hidden from course page and has availability
// info is actually visible on the course page (with availability info and without a link).
if (!$this->uservisible && $this->visibleoncoursepage && $this->availableinfo) {
diff --git a/lib/moodlelib.php b/lib/moodlelib.php
index a68bb235f0fc6..c3c1f4471a4b4 100644
--- a/lib/moodlelib.php
+++ b/lib/moodlelib.php
@@ -7128,172 +7128,20 @@ function get_list_of_themes() {
}
/**
- * Factory function for emoticon_manager
+ * Factory function for {@see \core\emoticon_manager}
*
- * @return emoticon_manager singleton
+ * @return \core\emoticon_manager singleton
*/
-function get_emoticon_manager() {
+function get_emoticon_manager(): \core\emoticon_manager {
static $singleton = null;
if (is_null($singleton)) {
- $singleton = new emoticon_manager();
+ $singleton = new \core\emoticon_manager();
}
return $singleton;
}
-/**
- * Provides core support for plugins that have to deal with emoticons (like HTML editor or emoticon filter).
- *
- * Whenever this manager mentiones 'emoticon object', the following data
- * structure is expected: stdClass with properties text, imagename, imagecomponent,
- * altidentifier and altcomponent
- *
- * @see admin_setting_emoticons
- *
- * @copyright 2010 David Mudrak
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class emoticon_manager {
-
- /**
- * Returns the currently enabled emoticons
- *
- * @param boolean $selectable - If true, only return emoticons that should be selectable from a list.
- * @return array of emoticon objects
- */
- public function get_emoticons($selectable = false) {
- global $CFG;
- $notselectable = ['martin', 'egg'];
-
- if (empty($CFG->emoticons)) {
- return array();
- }
-
- $emoticons = $this->decode_stored_config($CFG->emoticons);
-
- if (!is_array($emoticons)) {
- // Something is wrong with the format of stored setting.
- debugging('Invalid format of emoticons setting, please resave the emoticons settings form', DEBUG_NORMAL);
- return array();
- }
- if ($selectable) {
- foreach ($emoticons as $index => $emote) {
- if (in_array($emote->altidentifier, $notselectable)) {
- // Skip this one.
- unset($emoticons[$index]);
- }
- }
- }
-
- return $emoticons;
- }
-
- /**
- * Converts emoticon object into renderable pix_emoticon object
- *
- * @param stdClass $emoticon emoticon object
- * @param array $attributes explicit HTML attributes to set
- * @return pix_emoticon
- */
- public function prepare_renderable_emoticon(stdClass $emoticon, array $attributes = array()) {
- $stringmanager = get_string_manager();
- if ($stringmanager->string_exists($emoticon->altidentifier, $emoticon->altcomponent)) {
- $alt = get_string($emoticon->altidentifier, $emoticon->altcomponent);
- } else {
- $alt = s($emoticon->text);
- }
- return new pix_emoticon($emoticon->imagename, $alt, $emoticon->imagecomponent, $attributes);
- }
-
- /**
- * Encodes the array of emoticon objects into a string storable in config table
- *
- * @see self::decode_stored_config()
- * @param array $emoticons array of emtocion objects
- * @return string
- */
- public function encode_stored_config(array $emoticons) {
- return json_encode($emoticons);
- }
-
- /**
- * Decodes the string into an array of emoticon objects
- *
- * @see self::encode_stored_config()
- * @param string $encoded
- * @return array|null
- */
- public function decode_stored_config($encoded) {
- $decoded = json_decode($encoded);
- if (!is_array($decoded)) {
- return null;
- }
- return $decoded;
- }
-
- /**
- * Returns default set of emoticons supported by Moodle
- *
- * @return array of sdtClasses
- */
- public function default_emoticons() {
- return array(
- $this->prepare_emoticon_object(":-)", 's/smiley', 'smiley'),
- $this->prepare_emoticon_object(":)", 's/smiley', 'smiley'),
- $this->prepare_emoticon_object(":-D", 's/biggrin', 'biggrin'),
- $this->prepare_emoticon_object(";-)", 's/wink', 'wink'),
- $this->prepare_emoticon_object(":-/", 's/mixed', 'mixed'),
- $this->prepare_emoticon_object("V-.", 's/thoughtful', 'thoughtful'),
- $this->prepare_emoticon_object(":-P", 's/tongueout', 'tongueout'),
- $this->prepare_emoticon_object(":-p", 's/tongueout', 'tongueout'),
- $this->prepare_emoticon_object("B-)", 's/cool', 'cool'),
- $this->prepare_emoticon_object("^-)", 's/approve', 'approve'),
- $this->prepare_emoticon_object("8-)", 's/wideeyes', 'wideeyes'),
- $this->prepare_emoticon_object(":o)", 's/clown', 'clown'),
- $this->prepare_emoticon_object(":-(", 's/sad', 'sad'),
- $this->prepare_emoticon_object(":(", 's/sad', 'sad'),
- $this->prepare_emoticon_object("8-.", 's/shy', 'shy'),
- $this->prepare_emoticon_object(":-I", 's/blush', 'blush'),
- $this->prepare_emoticon_object(":-X", 's/kiss', 'kiss'),
- $this->prepare_emoticon_object("8-o", 's/surprise', 'surprise'),
- $this->prepare_emoticon_object("P-|", 's/blackeye', 'blackeye'),
- $this->prepare_emoticon_object("8-[", 's/angry', 'angry'),
- $this->prepare_emoticon_object("(grr)", 's/angry', 'angry'),
- $this->prepare_emoticon_object("xx-P", 's/dead', 'dead'),
- $this->prepare_emoticon_object("|-.", 's/sleepy', 'sleepy'),
- $this->prepare_emoticon_object("}-]", 's/evil', 'evil'),
- $this->prepare_emoticon_object("(h)", 's/heart', 'heart'),
- $this->prepare_emoticon_object("(heart)", 's/heart', 'heart'),
- $this->prepare_emoticon_object("(y)", 's/yes', 'yes', 'core'),
- $this->prepare_emoticon_object("(n)", 's/no', 'no', 'core'),
- $this->prepare_emoticon_object("(martin)", 's/martin', 'martin'),
- $this->prepare_emoticon_object("( )", 's/egg', 'egg'),
- );
- }
-
- /**
- * Helper method preparing the stdClass with the emoticon properties
- *
- * @param string|array $text or array of strings
- * @param string $imagename to be used by {@link pix_emoticon}
- * @param string $altidentifier alternative string identifier, null for no alt
- * @param string $altcomponent where the alternative string is defined
- * @param string $imagecomponent to be used by {@link pix_emoticon}
- * @return stdClass
- */
- protected function prepare_emoticon_object($text, $imagename, $altidentifier = null,
- $altcomponent = 'core_pix', $imagecomponent = 'core') {
- return (object)array(
- 'text' => $text,
- 'imagename' => $imagename,
- 'imagecomponent' => $imagecomponent,
- 'altidentifier' => $altidentifier,
- 'altcomponent' => $altcomponent,
- );
- }
-}
-
// ENVIRONMENT CHECKING.
/**
@@ -9951,9 +9799,11 @@ function check_consecutive_identical_characters($password, $maxchars) {
/**
* Helper function to do partial function binding.
- * so we can use it for preg_replace_callback, for example
- * this works with php functions, user functions, static methods and class methods
- * it returns you a callback that you can pass on like so:
+ *
+ * This is useful for cases such as preg_replace_callback where you may want to partially bind values.
+ *
+ * The use of named arguments is recommended for clarity.
+ * Please note that providing arguments in a different order may have mixed results for built-in functions.
*
* $callback = partial('somefunction', $arg1, $arg2);
* or
@@ -9964,45 +9814,12 @@ function check_consecutive_identical_characters($password, $maxchars) {
*
* and then the arguments that are passed through at calltime are appended to the argument list.
*
- * @param mixed $function a php callback
- * @param mixed $arg1,... $argv arguments to partially bind with
- * @return array Array callback
- */
-function partial() {
- if (!class_exists('partial')) {
- /**
- * Used to manage function binding.
- * @copyright 2009 Penny Leach
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class partial{
- /** @var array */
- public $values = array();
- /** @var string The function to call as a callback. */
- public $func;
- /**
- * Constructor
- * @param string $func
- * @param array $args
- */
- public function __construct($func, $args) {
- $this->values = $args;
- $this->func = $func;
- }
- /**
- * Calls the callback function.
- * @return mixed
- */
- public function method() {
- $args = func_get_args();
- return call_user_func_array($this->func, array_merge($this->values, $args));
- }
- }
- }
- $args = func_get_args();
- $func = array_shift($args);
- $p = new partial($func, $args);
- return array($p, 'method');
+ * @param callable $function a php callback
+ * @param mixed ...$initialargs The arguments to provide for the initial bind
+ * @return callable
+ */
+function partial(callable $callable, ...$initialargs): callable {
+ return fn (...$args) => $callable(...$initialargs, ...$args);
}
/**
@@ -10183,256 +10000,6 @@ function unserialize_object(string $input): stdClass {
return (object) $instance;
}
-/**
- * The lang_string class
- *
- * This special class is used to create an object representation of a string request.
- * It is special because processing doesn't occur until the object is first used.
- * The class was created especially to aid performance in areas where strings were
- * required to be generated but were not necessarily used.
- * As an example the admin tree when generated uses over 1500 strings, of which
- * normally only 1/3 are ever actually printed at any time.
- * The performance advantage is achieved by not actually processing strings that
- * arn't being used, as such reducing the processing required for the page.
- *
- * How to use the lang_string class?
- * There are two methods of using the lang_string class, first through the
- * forth argument of the get_string function, and secondly directly.
- * The following are examples of both.
- * 1. Through get_string calls e.g.
- * $string = get_string($identifier, $component, $a, true);
- * $string = get_string('yes', 'moodle', null, true);
- * 2. Direct instantiation
- * $string = new lang_string($identifier, $component, $a, $lang);
- * $string = new lang_string('yes');
- *
- * How do I use a lang_string object?
- * The lang_string object makes use of a magic __toString method so that you
- * are able to use the object exactly as you would use a string in most cases.
- * This means you are able to collect it into a variable and then directly
- * echo it, or concatenate it into another string, or similar.
- * The other thing you can do is manually get the string by calling the
- * lang_strings out method e.g.
- * $string = new lang_string('yes');
- * $string->out();
- * Also worth noting is that the out method can take one argument, $lang which
- * allows the developer to change the language on the fly.
- *
- * When should I use a lang_string object?
- * The lang_string object is designed to be used in any situation where a
- * string may not be needed, but needs to be generated.
- * The admin tree is a good example of where lang_string objects should be
- * used.
- * A more practical example would be any class that requries strings that may
- * not be printed (after all classes get renderer by renderers and who knows
- * what they will do ;))
- *
- * When should I not use a lang_string object?
- * Don't use lang_strings when you are going to use a string immediately.
- * There is no need as it will be processed immediately and there will be no
- * advantage, and in fact perhaps a negative hit as a class has to be
- * instantiated for a lang_string object, however get_string won't require
- * that.
- *
- * Limitations:
- * 1. You cannot use a lang_string object as an array offset. Doing so will
- * result in PHP throwing an error. (You can use it as an object property!)
- *
- * @package core
- * @category string
- * @copyright 2011 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class lang_string {
-
- /** @var string The strings identifier */
- protected $identifier;
- /** @var string The strings component. Default '' */
- protected $component = '';
- /** @var array|stdClass Any arguments required for the string. Default null */
- protected $a = null;
- /** @var string The language to use when processing the string. Default null */
- protected $lang = null;
-
- /** @var string The processed string (once processed) */
- protected $string = null;
-
- /**
- * A special boolean. If set to true then the object has been woken up and
- * cannot be regenerated. If this is set then $this->string MUST be used.
- * @var bool
- */
- protected $forcedstring = false;
-
- /**
- * Constructs a lang_string object
- *
- * This function should do as little processing as possible to ensure the best
- * performance for strings that won't be used.
- *
- * @param string $identifier The strings identifier
- * @param string $component The strings component
- * @param stdClass|array|mixed $a Any arguments the string requires
- * @param string $lang The language to use when processing the string.
- * @throws coding_exception
- */
- public function __construct($identifier, $component = '', $a = null, $lang = null) {
- if (empty($component)) {
- $component = 'moodle';
- }
-
- $this->identifier = $identifier;
- $this->component = $component;
- $this->lang = $lang;
-
- // We MUST duplicate $a to ensure that it if it changes by reference those
- // changes are not carried across.
- // To do this we always ensure $a or its properties/values are strings
- // and that any properties/values that arn't convertable are forgotten.
- if ($a !== null) {
- if (is_scalar($a)) {
- $this->a = $a;
- } else if ($a instanceof lang_string) {
- $this->a = $a->out();
- } else if (is_object($a) or is_array($a)) {
- $a = (array)$a;
- $this->a = array();
- foreach ($a as $key => $value) {
- // Make sure conversion errors don't get displayed (results in '').
- if (is_array($value)) {
- $this->a[$key] = '';
- } else if (is_object($value)) {
- if (method_exists($value, '__toString')) {
- $this->a[$key] = $value->__toString();
- } else {
- $this->a[$key] = '';
- }
- } else {
- $this->a[$key] = (string)$value;
- }
- }
- }
- }
-
- if (debugging(false, DEBUG_DEVELOPER)) {
- if (clean_param($this->identifier, PARAM_STRINGID) == '') {
- throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of the string identifier. Please check your string definition');
- }
- if (!empty($this->component) && clean_param($this->component, PARAM_COMPONENT) == '') {
- throw new coding_exception('Invalid string compontent. Please check your string definition');
- }
- if (!get_string_manager()->string_exists($this->identifier, $this->component)) {
- debugging('String does not exist. Please check your string definition for '.$this->identifier.'/'.$this->component, DEBUG_DEVELOPER);
- }
- }
- }
-
- /**
- * Processes the string.
- *
- * This function actually processes the string, stores it in the string property
- * and then returns it.
- * You will notice that this function is VERY similar to the get_string method.
- * That is because it is pretty much doing the same thing.
- * However as this function is an upgrade it isn't as tolerant to backwards
- * compatibility.
- *
- * @return string
- * @throws coding_exception
- */
- protected function get_string() {
- global $CFG;
-
- // Check if we need to process the string.
- if ($this->string === null) {
- // Check the quality of the identifier.
- if ($CFG->debugdeveloper && clean_param($this->identifier, PARAM_STRINGID) === '') {
- throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of the string identifier. Please check your string definition', DEBUG_DEVELOPER);
- }
-
- // Process the string.
- $this->string = get_string_manager()->get_string($this->identifier, $this->component, $this->a, $this->lang);
- // Debugging feature lets you display string identifier and component.
- if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
- $this->string .= ' {' . $this->identifier . '/' . $this->component . '}';
- }
- }
- // Return the string.
- return $this->string;
- }
-
- /**
- * Returns the string
- *
- * @param string $lang The langauge to use when processing the string
- * @return string
- */
- public function out($lang = null) {
- if ($lang !== null && $lang != $this->lang && ($this->lang == null && $lang != current_language())) {
- if ($this->forcedstring) {
- debugging('lang_string objects that have been used cannot be printed in another language. ('.$this->lang.' used)', DEBUG_DEVELOPER);
- return $this->get_string();
- }
- $translatedstring = new lang_string($this->identifier, $this->component, $this->a, $lang);
- return $translatedstring->out();
- }
- return $this->get_string();
- }
-
- /**
- * Magic __toString method for printing a string
- *
- * @return string
- */
- public function __toString() {
- return $this->get_string();
- }
-
- /**
- * Magic __set_state method used for var_export
- *
- * @param array $array
- * @return self
- */
- public static function __set_state(array $array): self {
- $tmp = new lang_string($array['identifier'], $array['component'], $array['a'], $array['lang']);
- $tmp->string = $array['string'];
- $tmp->forcedstring = $array['forcedstring'];
- return $tmp;
- }
-
- /**
- * Prepares the lang_string for sleep and stores only the forcedstring and
- * string properties... the string cannot be regenerated so we need to ensure
- * it is generated for this.
- *
- * @return array
- */
- public function __sleep() {
- $this->get_string();
- $this->forcedstring = true;
- return array('forcedstring', 'string', 'lang');
- }
-
- /**
- * Returns the identifier.
- *
- * @return string
- */
- public function get_identifier() {
- return $this->identifier;
- }
-
- /**
- * Returns the component.
- *
- * @return string
- */
- public function get_component() {
- return $this->component;
- }
-}
-
/**
* Get human readable name describing the given callable.
*
diff --git a/lib/outputactions.php b/lib/outputactions.php
index 04bf469af0607..b7c551871da43 100644
--- a/lib/outputactions.php
+++ b/lib/outputactions.php
@@ -14,207 +14,10 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
- * if (!$this->page->requires->should_create_one_time_item_now($thing)) {
- * return '';
- * }
- * // Else generate it.
- *
- *
- * @param string $thing identifier for the bit of content. Should be of the form
- * frankenstyle_things, e.g. core_course_modchooser.
- * @return bool if true, the caller should generate that bit of output now, otherwise don't.
- */
- public function should_create_one_time_item_now($thing) {
- if ($this->has_one_time_item_been_created($thing)) {
- return false;
- }
-
- $this->set_one_time_item_created($thing);
- return true;
- }
-
- /**
- * Has a particular bit of HTML that is only required once on this page
- * (e.g. the contents of the modchooser) already been generated?
- *
- * Normally, you can use the {@link should_create_one_time_item_now()} helper
- * method rather than calling this method directly.
- *
- * @param string $thing identifier for the bit of content. Should be of the form
- * frankenstyle_things, e.g. core_course_modchooser.
- * @return bool whether that bit of output has been created.
- */
- public function has_one_time_item_been_created($thing) {
- return isset($this->onetimeitemsoutput[$thing]);
- }
-
- /**
- * Indicate that a particular bit of HTML that is only required once on this
- * page (e.g. the contents of the modchooser) has been generated (or is about to be)?
- *
- * Normally, you can use the {@link should_create_one_time_item_now()} helper
- * method rather than calling this method directly.
- *
- * @param string $thing identifier for the bit of content. Should be of the form
- * frankenstyle_things, e.g. core_course_modchooser.
- */
- public function set_one_time_item_created($thing) {
- if ($this->has_one_time_item_been_created($thing)) {
- throw new coding_exception($thing . ' is only supposed to be ouput ' .
- 'once per page, but it seems to be being output again.');
- }
- return $this->onetimeitemsoutput[$thing] = true;
- }
-}
-
-/**
- * This class represents the YUI configuration.
- *
- * @copyright 2013 Andrew Nicols
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.5
- * @package core
- * @category output
- */
-class YUI_config {
- /**
- * These settings must be public so that when the object is converted to json they are exposed.
- * Note: Some of these are camelCase because YUI uses camelCase variable names.
- *
- * The settings are described and documented in the YUI API at:
- * - http://yuilibrary.com/yui/docs/api/classes/config.html
- * - http://yuilibrary.com/yui/docs/api/classes/Loader.html
- */
- public $debug = false;
- public $base;
- public $comboBase;
- public $combine;
- public $filter = null;
- public $insertBefore = 'firstthemesheet';
- public $groups = array();
- public $modules = array();
- /** @var array The log sources that should be not be logged. */
- public $logInclude = [];
- /** @var array Tog sources that should be logged. */
- public $logExclude = [];
- /** @var string The minimum log level for YUI logging statements. */
- public $logLevel;
-
- /**
- * @var array List of functions used by the YUI Loader group pattern recognition.
- */
- protected $jsconfigfunctions = array();
-
- /**
- * Create a new group within the YUI_config system.
- *
- * @param string $name The name of the group. This must be unique and
- * not previously used.
- * @param array $config The configuration for this group.
- * @return void
- */
- public function add_group($name, $config) {
- if (isset($this->groups[$name])) {
- throw new coding_exception("A YUI configuration group for '{$name}' already exists. To make changes to this group use YUI_config->update_group().");
- }
- $this->groups[$name] = $config;
- }
-
- /**
- * Update an existing group configuration
- *
- * Note, any existing configuration for that group will be wiped out.
- * This includes module configuration.
- *
- * @param string $name The name of the group. This must be unique and
- * not previously used.
- * @param array $config The configuration for this group.
- * @return void
- */
- public function update_group($name, $config) {
- if (!isset($this->groups[$name])) {
- throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
- }
- $this->groups[$name] = $config;
- }
-
- /**
- * Set the value of a configuration function used by the YUI Loader's pattern testing.
- *
- * Only the body of the function should be passed, and not the whole function wrapper.
- *
- * The JS function your write will be passed a single argument 'name' containing the
- * name of the module being loaded.
- *
- * @param $function String the body of the JavaScript function. This should be used i
- * @return string the name of the function to use in the group pattern configuration.
- */
- public function set_config_function($function) {
- $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn';
- if (isset($this->jsconfigfunctions[$configname])) {
- throw new coding_exception("A YUI config function with this name already exists. Config function names must be unique.");
- }
- $this->jsconfigfunctions[$configname] = $function;
- return '@' . $configname . '@';
- }
-
- /**
- * Allow setting of the config function described in {@see set_config_function} from a file.
- * The contents of this file are then passed to set_config_function.
- *
- * When jsrev is positive, the function is minified and stored in a MUC cache for subsequent uses.
- *
- * @param $file The path to the JavaScript function used for YUI configuration.
- * @return string the name of the function to use in the group pattern configuration.
- */
- public function set_config_source($file) {
- global $CFG;
- $cache = cache::make('core', 'yuimodules');
-
- // Attempt to get the metadata from the cache.
- $keyname = 'configfn_' . $file;
- $fullpath = $CFG->dirroot . '/' . $file;
- if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
- $cache->delete($keyname);
- $configfn = file_get_contents($fullpath);
- } else {
- $configfn = $cache->get($keyname);
- if ($configfn === false) {
- require_once($CFG->libdir . '/jslib.php');
- $configfn = core_minify::js_files(array($fullpath));
- $cache->set($keyname, $configfn);
- }
- }
- return $this->set_config_function($configfn);
- }
-
- /**
- * Retrieve the list of JavaScript functions for YUI_config groups.
- *
- * @return string The complete set of config functions
- */
- public function get_config_functions() {
- $configfunctions = '';
- foreach ($this->jsconfigfunctions as $functionname => $function) {
- $configfunctions .= "var {$functionname} = function(me) {";
- $configfunctions .= $function;
- $configfunctions .= "};\n";
- }
- return $configfunctions;
- }
-
- /**
- * Update the header JavaScript with any required modification for the YUI Loader.
- *
- * @param $js String The JavaScript to manipulate.
- * @return string the modified JS string.
- */
- public function update_header_js($js) {
- // Update the names of the the configFn variables.
- // The PHP json_encode function cannot handle literal names so we have to wrap
- // them in @ and then replace them with literals of the same function name.
- foreach ($this->jsconfigfunctions as $functionname => $function) {
- $js = str_replace('"@' . $functionname . '@"', $functionname, $js);
- }
- return $js;
- }
-
- /**
- * Add configuration for a specific module.
- *
- * @param string $name The name of the module to add configuration for.
- * @param array $config The configuration for the specified module.
- * @param string $group The name of the group to add configuration for.
- * If not specified, then this module is added to the global
- * configuration.
- * @return void
- */
- public function add_module_config($name, $config, $group = null) {
- if ($group) {
- if (!isset($this->groups[$name])) {
- throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
- }
- if (!isset($this->groups[$group]['modules'])) {
- $this->groups[$group]['modules'] = array();
- }
- $modules = &$this->groups[$group]['modules'];
- } else {
- $modules = &$this->modules;
- }
- $modules[$name] = $config;
- }
-
- /**
- * Add the moodle YUI module metadata for the moodle group to the YUI_config instance.
- *
- * If js caching is disabled, metadata will not be served causing YUI to calculate
- * module dependencies as each module is loaded.
- *
- * If metadata does not exist it will be created and stored in a MUC entry.
- *
- * @return void
- */
- public function add_moodle_metadata() {
- global $CFG;
- if (!isset($this->groups['moodle'])) {
- throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
- }
-
- if (!isset($this->groups['moodle']['modules'])) {
- $this->groups['moodle']['modules'] = array();
- }
-
- $cache = cache::make('core', 'yuimodules');
- if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
- $metadata = array();
- $metadata = $this->get_moodle_metadata();
- $cache->delete('metadata');
- } else {
- // Attempt to get the metadata from the cache.
- if (!$metadata = $cache->get('metadata')) {
- $metadata = $this->get_moodle_metadata();
- $cache->set('metadata', $metadata);
- }
- }
-
- // Merge with any metadata added specific to this page which was added manually.
- $this->groups['moodle']['modules'] = array_merge($this->groups['moodle']['modules'],
- $metadata);
- }
-
- /**
- * Determine the module metadata for all moodle YUI modules.
- *
- * This works through all modules capable of serving YUI modules, and attempts to get
- * metadata for each of those modules.
- *
- * @return array of module metadata
- */
- private function get_moodle_metadata() {
- $moodlemodules = array();
- // Core isn't a plugin type or subsystem - handle it seperately.
- if ($module = $this->get_moodle_path_metadata(core_component::get_component_directory('core'))) {
- $moodlemodules = array_merge($moodlemodules, $module);
- }
-
- // Handle other core subsystems.
- $subsystems = core_component::get_core_subsystems();
- foreach ($subsystems as $subsystem => $path) {
- if (is_null($path)) {
- continue;
- }
- if ($module = $this->get_moodle_path_metadata($path)) {
- $moodlemodules = array_merge($moodlemodules, $module);
- }
- }
-
- // And finally the plugins.
- $plugintypes = core_component::get_plugin_types();
- foreach ($plugintypes as $plugintype => $pathroot) {
- $pluginlist = core_component::get_plugin_list($plugintype);
- foreach ($pluginlist as $plugin => $path) {
- if ($module = $this->get_moodle_path_metadata($path)) {
- $moodlemodules = array_merge($moodlemodules, $module);
- }
- }
- }
-
- return $moodlemodules;
- }
-
- /**
- * Helper function process and return the YUI metadata for all of the modules under the specified path.
- *
- * @param string $path the UNC path to the YUI src directory.
- * @return array the complete array for frankenstyle directory.
- */
- private function get_moodle_path_metadata($path) {
- // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json.
- $baseyui = $path . '/yui/src';
- $modules = array();
- if (is_dir($baseyui)) {
- $items = new DirectoryIterator($baseyui);
- foreach ($items as $item) {
- if ($item->isDot() or !$item->isDir()) {
- continue;
- }
- $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json');
- if (!is_readable($metafile)) {
- continue;
- }
- $metadata = file_get_contents($metafile);
- $modules = array_merge($modules, (array) json_decode($metadata));
- }
- }
- return $modules;
- }
-
- /**
- * Define YUI modules which we have been required to patch between releases.
- *
- * We must do this because we aggressively cache content on the browser, and we must also override use of the
- * external CDN which will serve the true authoritative copy of the code without our patches.
- *
- * @param string $combobase The local combobase
- * @param string $yuiversion The current YUI version
- * @param int $patchlevel The patch level we're working to for YUI
- * @param array $patchedmodules An array containing the names of the patched modules
- * @return void
- */
- public function define_patched_core_modules($combobase, $yuiversion, $patchlevel, $patchedmodules) {
- // The version we use is suffixed with a patchlevel so that we can get additional revisions between YUI releases.
- $subversion = $yuiversion . '_' . $patchlevel;
-
- if ($this->comboBase == $combobase) {
- // If we are using the local combobase in the loader, we can add a group and still make use of the combo
- // loader. We just need to specify a different root which includes a slightly different YUI version number
- // to include our patchlevel.
- $patterns = array();
- $modules = array();
- foreach ($patchedmodules as $modulename) {
- // We must define the pattern and module here so that the loader uses our group configuration instead of
- // the standard module definition. We may lose some metadata provided by upstream but this will be
- // loaded when the module is loaded anyway.
- $patterns[$modulename] = array(
- 'group' => 'yui-patched',
- );
- $modules[$modulename] = array();
- }
-
- // Actually add the patch group here.
- $this->add_group('yui-patched', array(
- 'combine' => true,
- 'root' => $subversion . '/',
- 'patterns' => $patterns,
- 'modules' => $modules,
- ));
-
- } else {
- // The CDN is in use - we need to instead use the local combobase for this module and override the modules
- // definition. We cannot use the local base - we must use the combobase because we cannot invalidate the
- // local base in browser caches.
- $fullpathbase = $combobase . $subversion . '/';
- foreach ($patchedmodules as $modulename) {
- $this->modules[$modulename] = array(
- 'fullpath' => $fullpathbase . $modulename . '/' . $modulename . '-min.js'
- );
- }
- }
- }
-}
-
-/**
- * Invalidate all server and client side template caches.
- */
-function template_reset_all_caches() {
- global $CFG;
-
- $next = time();
- if (isset($CFG->templaterev) and $next <= $CFG->templaterev and $CFG->templaterev - $next < 60 * 60) {
- // This resolves problems when reset is requested repeatedly within 1s,
- // the < 1h condition prevents accidental switching to future dates
- // because we might not recover from it.
- $next = $CFG->templaterev + 1;
- }
-
- set_config('templaterev', $next);
-}
-
-/**
- * Invalidate all server and client side JS caches.
- */
-function js_reset_all_caches() {
- global $CFG;
-
- $next = time();
- if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) {
- // This resolves problems when reset is requested repeatedly within 1s,
- // the < 1h condition prevents accidental switching to future dates
- // because we might not recover from it.
- $next = $CFG->jsrev+1;
- }
-
- set_config('jsrev', $next);
-}
+// This file is deprecated, but it should never have been manually included by anything outside of lib/outputlib.php.
+// Throwing an exception here should be fine because removing the manual inclusion should have no impact.
+throw new \core\exception\coding_exception(
+ 'This file should not be manually included by any component.',
+);
diff --git a/lib/pagelib.php b/lib/pagelib.php
index cd649a39d7a2f..1c4d00195095f 100644
--- a/lib/pagelib.php
+++ b/lib/pagelib.php
@@ -31,6 +31,7 @@
use core\navigation\views\secondary;
use core\navigation\output\primary as primaryoutput;
use core\output\activity_header;
+use core\output\xhtml_container_stack;
/**
* $PAGE is a central store of information about the current page we are
@@ -1034,9 +1035,6 @@ public function has_navbar() {
* by the get_fragment() web service and not for use elsewhere.
*/
public function start_collecting_javascript_requirements() {
- global $CFG;
- require_once($CFG->libdir.'/outputfragmentrequirementslib.php');
-
// Check that the requirements manager has not already been switched.
if (get_class($this->_requires) == 'fragment_requirements_manager') {
throw new coding_exception('JavaScript collection has already been started.');
diff --git a/lib/psr/http-client/CHANGELOG.md b/lib/psr/http-client/CHANGELOG.md
index e2dc25f519b39..babba7c7b2ea6 100644
--- a/lib/psr/http-client/CHANGELOG.md
+++ b/lib/psr/http-client/CHANGELOG.md
@@ -2,6 +2,14 @@
All notable changes to this project will be documented in this file, in reverse chronological order by release.
+## 1.0.3
+
+Add `source` link in composer.json. No code changes.
+
+## 1.0.2
+
+Allow PSR-7 (psr/http-message) 2.0. No code changes.
+
## 1.0.1
Allow installation with PHP 8. No code changes.
diff --git a/lib/psr/http-client/README.md b/lib/psr/http-client/README.md
index 6876b8403639a..84af5c55d5fea 100644
--- a/lib/psr/http-client/README.md
+++ b/lib/psr/http-client/README.md
@@ -7,6 +7,6 @@ Note that this is not a HTTP Client implementation of its own. It is merely abst
The installable [package][package-url] and [implementations][implementation-url] are listed on Packagist.
-[psr-url]: http://www.php-fig.org/psr/psr-18
+[psr-url]: https://www.php-fig.org/psr/psr-18
[package-url]: https://packagist.org/packages/psr/http-client
[implementation-url]: https://packagist.org/providers/psr/http-client-implementation
diff --git a/lib/psr/http-client/composer.json b/lib/psr/http-client/composer.json
index c195f8ff155ad..6fed350beb874 100644
--- a/lib/psr/http-client/composer.json
+++ b/lib/psr/http-client/composer.json
@@ -7,12 +7,15 @@
"authors": [
{
"name": "PHP-FIG",
- "homepage": "http://www.php-fig.org/"
+ "homepage": "https://www.php-fig.org/"
}
],
+ "support": {
+ "source": "https://github.com/php-fig/http-client"
+ },
"require": {
"php": "^7.0 || ^8.0",
- "psr/http-message": "^1.0"
+ "psr/http-message": "^1.0 || ^2.0"
},
"autoload": {
"psr-4": {
diff --git a/lib/psr/http-client/readme_moodle.txt b/lib/psr/http-client/readme_moodle.txt
new file mode 100644
index 0000000000000..eaa9df3c716a0
--- /dev/null
+++ b/lib/psr/http-client/readme_moodle.txt
@@ -0,0 +1,10 @@
+# PSR-18 HTTP Client
+
+This is a description for including the PSR-18 Interfaces in Moodle
+
+## Installation
+
+1. Visit https://github.com/php-fig/http-client
+2. Download the latest release
+3. Unzip in this folder
+4. Update `thirdpartylibs.xml`
diff --git a/lib/psr/http-message/README.md b/lib/psr/http-message/README.md
index 28185338f7238..2668be6c30bbb 100644
--- a/lib/psr/http-message/README.md
+++ b/lib/psr/http-message/README.md
@@ -10,4 +10,7 @@ interface that describes a HTTP message. See the specification for more details.
Usage
-----
-We'll certainly need some stuff in here.
\ No newline at end of file
+Before reading the usage guide we recommend reading the PSR-7 interfaces method list:
+
+* [`PSR-7 Interfaces Method List`](docs/PSR7-Interfaces.md)
+* [`PSR-7 Usage Guide`](docs/PSR7-Usage.md)
\ No newline at end of file
diff --git a/lib/psr/http-message/composer.json b/lib/psr/http-message/composer.json
index b0d2937a03a5f..c66e5aba40c97 100644
--- a/lib/psr/http-message/composer.json
+++ b/lib/psr/http-message/composer.json
@@ -7,11 +7,11 @@
"authors": [
{
"name": "PHP-FIG",
- "homepage": "http://www.php-fig.org/"
+ "homepage": "https://www.php-fig.org/"
}
],
"require": {
- "php": ">=5.3.0"
+ "php": "^7.2 || ^8.0"
},
"autoload": {
"psr-4": {
@@ -20,7 +20,7 @@
},
"extra": {
"branch-alias": {
- "dev-master": "1.0.x-dev"
+ "dev-master": "2.0.x-dev"
}
}
}
diff --git a/lib/psr/http-message/docs/PSR7-Interfaces.md b/lib/psr/http-message/docs/PSR7-Interfaces.md
new file mode 100644
index 0000000000000..3a7e7dda69534
--- /dev/null
+++ b/lib/psr/http-message/docs/PSR7-Interfaces.md
@@ -0,0 +1,130 @@
+# Interfaces
+
+The purpose of this list is to help in finding the methods when working with PSR-7. This can be considered as a cheatsheet for PSR-7 interfaces.
+
+The interfaces defined in PSR-7 are the following:
+
+| Class Name | Description |
+|---|---|
+| [Psr\Http\Message\MessageInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessagemessageinterface) | Representation of a HTTP message |
+| [Psr\Http\Message\RequestInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessagerequestinterface) | Representation of an outgoing, client-side request. |
+| [Psr\Http\Message\ServerRequestInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageserverrequestinterface) | Representation of an incoming, server-side HTTP request. |
+| [Psr\Http\Message\ResponseInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageresponseinterface) | Representation of an outgoing, server-side response. |
+| [Psr\Http\Message\StreamInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessagestreaminterface) | Describes a data stream |
+| [Psr\Http\Message\UriInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageuriinterface) | Value object representing a URI. |
+| [Psr\Http\Message\UploadedFileInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageuploadedfileinterface) | Value object representing a file uploaded through an HTTP request. |
+
+## `Psr\Http\Message\MessageInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getProtocolVersion()` | Retrieve HTTP protocol version | 1.0 or 1.1 |
+| `withProtocolVersion($version)` | Returns new message instance with given HTTP protocol version | |
+| `getHeaders()` | Retrieve all HTTP Headers | [Request Header List](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields), [Response Header List](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Response_fields) |
+| `hasHeader($name)` | Checks if HTTP Header with given name exists | |
+| `getHeader($name)` | Retrieves a array with the values for a single header | |
+| `getHeaderLine($name)` | Retrieves a comma-separated string of the values for a single header | |
+| `withHeader($name, $value)` | Returns new message instance with given HTTP Header | if the header existed in the original instance, replaces the header value from the original message with the value provided when creating the new instance. |
+| `withAddedHeader($name, $value)` | Returns new message instance with appended value to given header | If header already exists value will be appended, if not a new header will be created |
+| `withoutHeader($name)` | Removes HTTP Header with given name| |
+| `getBody()` | Retrieves the HTTP Message Body | Returns object implementing `StreamInterface`|
+| `withBody(StreamInterface $body)` | Returns new message instance with given HTTP Message Body | |
+
+
+## `Psr\Http\Message\RequestInterface` Methods
+
+Same methods as `Psr\Http\Message\MessageInterface` + the following methods:
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getRequestTarget()` | Retrieves the message's request target | origin-form, absolute-form, authority-form, asterisk-form ([RFC7230](https://www.rfc-editor.org/rfc/rfc7230.txt)) |
+| `withRequestTarget($requestTarget)` | Return a new message instance with the specific request-target | |
+| `getMethod()` | Retrieves the HTTP method of the request. | GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE (defined in [RFC7231](https://tools.ietf.org/html/rfc7231)), PATCH (defined in [RFC5789](https://tools.ietf.org/html/rfc5789)) |
+| `withMethod($method)` | Returns a new message instance with the provided HTTP method | |
+| `getUri()` | Retrieves the URI instance | |
+| `withUri(UriInterface $uri, $preserveHost = false)` | Returns a new message instance with the provided URI | |
+
+
+## `Psr\Http\Message\ServerRequestInterface` Methods
+
+Same methods as `Psr\Http\Message\RequestInterface` + the following methods:
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getServerParams() ` | Retrieve server parameters | Typically derived from `$_SERVER` |
+| `getCookieParams()` | Retrieves cookies sent by the client to the server. | Typically derived from `$_COOKIES` |
+| `withCookieParams(array $cookies)` | Returns a new request instance with the specified cookies | |
+| `withQueryParams(array $query)` | Returns a new request instance with the specified query string arguments | |
+| `getUploadedFiles()` | Retrieve normalized file upload data | |
+| `withUploadedFiles(array $uploadedFiles)` | Returns a new request instance with the specified uploaded files | |
+| `getParsedBody()` | Retrieve any parameters provided in the request body | |
+| `withParsedBody($data)` | Returns a new request instance with the specified body parameters | |
+| `getAttributes()` | Retrieve attributes derived from the request | |
+| `getAttribute($name, $default = null)` | Retrieve a single derived request attribute | |
+| `withAttribute($name, $value)` | Returns a new request instance with the specified derived request attribute | |
+| `withoutAttribute($name)` | Returns a new request instance that without the specified derived request attribute | |
+
+## `Psr\Http\Message\ResponseInterface` Methods:
+
+Same methods as `Psr\Http\Message\MessageInterface` + the following methods:
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getStatusCode()` | Gets the response status code. | |
+| `withStatus($code, $reasonPhrase = '')` | Returns a new response instance with the specified status code and, optionally, reason phrase. | |
+| `getReasonPhrase()` | Gets the response reason phrase associated with the status code. | |
+
+## `Psr\Http\Message\StreamInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `__toString()` | Reads all data from the stream into a string, from the beginning to end. | |
+| `close()` | Closes the stream and any underlying resources. | |
+| `detach()` | Separates any underlying resources from the stream. | |
+| `getSize()` | Get the size of the stream if known. | |
+| `eof()` | Returns true if the stream is at the end of the stream.| |
+| `isSeekable()` | Returns whether or not the stream is seekable. | |
+| `seek($offset, $whence = SEEK_SET)` | Seek to a position in the stream. | |
+| `rewind()` | Seek to the beginning of the stream. | |
+| `isWritable()` | Returns whether or not the stream is writable. | |
+| `write($string)` | Write data to the stream. | |
+| `isReadable()` | Returns whether or not the stream is readable. | |
+| `read($length)` | Read data from the stream. | |
+| `getContents()` | Returns the remaining contents in a string | |
+| `getMetadata($key = null)()` | Get stream metadata as an associative array or retrieve a specific key. | |
+
+## `Psr\Http\Message\UriInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getScheme()` | Retrieve the scheme component of the URI. | |
+| `getAuthority()` | Retrieve the authority component of the URI. | |
+| `getUserInfo()` | Retrieve the user information component of the URI. | |
+| `getHost()` | Retrieve the host component of the URI. | |
+| `getPort()` | Retrieve the port component of the URI. | |
+| `getPath()` | Retrieve the path component of the URI. | |
+| `getQuery()` | Retrieve the query string of the URI. | |
+| `getFragment()` | Retrieve the fragment component of the URI. | |
+| `withScheme($scheme)` | Return an instance with the specified scheme. | |
+| `withUserInfo($user, $password = null)` | Return an instance with the specified user information. | |
+| `withHost($host)` | Return an instance with the specified host. | |
+| `withPort($port)` | Return an instance with the specified port. | |
+| `withPath($path)` | Return an instance with the specified path. | |
+| `withQuery($query)` | Return an instance with the specified query string. | |
+| `withFragment($fragment)` | Return an instance with the specified URI fragment. | |
+| `__toString()` | Return the string representation as a URI reference. | |
+
+## `Psr\Http\Message\UploadedFileInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getStream()` | Retrieve a stream representing the uploaded file. | |
+| `moveTo($targetPath)` | Move the uploaded file to a new location. | |
+| `getSize()` | Retrieve the file size. | |
+| `getError()` | Retrieve the error associated with the uploaded file. | |
+| `getClientFilename()` | Retrieve the filename sent by the client. | |
+| `getClientMediaType()` | Retrieve the media type sent by the client. | |
+
+> `RequestInterface`, `ServerRequestInterface`, `ResponseInterface` extend `MessageInterface` because the `Request` and the `Response` are `HTTP Messages`.
+> When using `ServerRequestInterface`, both `RequestInterface` and `Psr\Http\Message\MessageInterface` methods are considered.
+
diff --git a/lib/psr/http-message/docs/PSR7-Usage.md b/lib/psr/http-message/docs/PSR7-Usage.md
new file mode 100644
index 0000000000000..b6d048a341e8c
--- /dev/null
+++ b/lib/psr/http-message/docs/PSR7-Usage.md
@@ -0,0 +1,159 @@
+### PSR-7 Usage
+
+All PSR-7 applications comply with these interfaces
+They were created to establish a standard between middleware implementations.
+
+> `RequestInterface`, `ServerRequestInterface`, `ResponseInterface` extend `MessageInterface` because the `Request` and the `Response` are `HTTP Messages`.
+> When using `ServerRequestInterface`, both `RequestInterface` and `Psr\Http\Message\MessageInterface` methods are considered.
+
+
+The following examples will illustrate how basic operations are done in PSR-7.
+
+##### Examples
+
+
+For this examples to work (at least) a PSR-7 implementation package is required. (eg: zendframework/zend-diactoros, guzzlehttp/psr7, slim/slim, etc)
+All PSR-7 implementations should have the same behaviour.
+
+The following will be assumed:
+`$request` is an object of `Psr\Http\Message\RequestInterface` and
+
+`$response` is an object implementing `Psr\Http\Message\RequestInterface`
+
+
+### Working with HTTP Headers
+
+#### Adding headers to response:
+
+```php
+$response->withHeader('My-Custom-Header', 'My Custom Message');
+```
+
+#### Appending values to headers
+
+```php
+$response->withAddedHeader('My-Custom-Header', 'The second message');
+```
+
+#### Checking if header exists:
+
+```php
+$request->hasHeader('My-Custom-Header'); // will return false
+$response->hasHeader('My-Custom-Header'); // will return true
+```
+
+> Note: My-Custom-Header was only added in the Response
+
+#### Getting comma-separated values from a header (also applies to request)
+
+```php
+// getting value from request headers
+$request->getHeaderLine('Content-Type'); // will return: "text/html; charset=UTF-8"
+// getting value from response headers
+$response->getHeaderLine('My-Custom-Header'); // will return: "My Custom Message; The second message"
+```
+
+#### Getting array of value from a header (also applies to request)
+```php
+// getting value from request headers
+$request->getHeader('Content-Type'); // will return: ["text/html", "charset=UTF-8"]
+// getting value from response headers
+$response->getHeader('My-Custom-Header'); // will return: ["My Custom Message", "The second message"]
+```
+
+#### Removing headers from HTTP Messages
+```php
+// removing a header from Request, removing deprecated "Content-MD5" header
+$request->withoutHeader('Content-MD5');
+
+// removing a header from Response
+// effect: the browser won't know the size of the stream
+// the browser will download the stream till it ends
+$response->withoutHeader('Content-Length');
+```
+
+### Working with HTTP Message Body
+
+When working with the PSR-7 there are two methods of implementation:
+#### 1. Getting the body separately
+
+> This method makes the body handling easier to understand and is useful when repeatedly calling body methods. (You only call `getBody()` once). Using this method mistakes like `$response->write()` are also prevented.
+
+```php
+$body = $response->getBody();
+// operations on body, eg. read, write, seek
+// ...
+// replacing the old body
+$response->withBody($body);
+// this last statement is optional as we working with objects
+// in this case the "new" body is same with the "old" one
+// the $body variable has the same value as the one in $request, only the reference is passed
+```
+
+#### 2. Working directly on response
+
+> This method is useful when only performing few operations as the `$request->getBody()` statement fragment is required
+
+```php
+$response->getBody()->write('hello');
+```
+
+### Getting the body contents
+
+The following snippet gets the contents of a stream contents.
+> Note: Streams must be rewinded, if content was written into streams, it will be ignored when calling `getContents()` because the stream pointer is set to the last character, which is `\0` - meaning end of stream.
+```php
+$body = $response->getBody();
+$body->rewind(); // or $body->seek(0);
+$bodyText = $body->getContents();
+```
+> Note: If `$body->seek(1)` is called before `$body->getContents()`, the first character will be ommited as the starting pointer is set to `1`, not `0`. This is why using `$body->rewind()` is recommended.
+
+### Append to body
+
+```php
+$response->getBody()->write('Hello'); // writing directly
+$body = $request->getBody(); // which is a `StreamInterface`
+$body->write('xxxxx');
+```
+
+### Prepend to body
+Prepending is different when it comes to streams. The content must be copied before writing the content to be prepended.
+The following example will explain the behaviour of streams.
+
+```php
+// assuming our response is initially empty
+$body = $repsonse->getBody();
+// writing the string "abcd"
+$body->write('abcd');
+
+// seeking to start of stream
+$body->seek(0);
+// writing 'ef'
+$body->write('ef'); // at this point the stream contains "efcd"
+```
+
+#### Prepending by rewriting separately
+
+```php
+// assuming our response body stream only contains: "abcd"
+$body = $response->getBody();
+$body->rewind();
+$contents = $body->getContents(); // abcd
+// seeking the stream to beginning
+$body->rewind();
+$body->write('ef'); // stream contains "efcd"
+$body->write($contents); // stream contains "efabcd"
+```
+
+> Note: `getContents()` seeks the stream while reading it, therefore if the second `rewind()` method call was not present the stream would have resulted in `abcdefabcd` because the `write()` method appends to stream if not preceeded by `rewind()` or `seek(0)`.
+
+#### Prepending by using contents as a string
+```php
+$body = $response->getBody();
+$body->rewind();
+$contents = $body->getContents(); // efabcd
+$contents = 'ef'.$contents;
+$body->rewind();
+$body->write($contents);
+```
diff --git a/lib/psr/http-message/readme_moodle.txt b/lib/psr/http-message/readme_moodle.txt
new file mode 100644
index 0000000000000..622d300aa9d89
--- /dev/null
+++ b/lib/psr/http-message/readme_moodle.txt
@@ -0,0 +1,10 @@
+# PSR-7 HTTP Message
+
+This is a description for including the PSR-7 Interfaces in Moodle
+
+## Installation
+
+1. Visit https://github.com/php-fig/http-message
+2. Download the latest release
+3. Unzip in this folder
+4. Update `thirdpartylibs.xml`
diff --git a/lib/psr/http-message/src/MessageInterface.php b/lib/psr/http-message/src/MessageInterface.php
index dd46e5ec81eef..a83c98518d549 100644
--- a/lib/psr/http-message/src/MessageInterface.php
+++ b/lib/psr/http-message/src/MessageInterface.php
@@ -23,7 +23,7 @@ interface MessageInterface
*
* @return string HTTP protocol version.
*/
- public function getProtocolVersion();
+ public function getProtocolVersion(): string;
/**
* Return an instance with the specified HTTP protocol version.
@@ -38,7 +38,7 @@ public function getProtocolVersion();
* @param string $version HTTP protocol version
* @return static
*/
- public function withProtocolVersion($version);
+ public function withProtocolVersion(string $version): MessageInterface;
/**
* Retrieves all message header values.
@@ -65,7 +65,7 @@ public function withProtocolVersion($version);
* key MUST be a header name, and each value MUST be an array of strings
* for that header.
*/
- public function getHeaders();
+ public function getHeaders(): array;
/**
* Checks if a header exists by the given case-insensitive name.
@@ -75,7 +75,7 @@ public function getHeaders();
* name using a case-insensitive string comparison. Returns false if
* no matching header name is found in the message.
*/
- public function hasHeader($name);
+ public function hasHeader(string $name): bool;
/**
* Retrieves a message header value by the given case-insensitive name.
@@ -91,7 +91,7 @@ public function hasHeader($name);
* header. If the header does not appear in the message, this method MUST
* return an empty array.
*/
- public function getHeader($name);
+ public function getHeader(string $name): array;
/**
* Retrieves a comma-separated string of the values for a single header.
@@ -112,7 +112,7 @@ public function getHeader($name);
* concatenated together using a comma. If the header does not appear in
* the message, this method MUST return an empty string.
*/
- public function getHeaderLine($name);
+ public function getHeaderLine(string $name): string;
/**
* Return an instance with the provided value replacing the specified header.
@@ -129,7 +129,7 @@ public function getHeaderLine($name);
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
- public function withHeader($name, $value);
+ public function withHeader(string $name, $value): MessageInterface;
/**
* Return an instance with the specified header appended with the given value.
@@ -147,7 +147,7 @@ public function withHeader($name, $value);
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
- public function withAddedHeader($name, $value);
+ public function withAddedHeader(string $name, $value): MessageInterface;
/**
* Return an instance without the specified header.
@@ -161,14 +161,14 @@ public function withAddedHeader($name, $value);
* @param string $name Case-insensitive header field name to remove.
* @return static
*/
- public function withoutHeader($name);
+ public function withoutHeader(string $name): MessageInterface;
/**
* Gets the body of the message.
*
* @return StreamInterface Returns the body as a stream.
*/
- public function getBody();
+ public function getBody(): StreamInterface;
/**
* Return an instance with the specified message body.
@@ -183,5 +183,5 @@ public function getBody();
* @return static
* @throws \InvalidArgumentException When the body is not valid.
*/
- public function withBody(StreamInterface $body);
+ public function withBody(StreamInterface $body): MessageInterface;
}
diff --git a/lib/psr/http-message/src/RequestInterface.php b/lib/psr/http-message/src/RequestInterface.php
index a96d4fd636679..33f85e559d024 100644
--- a/lib/psr/http-message/src/RequestInterface.php
+++ b/lib/psr/http-message/src/RequestInterface.php
@@ -39,7 +39,7 @@ interface RequestInterface extends MessageInterface
*
* @return string
*/
- public function getRequestTarget();
+ public function getRequestTarget(): string;
/**
* Return an instance with the specific request-target.
@@ -55,17 +55,18 @@ public function getRequestTarget();
*
* @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
* request-target forms allowed in request messages)
- * @param mixed $requestTarget
+ * @param string $requestTarget
* @return static
*/
- public function withRequestTarget($requestTarget);
+ public function withRequestTarget(string $requestTarget): RequestInterface;
+
/**
* Retrieves the HTTP method of the request.
*
* @return string Returns the request method.
*/
- public function getMethod();
+ public function getMethod(): string;
/**
* Return an instance with the provided HTTP method.
@@ -82,7 +83,7 @@ public function getMethod();
* @return static
* @throws \InvalidArgumentException for invalid HTTP methods.
*/
- public function withMethod($method);
+ public function withMethod(string $method): RequestInterface;
/**
* Retrieves the URI instance.
@@ -93,7 +94,7 @@ public function withMethod($method);
* @return UriInterface Returns a UriInterface instance
* representing the URI of the request.
*/
- public function getUri();
+ public function getUri(): UriInterface;
/**
* Returns an instance with the provided URI.
@@ -125,5 +126,5 @@ public function getUri();
* @param bool $preserveHost Preserve the original state of the Host header.
* @return static
*/
- public function withUri(UriInterface $uri, $preserveHost = false);
+ public function withUri(UriInterface $uri, bool $preserveHost = false): RequestInterface;
}
diff --git a/lib/psr/http-message/src/ResponseInterface.php b/lib/psr/http-message/src/ResponseInterface.php
index c306514e6bbdf..e9299a91443f2 100644
--- a/lib/psr/http-message/src/ResponseInterface.php
+++ b/lib/psr/http-message/src/ResponseInterface.php
@@ -27,7 +27,7 @@ interface ResponseInterface extends MessageInterface
*
* @return int Status code.
*/
- public function getStatusCode();
+ public function getStatusCode(): int;
/**
* Return an instance with the specified status code and, optionally, reason phrase.
@@ -49,7 +49,7 @@ public function getStatusCode();
* @return static
* @throws \InvalidArgumentException For invalid status code arguments.
*/
- public function withStatus($code, $reasonPhrase = '');
+ public function withStatus(int $code, string $reasonPhrase = ''): ResponseInterface;
/**
* Gets the response reason phrase associated with the status code.
@@ -64,5 +64,5 @@ public function withStatus($code, $reasonPhrase = '');
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
* @return string Reason phrase; must return an empty string if none present.
*/
- public function getReasonPhrase();
+ public function getReasonPhrase(): string;
}
diff --git a/lib/psr/http-message/src/ServerRequestInterface.php b/lib/psr/http-message/src/ServerRequestInterface.php
index 02512340ad853..8625d0e100d93 100644
--- a/lib/psr/http-message/src/ServerRequestInterface.php
+++ b/lib/psr/http-message/src/ServerRequestInterface.php
@@ -51,7 +51,7 @@ interface ServerRequestInterface extends RequestInterface
*
* @return array
*/
- public function getServerParams();
+ public function getServerParams(): array;
/**
* Retrieve cookies.
@@ -63,7 +63,7 @@ public function getServerParams();
*
* @return array
*/
- public function getCookieParams();
+ public function getCookieParams(): array;
/**
* Return an instance with the specified cookies.
@@ -82,7 +82,7 @@ public function getCookieParams();
* @param array $cookies Array of key/value pairs representing cookies.
* @return static
*/
- public function withCookieParams(array $cookies);
+ public function withCookieParams(array $cookies): ServerRequestInterface;
/**
* Retrieve query string arguments.
@@ -96,7 +96,7 @@ public function withCookieParams(array $cookies);
*
* @return array
*/
- public function getQueryParams();
+ public function getQueryParams(): array;
/**
* Return an instance with the specified query string arguments.
@@ -120,7 +120,7 @@ public function getQueryParams();
* $_GET.
* @return static
*/
- public function withQueryParams(array $query);
+ public function withQueryParams(array $query): ServerRequestInterface;
/**
* Retrieve normalized file upload data.
@@ -134,7 +134,7 @@ public function withQueryParams(array $query);
* @return array An array tree of UploadedFileInterface instances; an empty
* array MUST be returned if no data is present.
*/
- public function getUploadedFiles();
+ public function getUploadedFiles(): array;
/**
* Create a new instance with the specified uploaded files.
@@ -147,7 +147,7 @@ public function getUploadedFiles();
* @return static
* @throws \InvalidArgumentException if an invalid structure is provided.
*/
- public function withUploadedFiles(array $uploadedFiles);
+ public function withUploadedFiles(array $uploadedFiles): ServerRequestInterface;
/**
* Retrieve any parameters provided in the request body.
@@ -194,7 +194,7 @@ public function getParsedBody();
* @throws \InvalidArgumentException if an unsupported argument type is
* provided.
*/
- public function withParsedBody($data);
+ public function withParsedBody($data): ServerRequestInterface;
/**
* Retrieve attributes derived from the request.
@@ -207,7 +207,7 @@ public function withParsedBody($data);
*
* @return array Attributes derived from the request.
*/
- public function getAttributes();
+ public function getAttributes(): array;
/**
* Retrieve a single derived request attribute.
@@ -224,7 +224,7 @@ public function getAttributes();
* @param mixed $default Default value to return if the attribute does not exist.
* @return mixed
*/
- public function getAttribute($name, $default = null);
+ public function getAttribute(string $name, $default = null);
/**
* Return an instance with the specified derived request attribute.
@@ -241,7 +241,7 @@ public function getAttribute($name, $default = null);
* @param mixed $value The value of the attribute.
* @return static
*/
- public function withAttribute($name, $value);
+ public function withAttribute(string $name, $value): ServerRequestInterface;
/**
* Return an instance that removes the specified derived request attribute.
@@ -257,5 +257,5 @@ public function withAttribute($name, $value);
* @param string $name The attribute name.
* @return static
*/
- public function withoutAttribute($name);
+ public function withoutAttribute(string $name): ServerRequestInterface;
}
diff --git a/lib/psr/http-message/src/StreamInterface.php b/lib/psr/http-message/src/StreamInterface.php
index f68f391269b47..a62aabb8288b8 100644
--- a/lib/psr/http-message/src/StreamInterface.php
+++ b/lib/psr/http-message/src/StreamInterface.php
@@ -25,14 +25,14 @@ interface StreamInterface
* @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
* @return string
*/
- public function __toString();
+ public function __toString(): string;
/**
* Closes the stream and any underlying resources.
*
* @return void
*/
- public function close();
+ public function close(): void;
/**
* Separates any underlying resources from the stream.
@@ -48,7 +48,7 @@ public function detach();
*
* @return int|null Returns the size in bytes if known, or null if unknown.
*/
- public function getSize();
+ public function getSize(): ?int;
/**
* Returns the current position of the file read/write pointer
@@ -56,21 +56,21 @@ public function getSize();
* @return int Position of the file pointer
* @throws \RuntimeException on error.
*/
- public function tell();
+ public function tell(): int;
/**
* Returns true if the stream is at the end of the stream.
*
* @return bool
*/
- public function eof();
+ public function eof(): bool;
/**
* Returns whether or not the stream is seekable.
*
* @return bool
*/
- public function isSeekable();
+ public function isSeekable(): bool;
/**
* Seek to a position in the stream.
@@ -84,7 +84,7 @@ public function isSeekable();
* SEEK_END: Set position to end-of-stream plus offset.
* @throws \RuntimeException on failure.
*/
- public function seek($offset, $whence = SEEK_SET);
+ public function seek(int $offset, int $whence = SEEK_SET): void;
/**
* Seek to the beginning of the stream.
@@ -96,14 +96,14 @@ public function seek($offset, $whence = SEEK_SET);
* @link http://www.php.net/manual/en/function.fseek.php
* @throws \RuntimeException on failure.
*/
- public function rewind();
+ public function rewind(): void;
/**
* Returns whether or not the stream is writable.
*
* @return bool
*/
- public function isWritable();
+ public function isWritable(): bool;
/**
* Write data to the stream.
@@ -112,14 +112,14 @@ public function isWritable();
* @return int Returns the number of bytes written to the stream.
* @throws \RuntimeException on failure.
*/
- public function write($string);
+ public function write(string $string): int;
/**
* Returns whether or not the stream is readable.
*
* @return bool
*/
- public function isReadable();
+ public function isReadable(): bool;
/**
* Read data from the stream.
@@ -131,7 +131,7 @@ public function isReadable();
* if no bytes are available.
* @throws \RuntimeException if an error occurs.
*/
- public function read($length);
+ public function read(int $length): string;
/**
* Returns the remaining contents in a string
@@ -140,7 +140,7 @@ public function read($length);
* @throws \RuntimeException if unable to read or an error occurs while
* reading.
*/
- public function getContents();
+ public function getContents(): string;
/**
* Get stream metadata as an associative array or retrieve a specific key.
@@ -149,10 +149,10 @@ public function getContents();
* stream_get_meta_data() function.
*
* @link http://php.net/manual/en/function.stream-get-meta-data.php
- * @param string $key Specific metadata to retrieve.
+ * @param string|null $key Specific metadata to retrieve.
* @return array|mixed|null Returns an associative array if no key is
* provided. Returns a specific key value if a key is provided and the
* value is found, or null if the key is not found.
*/
- public function getMetadata($key = null);
+ public function getMetadata(?string $key = null);
}
diff --git a/lib/psr/http-message/src/UploadedFileInterface.php b/lib/psr/http-message/src/UploadedFileInterface.php
index f8a6901e01447..dd19d653819f1 100644
--- a/lib/psr/http-message/src/UploadedFileInterface.php
+++ b/lib/psr/http-message/src/UploadedFileInterface.php
@@ -28,7 +28,7 @@ interface UploadedFileInterface
* @throws \RuntimeException in cases when no stream is available or can be
* created.
*/
- public function getStream();
+ public function getStream(): StreamInterface;
/**
* Move the uploaded file to a new location.
@@ -62,7 +62,7 @@ public function getStream();
* @throws \RuntimeException on any error during the move operation, or on
* the second or subsequent call to the method.
*/
- public function moveTo($targetPath);
+ public function moveTo(string $targetPath): void;
/**
* Retrieve the file size.
@@ -73,7 +73,7 @@ public function moveTo($targetPath);
*
* @return int|null The file size in bytes or null if unknown.
*/
- public function getSize();
+ public function getSize(): ?int;
/**
* Retrieve the error associated with the uploaded file.
@@ -89,7 +89,7 @@ public function getSize();
* @see http://php.net/manual/en/features.file-upload.errors.php
* @return int One of PHP's UPLOAD_ERR_XXX constants.
*/
- public function getError();
+ public function getError(): int;
/**
* Retrieve the filename sent by the client.
@@ -104,7 +104,7 @@ public function getError();
* @return string|null The filename sent by the client or null if none
* was provided.
*/
- public function getClientFilename();
+ public function getClientFilename(): ?string;
/**
* Retrieve the media type sent by the client.
@@ -119,5 +119,5 @@ public function getClientFilename();
* @return string|null The media type sent by the client or null if none
* was provided.
*/
- public function getClientMediaType();
+ public function getClientMediaType(): ?string;
}
diff --git a/lib/psr/http-message/src/UriInterface.php b/lib/psr/http-message/src/UriInterface.php
index 9d7ab9eae8f29..15e2cf2862850 100644
--- a/lib/psr/http-message/src/UriInterface.php
+++ b/lib/psr/http-message/src/UriInterface.php
@@ -1,4 +1,5 @@
=8.0.2"
+ "php": ">=8.1"
},
"autoload": {
"files": [
@@ -25,7 +25,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
- "dev-main": "3.0-dev"
+ "dev-main": "3.5-dev"
},
"thanks": {
"name": "symfony/contracts",
diff --git a/lib/table/UPGRADING.md b/lib/table/UPGRADING.md
new file mode 100644
index 0000000000000..e9eb81afec2e4
--- /dev/null
+++ b/lib/table/UPGRADING.md
@@ -0,0 +1,11 @@
+# core_table (subsystem) Upgrade notes
+
+## 4.5dev
+
+### Added
+
+- A new `$reponsive` property (defaulting to `true`) has been added to the `core_table\flexible_table` class.
+ This property allows you to control whether the table is rendered as a responsive table.
+
+ For more information see [MDL-80748](https://tracker.moodle.org/browse/MDL-80748)
+
diff --git a/lib/table/classes/base_export_format.php b/lib/table/classes/base_export_format.php
new file mode 100644
index 0000000000000..35653e4c444f8
--- /dev/null
+++ b/lib/table/classes/base_export_format.php
@@ -0,0 +1,102 @@
+.
+
+namespace core_table;
+
+use flexible_table;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once("{$CFG->libdir}/tablelib.php");
+
+/**
+ * The table base export format.
+ *
+ * @package core_table
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class base_export_format {
+ /**
+ * @var flexible_table or child class reference pointing to table class object from which to export data.
+ */
+ public $table;
+
+ /**
+ * @var bool output started. Keeps track of whether any output has been started yet.
+ */
+ public $documentstarted = false;
+
+ /**
+ * Constructor.
+ *
+ * @param flexible_table $table
+ */
+ public function __construct(&$table) {
+ $this->table =& $table;
+ }
+
+ public function set_table(&$table) {
+ $this->table =& $table;
+ }
+
+ public function add_data($row) {
+ return false;
+ }
+
+ public function add_seperator() {
+ return false;
+ }
+
+ public function document_started() {
+ return $this->documentstarted;
+ }
+
+ /**
+ * Format the text.
+ *
+ * Given text in a variety of format codings, this function returns
+ * the text as safe HTML or as plain text dependent on what is appropriate
+ * for the download format. The default removes all tags.
+ *
+ * @param string $text
+ * @param int $format
+ * @param null|array $options
+ * @param null|int $courseid
+ */
+ public function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid = null) {
+ // Use some whitespace to indicate where there was some line spacing.
+ $text = str_replace(['', "\n", "\r"], ' ', $text);
+ return html_entity_decode(strip_tags($text), ENT_COMPAT);
+ }
+
+ /**
+ * Format a row of data, removing HTML tags and entities from each of the cells
+ *
+ * @param array $row
+ * @return array
+ */
+ public function format_data(array $row): array {
+ return array_map([$this, 'format_text'], $row);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(base_export_format::class, \table_default_export_format_parent::class);
diff --git a/lib/table/classes/dataformat_export_format.php b/lib/table/classes/dataformat_export_format.php
new file mode 100644
index 0000000000000..fcc84a4a8b5fc
--- /dev/null
+++ b/lib/table/classes/dataformat_export_format.php
@@ -0,0 +1,156 @@
+.
+
+namespace core_table;
+
+use core\exception\coding_exception;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once("{$CFG->libdir}/tablelib.php");
+
+use core\dataformat;
+
+/**
+ * Dataformat exporter
+ *
+ * @package core_table
+ * @subpackage tablelib
+ * @copyright 2016 Brendan Heywood (brendan@catalyst-au.net)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class dataformat_export_format extends base_export_format {
+ /** @var \core\dataformat\base $dataformat */
+ protected $dataformat;
+
+ /** @var int $rownum */
+ protected $rownum = 0;
+
+ /** @var array $columns */
+ protected $columns;
+
+ /**
+ * Constructor
+ *
+ * @param string $table An sql table
+ * @param string $dataformat type of dataformat for export
+ */
+ public function __construct(&$table, $dataformat) {
+ parent::__construct($table);
+
+ if (ob_get_length()) {
+ throw new coding_exception("Output can not be buffered before instantiating table_dataformat_export_format");
+ }
+
+ $this->dataformat = dataformat::get_format_instance($dataformat);
+
+ // The dataformat export time to first byte could take a while to generate...
+ set_time_limit(0);
+
+ // Close the session so that the users other tabs in the same session are not blocked.
+ \core\session\manager::write_close();
+ }
+
+ /**
+ * Whether the current dataformat supports export of HTML
+ *
+ * @return bool
+ */
+ public function supports_html(): bool {
+ return $this->dataformat->supports_html();
+ }
+
+ /**
+ * Start document
+ *
+ * @param string $filename
+ * @param string $sheettitle
+ */
+ public function start_document($filename, $sheettitle) {
+ $this->documentstarted = true;
+ $this->dataformat->set_filename($filename);
+ $this->dataformat->send_http_headers();
+ $this->dataformat->set_sheettitle($sheettitle);
+ $this->dataformat->start_output();
+ }
+
+ /**
+ * Start export
+ *
+ * @param string $sheettitle optional spreadsheet worksheet title
+ */
+ public function start_table($sheettitle) {
+ $this->dataformat->set_sheettitle($sheettitle);
+ }
+
+ /**
+ * Output headers
+ *
+ * @param array $headers
+ */
+ public function output_headers($headers) {
+ $this->columns = $this->format_data($headers);
+ if (method_exists($this->dataformat, 'write_header')) {
+ error_log('The function write_header() does not support multiple sheets. In order to support multiple sheets you ' .
+ 'must implement start_output() and start_sheet() and remove write_header() in your dataformat.');
+ $this->dataformat->write_header($this->columns);
+ } else {
+ $this->dataformat->start_sheet($this->columns);
+ }
+ }
+
+ /**
+ * Add a row of data
+ *
+ * @param array $row One record of data
+ */
+ public function add_data($row) {
+ if (!$this->supports_html()) {
+ $row = $this->format_data($row);
+ }
+
+ $this->dataformat->write_record($row, $this->rownum++);
+ return true;
+ }
+
+ /**
+ * Finish export
+ */
+ public function finish_table() {
+ if (method_exists($this->dataformat, 'write_footer')) {
+ error_log('The function write_footer() does not support multiple sheets. In order to support multiple sheets you ' .
+ 'must implement close_sheet() and close_output() and remove write_footer() in your dataformat.');
+ $this->dataformat->write_footer($this->columns);
+ } else {
+ $this->dataformat->close_sheet($this->columns);
+ }
+ }
+
+ /**
+ * Finish download
+ */
+ public function finish_document() {
+ $this->dataformat->close_output();
+ exit();
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(dataformat_export_format::class, \table_dataformat_export_format::class);
diff --git a/lib/table/classes/flexible_table.php b/lib/table/classes/flexible_table.php
new file mode 100644
index 0000000000000..967006d1ef7a9
--- /dev/null
+++ b/lib/table/classes/flexible_table.php
@@ -0,0 +1,2031 @@
+.
+
+namespace core_table;
+
+use core\context;
+use core_table\local\filter\filterset;
+use core\exception\coding_exception;
+use core\output\renderable;
+use html_writer;
+use moodle_url;
+use paging_bar;
+use stdClass;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once("{$CFG->libdir}/tablelib.php");
+
+// phpcs:disable moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+/**
+ * Flexible table implementation.
+ *
+ * @package core_table
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class flexible_table {
+ public $attributes = [];
+ public $baseurl = null;
+
+ /** @var string The caption of table */
+ public $caption;
+
+ /** @var array The caption attributes of table */
+ public $captionattributes;
+
+ public $column_class = [];
+ public $column_nosort = ['userpic'];
+ public $column_style = [];
+ public $column_suppress = [];
+ public $columns = [];
+ public $currentrow = 0;
+ public $currpage = 0;
+
+ /**
+ * Which download plugin to use. Default '' means none - print html table with paging.
+ * Property set by is_downloading which typically passes in cleaned data from $
+ * @var string
+ */
+ public $download = '';
+
+ /**
+ * Whether data is downloadable from table. Determines whether to display download buttons. Set by method downloadable().
+ * @var bool
+ */
+ public $downloadable = false;
+
+ /** @var dataformat_export_format */
+ public $exportclass = null;
+
+ public $headers = [];
+ public $is_collapsible = false;
+ public $is_sortable = false;
+ public $maxsortkeys = 2;
+ public $pagesize = 30;
+ public $request = [];
+
+ /** @var bool Stores if setup has already been called on this flixible table. */
+ public $setup = false;
+
+ /** @var int[] Array of positions in which to display download controls. */
+ public $showdownloadbuttonsat = [TABLE_P_TOP];
+
+ public $sort_default_column = null;
+ public $sort_default_order = SORT_ASC;
+
+ /** @var bool Has start output been called yet? */
+ public $started_output = false;
+
+ public $totalrows = 0;
+ public $uniqueid = null;
+ public $use_initials = false;
+ public $use_pages = false;
+
+ /** @var string Key of field returned by db query that is the id field of the user table or equivalent. */
+ public $useridfield = 'id';
+
+ /** @var bool Whether to make the table to be scrolled horizontally with ease. Make table responsive across all viewports. */
+ public bool $responsive = true;
+
+ /** @var array The sticky attribute of each table column. */
+ protected $columnsticky = [];
+
+ /** @var string $filename */
+ protected $filename;
+
+ /**
+ * The currently applied filerset. This is required for dynamic tables, but can be used by other tables too if desired.
+ * @var filterset
+ */
+ protected $filterset = null;
+
+ /** @var string A column which should be considered as a header column. */
+ protected $headercolumn = null;
+
+ /** @var string For create header with help icon. */
+ private $helpforheaders = [];
+
+ /** @var array List of hidden columns. */
+ protected $hiddencolumns;
+
+ /** @var string The manually set first name initial preference */
+ protected $ifirst;
+
+ /** @var string The manually set last name initial preference */
+ protected $ilast;
+
+ /** @var bool Whether the table preferences is resetting. */
+ protected $resetting;
+
+ /** @var string */
+ protected $sheettitle;
+
+ /** @var array The fields to sort. */
+ protected $sortdata;
+
+ /** @var string[] Columns that are expected to contain a users fullname. */
+ protected $userfullnamecolumns = ['fullname'];
+
+ private $column_textsort = [];
+
+ /** @var array[] Attributes for each column */
+ private $columnsattributes = [];
+
+ /** @var int The default per page size for the table. */
+ private $defaultperpage = 30;
+
+ /** @var bool Whether to store table properties in the user_preferences table. */
+ private $persistent = false;
+
+ /** @var array For storing user-customised table properties in the user_preferences db table. */
+ private $prefs = [];
+
+ /**
+ * Constructor
+ * @param string $uniqueid all tables have to have a unique id, this is used
+ * as a key when storing table properties like sort order in the session.
+ */
+ public function __construct($uniqueid) {
+ $this->uniqueid = $uniqueid;
+ $this->request = [
+ TABLE_VAR_SORT => 'tsort',
+ TABLE_VAR_HIDE => 'thide',
+ TABLE_VAR_SHOW => 'tshow',
+ TABLE_VAR_IFIRST => 'tifirst',
+ TABLE_VAR_ILAST => 'tilast',
+ TABLE_VAR_PAGE => 'page',
+ TABLE_VAR_RESET => 'treset',
+ TABLE_VAR_DIR => 'tdir',
+ ];
+ }
+
+ /**
+ * Call this to pass the download type. Use :
+ * $download = optional_param('download', '', PARAM_ALPHA);
+ * To get the download type. We assume that if you call this function with
+ * params that this table's data is downloadable, so we call is_downloadable
+ * for you (even if the param is '', which means no download this time.
+ * Also you can call this method with no params to get the current set
+ * download type.
+ * @param string|null $download type of dataformat for export.
+ * @param string $filename filename for downloads without file extension.
+ * @param string $sheettitle title for downloaded data.
+ * @return string download dataformat type.
+ */
+ public function is_downloading($download = null, $filename = '', $sheettitle = '') {
+ if ($download !== null) {
+ $this->sheettitle = $sheettitle;
+ $this->is_downloadable(true);
+ $this->download = $download;
+ $this->filename = clean_filename($filename);
+ $this->export_class_instance();
+ }
+ return $this->download;
+ }
+
+ /**
+ * Get, and optionally set, the export class.
+ * @param dataformat_export_format $exportclass (optional) if passed, set the table to use this export class.
+ * @return dataformat_export_format the export class in use (after any set).
+ */
+ public function export_class_instance($exportclass = null) {
+ if (!is_null($exportclass)) {
+ $this->started_output = true;
+ $this->exportclass = $exportclass;
+ $this->exportclass->table = $this;
+ } else if (is_null($this->exportclass) && !empty($this->download)) {
+ $this->exportclass = new dataformat_export_format($this, $this->download);
+ if (!$this->exportclass->document_started()) {
+ $this->exportclass->start_document($this->filename, $this->sheettitle);
+ }
+ }
+ return $this->exportclass;
+ }
+
+ /**
+ * Probably don't need to call this directly. Calling is_downloading with a
+ * param automatically sets table as downloadable.
+ *
+ * @param bool $downloadable optional param to set whether data from
+ * table is downloadable. If ommitted this function can be used to get
+ * current state of table.
+ * @return bool whether table data is set to be downloadable.
+ */
+ public function is_downloadable($downloadable = null) {
+ if ($downloadable !== null) {
+ $this->downloadable = $downloadable;
+ }
+ return $this->downloadable;
+ }
+
+ /**
+ * Call with boolean true to store table layout changes in the user_preferences table.
+ * Note: user_preferences.value has a maximum length of 1333 characters.
+ * Call with no parameter to get current state of table persistence.
+ *
+ * @param bool $persistent Optional parameter to set table layout persistence.
+ * @return bool Whether or not the table layout preferences will persist.
+ */
+ public function is_persistent($persistent = null) {
+ if ($persistent == true) {
+ $this->persistent = true;
+ }
+ return $this->persistent;
+ }
+
+ /**
+ * Where to show download buttons.
+ * @param array $showat array of postions in which to show download buttons.
+ * Containing TABLE_P_TOP and/or TABLE_P_BOTTOM
+ */
+ public function show_download_buttons_at($showat) {
+ $this->showdownloadbuttonsat = $showat;
+ }
+
+ /**
+ * Sets the is_sortable variable to the given boolean, sort_default_column to
+ * the given string, and the sort_default_order to the given integer.
+ * @param bool $bool
+ * @param string $defaultcolumn
+ * @param int $defaultorder
+ * @return void
+ */
+ public function sortable($bool, $defaultcolumn = null, $defaultorder = SORT_ASC) {
+ $this->is_sortable = $bool;
+ $this->sort_default_column = $defaultcolumn;
+ $this->sort_default_order = $defaultorder;
+ }
+
+ /**
+ * Use text sorting functions for this column (required for text columns with Oracle).
+ * Be warned that you cannot use this with column aliases. You can only do this
+ * with real columns. See MDL-40481 for an example.
+ * @param string column name
+ */
+ public function text_sorting($column) {
+ $this->column_textsort[] = $column;
+ }
+
+ /**
+ * Do not sort using this column
+ * @param string column name
+ */
+ public function no_sorting($column) {
+ $this->column_nosort[] = $column;
+ }
+
+ /**
+ * Is the column sortable?
+ * @param string column name, null means table
+ * @return bool
+ */
+ public function is_sortable($column = null) {
+ if (empty($column)) {
+ return $this->is_sortable;
+ }
+ if (!$this->is_sortable) {
+ return false;
+ }
+ return !in_array($column, $this->column_nosort);
+ }
+
+ /**
+ * Sets the is_collapsible variable to the given boolean.
+ * @param bool $bool
+ * @return void
+ */
+ public function collapsible($bool) {
+ $this->is_collapsible = $bool;
+ }
+
+ /**
+ * Sets the use_pages variable to the given boolean.
+ * @param bool $bool
+ * @return void
+ */
+ public function pageable($bool) {
+ $this->use_pages = $bool;
+ }
+
+ /**
+ * Sets the use_initials variable to the given boolean.
+ * @param bool $bool
+ * @return void
+ */
+ public function initialbars($bool) {
+ $this->use_initials = $bool;
+ }
+
+ /**
+ * Sets the pagesize variable to the given integer, the totalrows variable
+ * to the given integer, and the use_pages variable to true.
+ * @param int $perpage
+ * @param int $total
+ * @return void
+ */
+ public function pagesize($perpage, $total) {
+ $this->pagesize = $perpage;
+ $this->totalrows = $total;
+ $this->use_pages = true;
+ }
+
+ /**
+ * Assigns each given variable in the array to the corresponding index
+ * in the request class variable.
+ * @param array $variables
+ * @return void
+ */
+ public function set_control_variables($variables) {
+ foreach ($variables as $what => $variable) {
+ if (isset($this->request[$what])) {
+ $this->request[$what] = $variable;
+ }
+ }
+ }
+
+ /**
+ * Gives the given $value to the $attribute index of $this->attributes.
+ * @param string $attribute
+ * @param mixed $value
+ * @return void
+ */
+ public function set_attribute($attribute, $value) {
+ $this->attributes[$attribute] = $value;
+ }
+
+ /**
+ * What this method does is set the column so that if the same data appears in
+ * consecutive rows, then it is not repeated.
+ *
+ * For example, in the quiz overview report, the fullname column is set to be suppressed, so
+ * that when one student has made multiple attempts, their name is only printed in the row
+ * for their first attempt.
+ * @param int $column the index of a column.
+ */
+ public function column_suppress($column) {
+ if (isset($this->column_suppress[$column])) {
+ $this->column_suppress[$column] = true;
+ }
+ }
+
+ /**
+ * Sets the given $column index to the given $classname in $this->column_class.
+ * @param int $column
+ * @param string $classname
+ * @return void
+ */
+ public function column_class($column, $classname) {
+ if (isset($this->column_class[$column])) {
+ $this->column_class[$column] = ' ' . $classname; // This space needed so that classnames don't run together in the HTML.
+ }
+ }
+
+ /**
+ * Sets the given $column index and $property index to the given $value in $this->column_style.
+ * @param int $column
+ * @param string $property
+ * @param mixed $value
+ * @return void
+ */
+ public function column_style($column, $property, $value) {
+ if (isset($this->column_style[$column])) {
+ $this->column_style[$column][$property] = $value;
+ }
+ }
+
+ /**
+ * Sets a sticky attribute to a column.
+ * @param string $column Column name
+ * @param bool $sticky
+ */
+ public function column_sticky(string $column, bool $sticky = true): void {
+ if (isset($this->columnsticky[$column])) {
+ $this->columnsticky[$column] = $sticky == true ? ' sticky-column' : '';
+ }
+ }
+
+ /**
+ * Sets the given $attributes to $this->columnsattributes.
+ * Column attributes will be added to every cell in the column.
+ *
+ * @param array[] $attributes e.g. ['c0_firstname' => ['data-foo' => 'bar']]
+ */
+ public function set_columnsattributes(array $attributes): void {
+ $this->columnsattributes = $attributes;
+ }
+
+ /**
+ * Sets all columns' $propertys to the given $value in $this->column_style.
+ * @param int $property
+ * @param string $value
+ * @return void
+ */
+ public function column_style_all($property, $value) {
+ foreach (array_keys($this->columns) as $column) {
+ $this->column_style[$column][$property] = $value;
+ }
+ }
+
+ /**
+ * Sets $this->baseurl.
+ * @param moodle_url|string $url the url with params needed to call up this page
+ */
+ public function define_baseurl($url) {
+ $this->baseurl = new moodle_url($url);
+ }
+
+ /**
+ * Define the columns for the table.
+ *
+ * @param array $columns an array of identifying names for columns. If
+ * columns are sorted then column names must correspond to a field in sql.
+ */
+ public function define_columns($columns) {
+ $this->columns = [];
+ $this->column_style = [];
+ $this->column_class = [];
+ $this->columnsticky = [];
+ $this->columnsattributes = [];
+ $colnum = 0;
+
+ foreach ($columns as $column) {
+ $this->columns[$column] = $colnum++;
+ $this->column_style[$column] = [];
+ $this->column_class[$column] = '';
+ $this->columnsticky[$column] = '';
+ $this->columnsattributes[$column] = [];
+ $this->column_suppress[$column] = false;
+ }
+ }
+
+ /**
+ * Define the headers for the table, replacing any existing header configuration.
+ *
+ * @param array $headers numerical keyed array of displayed string titles
+ * for each column.
+ */
+ public function define_headers($headers) {
+ $this->headers = $headers;
+ }
+
+ /**
+ * Mark a specific column as being a table header using the column name defined in define_columns.
+ *
+ * Note: Only one column can be a header, and it will be rendered using a th tag.
+ *
+ * @param string $column
+ */
+ public function define_header_column(string $column) {
+ $this->headercolumn = $column;
+ }
+
+ /**
+ * Defines a help icon for the header
+ *
+ * Always use this function if you need to create header with sorting and help icon.
+ *
+ * @param renderable[] $helpicons An array of renderable objects to be used as help icons
+ */
+ public function define_help_for_headers($helpicons) {
+ $this->helpforheaders = $helpicons;
+ }
+
+ /**
+ * Mark the table preferences to be reset.
+ */
+ public function mark_table_to_reset(): void {
+ $this->resetting = true;
+ }
+
+ /**
+ * Is the table marked for reset preferences?
+ *
+ * @return bool True if the table is marked to reset, false otherwise.
+ */
+ protected function is_resetting_preferences(): bool {
+ if ($this->resetting === null) {
+ $this->resetting = optional_param($this->request[TABLE_VAR_RESET], false, PARAM_BOOL);
+ }
+
+ return $this->resetting;
+ }
+
+ /**
+ * Must be called after table is defined. Use methods above first. Cannot
+ * use functions below till after calling this method.
+ */
+ public function setup() {
+ if (empty($this->columns) || empty($this->uniqueid)) {
+ return false;
+ }
+
+ $this->initialise_table_preferences();
+
+ if (empty($this->baseurl)) {
+ debugging('You should set baseurl when using flexible_table.');
+ global $PAGE;
+ $this->baseurl = $PAGE->url;
+ }
+
+ if ($this->currpage == null) {
+ $this->currpage = optional_param($this->request[TABLE_VAR_PAGE], 0, PARAM_INT);
+ }
+
+ $this->setup = true;
+
+ // Always introduce the "flexible" class for the table if not specified.
+ if (empty($this->attributes)) {
+ $this->attributes['class'] = 'flexible table table-striped table-hover';
+ } else if (!isset($this->attributes['class'])) {
+ $this->attributes['class'] = 'flexible table table-striped table-hover';
+ } else if (!in_array('flexible', explode(' ', $this->attributes['class']))) {
+ $this->attributes['class'] = trim('flexible table table-striped table-hover ' . $this->attributes['class']);
+ }
+ }
+
+ /**
+ * Get the order by clause from the session or user preferences, for the table with id $uniqueid.
+ * @param string $uniqueid the identifier for a table.
+ * @return string SQL fragment that can be used in an ORDER BY clause.
+ */
+ public static function get_sort_for_table($uniqueid) {
+ global $SESSION;
+ if (isset($SESSION->flextable[$uniqueid])) {
+ $prefs = $SESSION->flextable[$uniqueid];
+ } else if (!$prefs = json_decode(get_user_preferences("flextable_{$uniqueid}", ''), true)) {
+ return '';
+ }
+
+ if (empty($prefs['sortby'])) {
+ return '';
+ }
+ if (empty($prefs['textsort'])) {
+ $prefs['textsort'] = [];
+ }
+
+ return self::construct_order_by($prefs['sortby'], $prefs['textsort']);
+ }
+
+ /**
+ * Prepare an an order by clause from the list of columns to be sorted.
+ *
+ * @param array $cols column name => SORT_ASC or SORT_DESC
+ * @return string SQL fragment that can be used in an ORDER BY clause.
+ */
+ public static function construct_order_by($cols, $textsortcols = []) {
+ global $DB;
+ $bits = [];
+
+ foreach ($cols as $column => $order) {
+ if (in_array($column, $textsortcols)) {
+ $column = $DB->sql_order_by_text($column);
+ }
+ if ($order == SORT_ASC) {
+ $bits[] = $DB->sql_order_by_null($column);
+ } else {
+ $bits[] = $DB->sql_order_by_null($column, SORT_DESC);
+ }
+ }
+
+ return implode(', ', $bits);
+ }
+
+ /**
+ * Get the SQL Sort clause for the table.
+ *
+ * @return string SQL fragment that can be used in an ORDER BY clause.
+ */
+ public function get_sql_sort() {
+ return self::construct_order_by($this->get_sort_columns(), $this->column_textsort);
+ }
+
+ /**
+ * Whether the current table contains any fullname columns
+ *
+ * @return bool
+ */
+ private function contains_fullname_columns(): bool {
+ $fullnamecolumns = array_intersect_key($this->columns, array_flip($this->userfullnamecolumns));
+
+ return !empty($fullnamecolumns);
+ }
+
+ /**
+ * Get the columns to sort by, in the form required by {@see construct_order_by()}.
+ * @return array column name => SORT_... constant.
+ */
+ public function get_sort_columns() {
+ if (!$this->setup) {
+ throw new coding_exception('Cannot call get_sort_columns until you have called setup.');
+ }
+
+ if (empty($this->prefs['sortby'])) {
+ return [];
+ }
+ foreach ($this->prefs['sortby'] as $column => $notused) {
+ if (isset($this->columns[$column])) {
+ continue; // This column is OK.
+ }
+ if (in_array($column, \core_user\fields::get_name_fields()) && $this->contains_fullname_columns()) {
+ continue; // This column is OK.
+ }
+ // This column is not OK.
+ unset($this->prefs['sortby'][$column]);
+ }
+
+ return $this->prefs['sortby'];
+ }
+
+ /**
+ * Get the starting row number for this page.
+ *
+ * @return int the offset for LIMIT clause of SQL
+ */
+ public function get_page_start() {
+ if (!$this->use_pages) {
+ return '';
+ }
+ return $this->currpage * $this->pagesize;
+ }
+
+ /**
+ * @return int the pagesize for LIMIT clause of SQL
+ */
+ public function get_page_size() {
+ if (!$this->use_pages) {
+ return '';
+ }
+ return $this->pagesize;
+ }
+
+ /**
+ * @return array sql to add to where statement.
+ */
+ public function get_sql_where() {
+ global $DB;
+
+ $conditions = [];
+ $params = [];
+
+ if ($this->contains_fullname_columns()) {
+ static $i = 0;
+ $i++;
+
+ if (!empty($this->prefs['i_first'])) {
+ $conditions[] = $DB->sql_like('firstname', ':ifirstc' . $i, false, false);
+ $params['ifirstc' . $i] = $this->prefs['i_first'] . '%';
+ }
+ if (!empty($this->prefs['i_last'])) {
+ $conditions[] = $DB->sql_like('lastname', ':ilastc' . $i, false, false);
+ $params['ilastc' . $i] = $this->prefs['i_last'] . '%';
+ }
+ }
+
+ return [implode(" AND ", $conditions), $params];
+ }
+
+ /**
+ * Add a row of data to the table. This function takes an array or object with
+ * column names as keys or property names.
+ *
+ * It ignores any elements with keys that are not defined as columns. It
+ * puts in empty strings into the row when there is no element in the passed
+ * array corresponding to a column in the table. It puts the row elements in
+ * the proper order (internally row table data is stored by in arrays with
+ * a numerical index corresponding to the column number).
+ *
+ * @param object|array $rowwithkeys array keys or object property names are column names,
+ * as defined in call to define_columns.
+ * @param string $classname CSS class name to add to this row's tr tag.
+ */
+ public function add_data_keyed($rowwithkeys, $classname = '') {
+ $this->add_data($this->get_row_from_keyed($rowwithkeys), $classname);
+ }
+
+ /**
+ * Add a number of rows to the table at once. And optionally finish output after they have been added.
+ *
+ * @param (object|array|null)[] $rowstoadd Array of rows to add to table, a null value in array adds a separator row. Or a
+ * object or array is added to table. We expect properties for the row array as would be
+ * passed to add_data_keyed.
+ * @param bool $finish
+ */
+ public function format_and_add_array_of_rows($rowstoadd, $finish = true) {
+ foreach ($rowstoadd as $row) {
+ if (is_null($row)) {
+ $this->add_separator();
+ } else {
+ $this->add_data_keyed($this->format_row($row));
+ }
+ }
+ if ($finish) {
+ $this->finish_output(!$this->is_downloading());
+ }
+ }
+
+ /**
+ * Add a seperator line to table.
+ */
+ public function add_separator() {
+ if (!$this->setup) {
+ return false;
+ }
+ $this->add_data(null);
+ }
+
+ /**
+ * This method actually directly echoes the row passed to it now or adds it
+ * to the download. If this is the first row and start_output has not
+ * already been called this method also calls start_output to open the table
+ * or send headers for the downloaded.
+ * Can be used as before. print_html now calls finish_html to close table.
+ *
+ * @param array $row a numerically keyed row of data to add to the table.
+ * @param string $classname CSS class name to add to this row's tr tag.
+ * @return bool success.
+ */
+ public function add_data($row, $classname = '') {
+ if (!$this->setup) {
+ return false;
+ }
+ if (!$this->started_output) {
+ $this->start_output();
+ }
+ if ($this->exportclass !== null) {
+ if ($row === null) {
+ $this->exportclass->add_seperator();
+ } else {
+ $this->exportclass->add_data($row);
+ }
+ } else {
+ $this->print_row($row, $classname);
+ }
+ return true;
+ }
+
+ /**
+ * You should call this to finish outputting the table data after adding
+ * data to the table with add_data or add_data_keyed.
+ *
+ */
+ public function finish_output($closeexportclassdoc = true) {
+ if ($this->exportclass !== null) {
+ $this->exportclass->finish_table();
+ if ($closeexportclassdoc) {
+ $this->exportclass->finish_document();
+ }
+ } else {
+ $this->finish_html();
+ }
+ }
+
+ /**
+ * Hook that can be overridden in child classes to wrap a table in a form
+ * for example. Called only when there is data to display and not
+ * downloading.
+ */
+ public function wrap_html_start() {
+ }
+
+ /**
+ * Hook that can be overridden in child classes to wrap a table in a form
+ * for example. Called only when there is data to display and not
+ * downloading.
+ */
+ public function wrap_html_finish() {
+ }
+
+ /**
+ * Call appropriate methods on this table class to perform any processing on values before displaying in table.
+ * Takes raw data from the database and process it into human readable format, perhaps also adding html linking when
+ * displaying table as html, adding a div wrap, etc.
+ *
+ * See for example col_fullname below which will be called for a column whose name is 'fullname'.
+ *
+ * @param array|object $row row of data from db used to make one row of the table.
+ * @return array one row for the table, added using add_data_keyed method.
+ */
+ public function format_row($row) {
+ if (is_array($row)) {
+ $row = (object)$row;
+ }
+ $formattedrow = [];
+ foreach (array_keys($this->columns) as $column) {
+ $colmethodname = 'col_' . $column;
+ if (method_exists($this, $colmethodname)) {
+ $formattedcolumn = $this->$colmethodname($row);
+ } else {
+ $formattedcolumn = $this->other_cols($column, $row);
+ if ($formattedcolumn === null) {
+ $formattedcolumn = $row->$column;
+ }
+ }
+ $formattedrow[$column] = $formattedcolumn;
+ }
+ return $formattedrow;
+ }
+
+ /**
+ * Fullname is treated as a special columname in tablelib and should always
+ * be treated the same as the fullname of a user.
+ * @uses $this->useridfield if the userid field is not expected to be id
+ * then you need to override $this->useridfield to point at the correct
+ * field for the user id.
+ *
+ * @param object $row the data from the db containing all fields from the
+ * users table necessary to construct the full name of the user in
+ * current language.
+ * @return string contents of cell in column 'fullname', for this row.
+ */
+ public function col_fullname($row) {
+ global $COURSE;
+
+ $name = fullname($row, has_capability('moodle/site:viewfullnames', $this->get_context()));
+ if ($this->download) {
+ return $name;
+ }
+
+ $userid = $row->{$this->useridfield};
+ if ($COURSE->id == SITEID) {
+ $profileurl = new moodle_url('/user/profile.php', ['id' => $userid]);
+ } else {
+ $profileurl = new moodle_url(
+ '/user/view.php',
+ ['id' => $userid, 'course' => $COURSE->id]
+ );
+ }
+ return html_writer::link($profileurl, $name);
+ }
+
+ /**
+ * You can override this method in a child class. See the description of
+ * build_table which calls this method.
+ */
+ public function other_cols($column, $row) {
+ if (
+ isset($row->$column) && ($column === 'email' || $column === 'idnumber') &&
+ (!$this->is_downloading() || $this->export_class_instance()->supports_html())
+ ) {
+ // Columns email and idnumber may potentially contain malicious characters, escape them by default.
+ // This function will not be executed if the child class implements col_email() or col_idnumber().
+ return s($row->$column);
+ }
+ return null;
+ }
+
+ /**
+ * Used from col_* functions when text is to be displayed. Does the
+ * right thing - either converts text to html or strips any html tags
+ * depending on if we are downloading and what is the download type. Params
+ * are the same as format_text function in weblib.php but some default
+ * options are changed.
+ */
+ public function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid = null) {
+ if (!$this->is_downloading()) {
+ if (is_null($options)) {
+ $options = new stdClass();
+ }
+ // Some sensible defaults.
+ if (!isset($options->para)) {
+ $options->para = false;
+ }
+ if (!isset($options->newlines)) {
+ $options->newlines = false;
+ }
+ if (!isset($options->filter)) {
+ $options->filter = false;
+ }
+ return format_text($text, $format, $options);
+ } else {
+ $eci = $this->export_class_instance();
+ return $eci->format_text($text, $format, $options, $courseid);
+ }
+ }
+ /**
+ * This method is deprecated although the old api is still supported.
+ * @deprecated 1.9.2 - Jun 2, 2008
+ */
+ public function print_html() {
+ if (!$this->setup) {
+ return false;
+ }
+ $this->finish_html();
+ }
+
+ /**
+ * This function is not part of the public api.
+ * @return string initial of first name we are currently filtering by
+ */
+ public function get_initial_first() {
+ if (!$this->use_initials) {
+ return null;
+ }
+
+ return $this->prefs['i_first'];
+ }
+
+ /**
+ * This function is not part of the public api.
+ * @return string initial of last name we are currently filtering by
+ */
+ public function get_initial_last() {
+ if (!$this->use_initials) {
+ return null;
+ }
+
+ return $this->prefs['i_last'];
+ }
+
+ /**
+ * Helper function, used by {@see print_initials_bar()} to output one initial bar.
+ * @param array $alpha of letters in the alphabet.
+ * @param string $current the currently selected letter.
+ * @param string $class class name to add to this initial bar.
+ * @param string $title the name to put in front of this initial bar.
+ * @param string $urlvar URL parameter name for this initial.
+ *
+ * @deprecated since Moodle 3.3
+ */
+ protected function print_one_initials_bar($alpha, $current, $class, $title, $urlvar) {
+
+ debugging('Method print_one_initials_bar() is no longer used and has been deprecated, ' .
+ 'to print initials bar call print_initials_bar()', DEBUG_DEVELOPER);
+
+ echo html_writer::start_tag('div', ['class' => 'initialbar ' . $class]) .
+ $title . ' : ';
+ if ($current) {
+ echo html_writer::link($this->baseurl->out(false, [$urlvar => '']), get_string('all'));
+ } else {
+ echo html_writer::tag('strong', get_string('all'));
+ }
+
+ foreach ($alpha as $letter) {
+ if ($letter === $current) {
+ echo html_writer::tag('strong', $letter);
+ } else {
+ echo html_writer::link($this->baseurl->out(false, [$urlvar => $letter]), $letter);
+ }
+ }
+
+ echo html_writer::end_tag('div');
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function print_initials_bar() {
+ global $OUTPUT;
+
+ $ifirst = $this->get_initial_first();
+ $ilast = $this->get_initial_last();
+ if (is_null($ifirst)) {
+ $ifirst = '';
+ }
+ if (is_null($ilast)) {
+ $ilast = '';
+ }
+
+ if ((!empty($ifirst) || !empty($ilast) || $this->use_initials) && $this->contains_fullname_columns()) {
+ $prefixfirst = $this->request[TABLE_VAR_IFIRST];
+ $prefixlast = $this->request[TABLE_VAR_ILAST];
+ echo $OUTPUT->initials_bar($ifirst, 'firstinitial', get_string('firstname'), $prefixfirst, $this->baseurl);
+ echo $OUTPUT->initials_bar($ilast, 'lastinitial', get_string('lastname'), $prefixlast, $this->baseurl);
+ }
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function print_nothing_to_display() {
+ global $OUTPUT;
+
+ // Render the dynamic table header.
+ echo $this->get_dynamic_table_html_start();
+
+ // Render button to allow user to reset table preferences.
+ echo $this->render_reset_button();
+
+ $this->print_initials_bar();
+
+ echo $OUTPUT->notification(get_string('nothingtodisplay'), 'info', false);
+
+ // Render the dynamic table footer.
+ echo $this->get_dynamic_table_html_end();
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function get_row_from_keyed($rowwithkeys) {
+ if (is_object($rowwithkeys)) {
+ $rowwithkeys = (array)$rowwithkeys;
+ }
+ $row = [];
+ foreach (array_keys($this->columns) as $column) {
+ if (isset($rowwithkeys[$column])) {
+ $row[] = $rowwithkeys[$column];
+ } else {
+ $row[] = '';
+ }
+ }
+ return $row;
+ }
+
+ /**
+ * Get the html for the download buttons
+ *
+ * Usually only use internally
+ */
+ public function download_buttons() {
+ global $OUTPUT;
+
+ if ($this->is_downloadable() && !$this->is_downloading()) {
+ return $OUTPUT->download_dataformat_selector(
+ get_string('downloadas', 'table'),
+ $this->baseurl->out_omit_querystring(),
+ 'download',
+ $this->baseurl->params()
+ );
+ } else {
+ return '';
+ }
+ }
+
+ /**
+ * This function is not part of the public api.
+ * You don't normally need to call this. It is called automatically when
+ * needed when you start adding data to the table.
+ *
+ */
+ public function start_output() {
+ $this->started_output = true;
+ if ($this->exportclass !== null) {
+ $this->exportclass->start_table($this->sheettitle);
+ $this->exportclass->output_headers($this->headers);
+ } else {
+ $this->start_html();
+ $this->print_headers();
+ echo html_writer::start_tag('tbody');
+ }
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function print_row($row, $classname = '') {
+ echo $this->get_row_html($row, $classname);
+ }
+
+ /**
+ * Generate html code for the passed row.
+ *
+ * @param array $row Row data.
+ * @param string $classname classes to add.
+ *
+ * @return string $html html code for the row passed.
+ */
+ public function get_row_html($row, $classname = '') {
+ static $suppresslastrow = null;
+ $rowclasses = [];
+
+ if ($classname) {
+ $rowclasses[] = $classname;
+ }
+
+ $rowid = $this->uniqueid . '_r' . $this->currentrow;
+ $html = '';
+
+ $html .= html_writer::start_tag('tr', ['class' => implode(' ', $rowclasses), 'id' => $rowid]);
+
+ // If we have a separator, print it.
+ if ($row === null) {
+ $colcount = count($this->columns);
+ $html .= html_writer::tag('td', html_writer::tag(
+ 'div',
+ '',
+ ['class' => 'tabledivider']
+ ), ['colspan' => $colcount]);
+ } else {
+ $html .= $this->get_row_cells_html($rowid, $row, $suppresslastrow);
+ }
+
+ $html .= html_writer::end_tag('tr');
+
+ $suppressenabled = array_sum($this->column_suppress);
+ if ($suppressenabled) {
+ $suppresslastrow = $row;
+ }
+ $this->currentrow++;
+ return $html;
+ }
+
+ /**
+ * Generate html code for the row cells.
+ *
+ * @param string $rowid
+ * @param array $row
+ * @param array|null $suppresslastrow
+ * @return string
+ */
+ public function get_row_cells_html(string $rowid, array $row, ?array $suppresslastrow): string {
+ $html = '';
+ $colbyindex = array_flip($this->columns);
+ foreach ($row as $index => $data) {
+ $column = $colbyindex[$index];
+
+ $columnattributes = $this->columnsattributes[$column] ?? [];
+ if (isset($columnattributes['class'])) {
+ $this->column_class($column, $columnattributes['class']);
+ unset($columnattributes['class']);
+ }
+
+ $attributes = [
+ 'class' => "cell c{$index}" . $this->column_class[$column] . $this->columnsticky[$column],
+ 'id' => "{$rowid}_c{$index}",
+ 'style' => $this->make_styles_string($this->column_style[$column]),
+ ];
+
+ $celltype = 'td';
+ if ($this->headercolumn && $column == $this->headercolumn) {
+ $celltype = 'th';
+ $attributes['scope'] = 'row';
+ }
+
+ $attributes += $columnattributes;
+
+ if (empty($this->prefs['collapse'][$column])) {
+ if ($this->column_suppress[$column] && $suppresslastrow !== null && $suppresslastrow[$index] === $data) {
+ $content = ' ';
+ } else {
+ $content = $data;
+ }
+ } else {
+ $content = ' ';
+ }
+
+ $html .= html_writer::tag($celltype, $content, $attributes);
+ }
+ return $html;
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function finish_html() {
+ global $OUTPUT, $PAGE;
+
+ if (!$this->started_output) {
+ // No data has been added to the table.
+ $this->print_nothing_to_display();
+ } else {
+ // Print empty rows to fill the table to the current pagesize.
+ // This is done so the header aria-controls attributes do not point to
+ // non existant elements.
+ $emptyrow = array_fill(0, count($this->columns), '');
+ while ($this->currentrow < $this->pagesize) {
+ $this->print_row($emptyrow, 'emptyrow');
+ }
+
+ echo html_writer::end_tag('tbody');
+ echo html_writer::end_tag('table');
+ if ($this->responsive) {
+ echo html_writer::end_tag('div');
+ }
+ $this->wrap_html_finish();
+
+ // Paging bar.
+ if (in_array(TABLE_P_BOTTOM, $this->showdownloadbuttonsat)) {
+ echo $this->download_buttons();
+ }
+
+ if ($this->use_pages) {
+ $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
+ $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
+ echo $OUTPUT->render($pagingbar);
+ }
+
+ // Render the dynamic table footer.
+ echo $this->get_dynamic_table_html_end();
+ }
+ }
+
+ /**
+ * Generate the HTML for the collapse/uncollapse icon. This is a helper method
+ * used by {@see print_headers()}.
+ * @param string $column the column name, index into various names.
+ * @param int $index numerical index of the column.
+ * @return string HTML fragment.
+ */
+ protected function show_hide_link($column, $index) {
+ global $OUTPUT;
+ // Some headers contain
tags, do not include in title, hence the
+ // strip tags.
+
+ $ariacontrols = '';
+ for ($i = 0; $i < $this->pagesize; $i++) {
+ $ariacontrols .= $this->uniqueid . '_r' . $i . '_c' . $index . ' ';
+ }
+
+ $ariacontrols = trim($ariacontrols);
+
+ if (!empty($this->prefs['collapse'][$column])) {
+ $linkattributes = [
+ 'title' => get_string('show') . ' ' . strip_tags($this->headers[$index]),
+ 'aria-expanded' => 'false',
+ 'aria-controls' => $ariacontrols,
+ 'data-action' => 'show',
+ 'data-column' => $column,
+ 'role' => 'button',
+ ];
+ return html_writer::link(
+ $this->baseurl->out(false, [$this->request[TABLE_VAR_SHOW] => $column]),
+ $OUTPUT->pix_icon('t/switch_plus', null),
+ $linkattributes
+ );
+ } else if ($this->headers[$index] !== null) {
+ $linkattributes = [
+ 'title' => get_string('hide') . ' ' . strip_tags($this->headers[$index]),
+ 'aria-expanded' => 'true',
+ 'aria-controls' => $ariacontrols,
+ 'data-action' => 'hide',
+ 'data-column' => $column,
+ 'role' => 'button',
+ ];
+ return html_writer::link(
+ $this->baseurl->out(false, [$this->request[TABLE_VAR_HIDE] => $column]),
+ $OUTPUT->pix_icon('t/switch_minus', null),
+ $linkattributes
+ );
+ }
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function print_headers() {
+ global $CFG, $OUTPUT;
+
+ // Set the primary sort column/order where possible, so that sort links/icons are correct.
+ [
+ 'sortby' => $primarysortcolumn,
+ 'sortorder' => $primarysortorder,
+ ] = $this->get_primary_sort_order();
+
+ echo html_writer::start_tag('thead');
+ echo html_writer::start_tag('tr');
+ foreach ($this->columns as $column => $index) {
+ $iconhide = '';
+ if ($this->is_collapsible) {
+ $iconhide = $this->show_hide_link($column, $index);
+ }
+ switch ($column) {
+ case 'userpic':
+ // Do nothing, do not display sortable links.
+ break;
+
+ default:
+ if (array_search($column, $this->userfullnamecolumns) !== false) {
+ // Check the full name display for sortable fields.
+ if (has_capability('moodle/site:viewfullnames', $this->get_context())) {
+ $nameformat = $CFG->alternativefullnameformat;
+ } else {
+ $nameformat = $CFG->fullnamedisplay;
+ }
+
+ if ($nameformat == 'language') {
+ $nameformat = get_string('fullnamedisplay');
+ }
+
+ $requirednames = order_in_string(\core_user\fields::get_name_fields(), $nameformat);
+
+ if (!empty($requirednames)) {
+ if ($this->is_sortable($column)) {
+ // Done this way for the possibility of more than two sortable full name display fields.
+ $this->headers[$index] = '';
+ foreach ($requirednames as $name) {
+ $sortname = $this->sort_link(
+ get_string($name),
+ $name,
+ $primarysortcolumn === $name,
+ $primarysortorder
+ );
+ $this->headers[$index] .= $sortname . ' / ';
+ }
+ $helpicon = '';
+ if (isset($this->helpforheaders[$index])) {
+ $helpicon = $OUTPUT->render($this->helpforheaders[$index]);
+ }
+ $this->headers[$index] = substr($this->headers[$index], 0, -3) . $helpicon;
+ }
+ }
+ } else if ($this->is_sortable($column)) {
+ $helpicon = '';
+ if (isset($this->helpforheaders[$index])) {
+ $helpicon = $OUTPUT->render($this->helpforheaders[$index]);
+ }
+ $this->headers[$index] = $this->sort_link(
+ $this->headers[$index],
+ $column,
+ $primarysortcolumn == $column,
+ $primarysortorder
+ ) . $helpicon;
+ }
+ }
+
+ $attributes = [
+ 'class' => 'header c' . $index . $this->column_class[$column] . $this->columnsticky[$column],
+ 'scope' => 'col',
+ ];
+ if ($this->headers[$index] === null) {
+ $content = ' ';
+ } else if (!empty($this->prefs['collapse'][$column])) {
+ $content = $iconhide;
+ } else {
+ if (is_array($this->column_style[$column])) {
+ $attributes['style'] = $this->make_styles_string($this->column_style[$column]);
+ }
+ $helpicon = '';
+ if (isset($this->helpforheaders[$index]) && !$this->is_sortable($column)) {
+ $helpicon = $OUTPUT->render($this->helpforheaders[$index]);
+ }
+ $content = $this->headers[$index] . $helpicon . html_writer::tag(
+ 'div',
+ $iconhide,
+ ['class' => 'commands']
+ );
+ }
+ echo html_writer::tag('th', $content, $attributes);
+ }
+
+ echo html_writer::end_tag('tr');
+ echo html_writer::end_tag('thead');
+ }
+
+ /**
+ * Calculate the preferences for sort order based on user-supplied values and get params.
+ */
+ protected function set_sorting_preferences(): void {
+ $sortdata = $this->sortdata;
+
+ if ($sortdata === null) {
+ $sortdata = $this->prefs['sortby'];
+
+ $sortorder = optional_param($this->request[TABLE_VAR_DIR], $this->sort_default_order, PARAM_INT);
+ $sortby = optional_param($this->request[TABLE_VAR_SORT], '', PARAM_ALPHANUMEXT);
+
+ if (array_key_exists($sortby, $sortdata)) {
+ // This key already exists somewhere. Change its sortorder and bring it to the top.
+ unset($sortdata[$sortby]);
+ }
+ $sortdata = array_merge([$sortby => $sortorder], $sortdata);
+ }
+
+ $usernamefields = \core_user\fields::get_name_fields();
+ $sortdata = array_filter($sortdata, function ($sortby) use ($usernamefields) {
+ $isvalidsort = $sortby && $this->is_sortable($sortby);
+ $isvalidsort = $isvalidsort && empty($this->prefs['collapse'][$sortby]);
+ $isrealcolumn = isset($this->columns[$sortby]);
+ $isfullnamefield = $this->contains_fullname_columns() && in_array($sortby, $usernamefields);
+
+ return $isvalidsort && ($isrealcolumn || $isfullnamefield);
+ }, ARRAY_FILTER_USE_KEY);
+
+ // Finally, make sure that no more than $this->maxsortkeys are present into the array.
+ $sortdata = array_slice($sortdata, 0, $this->maxsortkeys);
+
+ // If a default order is defined and it is not in the current list of order by columns, add it at the end.
+ // This prevents results from being returned in a random order if the only order by column contains equal values.
+ if (!empty($this->sort_default_column) && !array_key_exists($this->sort_default_column, $sortdata)) {
+ $sortdata = array_merge($sortdata, [$this->sort_default_column => $this->sort_default_order]);
+ }
+
+ // Apply the sortdata to the preference.
+ $this->prefs['sortby'] = $sortdata;
+ }
+
+ /**
+ * Fill in the preferences for the initials bar.
+ */
+ protected function set_initials_preferences(): void {
+ $ifirst = $this->ifirst;
+ $ilast = $this->ilast;
+
+ if ($ifirst === null) {
+ $ifirst = optional_param($this->request[TABLE_VAR_IFIRST], null, PARAM_RAW);
+ }
+
+ if ($ilast === null) {
+ $ilast = optional_param($this->request[TABLE_VAR_ILAST], null, PARAM_RAW);
+ }
+
+ if (!is_null($ifirst) && ($ifirst === '' || strpos(get_string('alphabet', 'langconfig'), $ifirst) !== false)) {
+ $this->prefs['i_first'] = $ifirst;
+ }
+
+ if (!is_null($ilast) && ($ilast === '' || strpos(get_string('alphabet', 'langconfig'), $ilast) !== false)) {
+ $this->prefs['i_last'] = $ilast;
+ }
+ }
+
+ /**
+ * Set hide and show preferences.
+ */
+ protected function set_hide_show_preferences(): void {
+
+ if ($this->hiddencolumns !== null) {
+ $this->prefs['collapse'] = array_fill_keys(array_filter($this->hiddencolumns, function ($column) {
+ return array_key_exists($column, $this->columns);
+ }), true);
+ } else {
+ if ($column = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) {
+ if (isset($this->columns[$column])) {
+ $this->prefs['collapse'][$column] = true;
+ }
+ }
+ }
+
+ if ($column = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) {
+ unset($this->prefs['collapse'][$column]);
+ }
+
+ foreach (array_keys($this->prefs['collapse']) as $column) {
+ if (array_key_exists($column, $this->prefs['sortby'])) {
+ unset($this->prefs['sortby'][$column]);
+ }
+ }
+ }
+
+ /**
+ * Set the list of hidden columns.
+ *
+ * @param array $columns The list of hidden columns.
+ */
+ public function set_hidden_columns(array $columns): void {
+ $this->hiddencolumns = $columns;
+ }
+
+ /**
+ * Initialise table preferences.
+ */
+ protected function initialise_table_preferences(): void {
+ global $SESSION;
+
+ // Load any existing user preferences.
+ if ($this->persistent) {
+ $this->prefs = json_decode(get_user_preferences("flextable_{$this->uniqueid}", ''), true);
+ $oldprefs = $this->prefs;
+ } else if (isset($SESSION->flextable[$this->uniqueid])) {
+ $this->prefs = $SESSION->flextable[$this->uniqueid];
+ $oldprefs = $this->prefs;
+ }
+
+ // Set up default preferences if needed.
+ if (!$this->prefs || $this->is_resetting_preferences()) {
+ $this->prefs = [
+ 'collapse' => [],
+ 'sortby' => [],
+ 'i_first' => '',
+ 'i_last' => '',
+ 'textsort' => $this->column_textsort,
+ ];
+ }
+
+ if (!isset($oldprefs)) {
+ $oldprefs = $this->prefs;
+ }
+
+ // Save user preferences if they have changed.
+ if ($this->is_resetting_preferences()) {
+ $this->sortdata = null;
+ $this->ifirst = null;
+ $this->ilast = null;
+ }
+
+ if (
+ ($showcol = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) &&
+ isset($this->columns[$showcol])
+ ) {
+ $this->prefs['collapse'][$showcol] = false;
+ } else if (
+ ($hidecol = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) &&
+ isset($this->columns[$hidecol])
+ ) {
+ $this->prefs['collapse'][$hidecol] = true;
+ if (array_key_exists($hidecol, $this->prefs['sortby'])) {
+ unset($this->prefs['sortby'][$hidecol]);
+ }
+ }
+
+ $this->set_hide_show_preferences();
+ $this->set_sorting_preferences();
+ $this->set_initials_preferences();
+
+ // Now, reduce the width of collapsed columns and remove the width from columns that should be expanded.
+ foreach (array_keys($this->columns) as $column) {
+ if (!empty($this->prefs['collapse'][$column])) {
+ $this->column_style[$column]['width'] = '10px';
+ } else {
+ unset($this->column_style[$column]['width']);
+ }
+ }
+
+ if (empty($this->baseurl)) {
+ debugging('You should set baseurl when using flexible_table.');
+ global $PAGE;
+ $this->baseurl = $PAGE->url;
+ }
+
+ if ($this->currpage == null) {
+ $this->currpage = optional_param($this->request[TABLE_VAR_PAGE], 0, PARAM_INT);
+ }
+
+ $this->save_preferences($oldprefs);
+ }
+
+ /**
+ * Save preferences.
+ *
+ * @param array $oldprefs Old preferences to compare against.
+ */
+ protected function save_preferences($oldprefs): void {
+ global $SESSION;
+
+ if ($this->prefs != $oldprefs) {
+ if ($this->persistent) {
+ set_user_preference('flextable_' . $this->uniqueid, json_encode($this->prefs));
+ } else {
+ $SESSION->flextable[$this->uniqueid] = $this->prefs;
+ }
+ }
+ unset($oldprefs);
+ }
+
+ /**
+ * Set the preferred table sorting attributes.
+ *
+ * @param string $sortby The field to sort by.
+ * @param int $sortorder The sort order.
+ */
+ public function set_sortdata(array $sortdata): void {
+ $this->sortdata = [];
+ foreach ($sortdata as $sortitem) {
+ if (!array_key_exists($sortitem['sortby'], $this->sortdata)) {
+ $this->sortdata[$sortitem['sortby']] = (int) $sortitem['sortorder'];
+ }
+ }
+ }
+
+ /**
+ * Get the default per page.
+ *
+ * @return int
+ */
+ public function get_default_per_page(): int {
+ return $this->defaultperpage;
+ }
+
+ /**
+ * Set the default per page.
+ *
+ * @param int $defaultperpage
+ */
+ public function set_default_per_page(int $defaultperpage): void {
+ $this->defaultperpage = $defaultperpage;
+ }
+
+ /**
+ * Set the preferred first name initial in an initials bar.
+ *
+ * @param string $initial The character to set
+ */
+ public function set_first_initial(string $initial): void {
+ $this->ifirst = $initial;
+ }
+
+ /**
+ * Set the preferred last name initial in an initials bar.
+ *
+ * @param string $initial The character to set
+ */
+ public function set_last_initial(string $initial): void {
+ $this->ilast = $initial;
+ }
+
+ /**
+ * Set the page number.
+ *
+ * @param int $pagenumber The page number.
+ */
+ public function set_page_number(int $pagenumber): void {
+ $this->currpage = $pagenumber - 1;
+ }
+
+ /**
+ * Generate the HTML for the sort icon. This is a helper method used by {@see sort_link()}.
+ * @param bool $isprimary whether an icon is needed (it is only needed for the primary sort column.)
+ * @param int $order SORT_ASC or SORT_DESC
+ * @return string HTML fragment.
+ */
+ protected function sort_icon($isprimary, $order) {
+ global $OUTPUT;
+
+ if (!$isprimary) {
+ return '';
+ }
+
+ if ($order == SORT_ASC) {
+ return $OUTPUT->pix_icon('t/sort_asc', get_string('asc'));
+ } else {
+ return $OUTPUT->pix_icon('t/sort_desc', get_string('desc'));
+ }
+ }
+
+ /**
+ * Generate the correct tool tip for changing the sort order. This is a
+ * helper method used by {@see sort_link()}.
+ * @param bool $isprimary whether the is column is the current primary sort column.
+ * @param int $order SORT_ASC or SORT_DESC
+ * @return string the correct title.
+ */
+ protected function sort_order_name($isprimary, $order) {
+ if ($isprimary && $order != SORT_ASC) {
+ return get_string('desc');
+ } else {
+ return get_string('asc');
+ }
+ }
+
+ /**
+ * Generate the HTML for the sort link. This is a helper method used by {@see print_headers()}.
+ * @param string $text the text for the link.
+ * @param string $column the column name, may be a fake column like 'firstname' or a real one.
+ * @param bool $isprimary whether the is column is the current primary sort column.
+ * @param int $order SORT_ASC or SORT_DESC
+ * @return string HTML fragment.
+ */
+ protected function sort_link($text, $column, $isprimary, $order) {
+ // If we are already sorting by this column, switch direction.
+ if (array_key_exists($column, $this->prefs['sortby'])) {
+ $sortorder = $this->prefs['sortby'][$column] == SORT_ASC ? SORT_DESC : SORT_ASC;
+ } else {
+ $sortorder = $order;
+ }
+
+ $params = [
+ $this->request[TABLE_VAR_SORT] => $column,
+ $this->request[TABLE_VAR_DIR] => $sortorder,
+ ];
+
+ return html_writer::link(
+ $this->baseurl->out(false, $params),
+ $text . get_accesshide(get_string('sortby') . ' ' .
+ $text . ' ' . $this->sort_order_name($isprimary, $order)),
+ [
+ 'data-sortable' => $this->is_sortable($column),
+ 'data-sortby' => $column,
+ 'data-sortorder' => $sortorder,
+ 'role' => 'button',
+ ]
+ ) . ' ' . $this->sort_icon($isprimary, $order);
+ }
+
+ /**
+ * Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table
+ *
+ * @return array
+ */
+ protected function get_primary_sort_order(): array {
+ if (reset($this->prefs['sortby'])) {
+ return $this->get_sort_order();
+ }
+
+ return [
+ 'sortby' => $this->sort_default_column,
+ 'sortorder' => $this->sort_default_order,
+ ];
+ }
+
+ /**
+ * Return sorting attributes values.
+ *
+ * @return array
+ */
+ protected function get_sort_order(): array {
+ $sortbys = $this->prefs['sortby'];
+ $sortby = key($sortbys);
+
+ return [
+ 'sortby' => $sortby,
+ 'sortorder' => $sortbys[$sortby],
+ ];
+ }
+
+ /**
+ * Get dynamic class component.
+ *
+ * @return string
+ */
+ protected function get_component() {
+ $tableclass = explode("\\", get_class($this));
+ return reset($tableclass);
+ }
+
+ /**
+ * Get dynamic class handler.
+ *
+ * @return string
+ */
+ protected function get_handler() {
+ $tableclass = explode("\\", get_class($this));
+ return end($tableclass);
+ }
+
+ /**
+ * Get the dynamic table start wrapper.
+ * If this is not a dynamic table, then an empty string is returned making this safe to blindly call.
+ *
+ * @return string
+ */
+ protected function get_dynamic_table_html_start(): string {
+ if (is_a($this, dynamic::class)) {
+ $sortdata = array_map(function ($sortby, $sortorder) {
+ return [
+ 'sortby' => $sortby,
+ 'sortorder' => $sortorder,
+ ];
+ }, array_keys($this->prefs['sortby']), array_values($this->prefs['sortby']));
+ ;
+
+ return html_writer::start_tag('div', [
+ 'class' => 'table-dynamic position-relative',
+ 'data-region' => 'core_table/dynamic',
+ 'data-table-handler' => $this->get_handler(),
+ 'data-table-component' => $this->get_component(),
+ 'data-table-uniqueid' => $this->uniqueid,
+ 'data-table-filters' => json_encode($this->get_filterset()),
+ 'data-table-sort-data' => json_encode($sortdata),
+ 'data-table-first-initial' => $this->prefs['i_first'],
+ 'data-table-last-initial' => $this->prefs['i_last'],
+ 'data-table-page-number' => $this->currpage + 1,
+ 'data-table-page-size' => $this->pagesize,
+ 'data-table-default-per-page' => $this->get_default_per_page(),
+ 'data-table-hidden-columns' => json_encode(array_keys($this->prefs['collapse'])),
+ 'data-table-total-rows' => $this->totalrows,
+ ]);
+ }
+
+ return '';
+ }
+
+ /**
+ * Get the dynamic table end wrapper.
+ * If this is not a dynamic table, then an empty string is returned making this safe to blindly call.
+ *
+ * @return string
+ */
+ protected function get_dynamic_table_html_end(): string {
+ global $PAGE;
+
+ if (is_a($this, dynamic::class)) {
+ $output = '';
+
+ $perpageurl = new moodle_url($PAGE->url);
+
+ // Generate "Show all/Show per page" link.
+ if ($this->pagesize == TABLE_SHOW_ALL_PAGE_SIZE && $this->totalrows > $this->get_default_per_page()) {
+ $perpagesize = $this->get_default_per_page();
+ $perpagestring = get_string('showperpage', '', $this->get_default_per_page());
+ } else if ($this->pagesize < $this->totalrows) {
+ $perpagesize = TABLE_SHOW_ALL_PAGE_SIZE;
+ $perpagestring = get_string('showall', '', $this->totalrows);
+ }
+ if (isset($perpagesize) && isset($perpagestring)) {
+ $perpageurl->param('perpage', $perpagesize);
+ $output .= html_writer::link(
+ $perpageurl,
+ $perpagestring,
+ [
+ 'data-action' => 'showcount',
+ 'data-target-page-size' => $perpagesize,
+ ]
+ );
+ }
+
+ $PAGE->requires->js_call_amd('core_table/dynamic', 'init');
+ $output .= html_writer::end_tag('div');
+ return $output;
+ }
+
+ return '';
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function start_html() {
+ global $OUTPUT;
+
+ // Render the dynamic table header.
+ echo $this->get_dynamic_table_html_start();
+
+ // Render button to allow user to reset table preferences.
+ echo $this->render_reset_button();
+
+ // Do we need to print initial bars?
+ $this->print_initials_bar();
+
+ // Paging bar.
+ if ($this->use_pages) {
+ $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
+ $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
+ echo $OUTPUT->render($pagingbar);
+ }
+
+ if (in_array(TABLE_P_TOP, $this->showdownloadbuttonsat)) {
+ echo $this->download_buttons();
+ }
+
+ $this->wrap_html_start();
+ // Start of main data table.
+
+ if ($this->responsive) {
+ echo html_writer::start_tag('div', ['class' => 'no-overflow']);
+ }
+ echo html_writer::start_tag('table', $this->attributes) . $this->render_caption();
+ }
+
+ /**
+ * This function set caption for table.
+ *
+ * @param string $caption Caption of table.
+ * @param array|null $captionattributes Caption attributes of table.
+ */
+ public function set_caption(string $caption, ?array $captionattributes): void {
+ $this->caption = $caption;
+ $this->captionattributes = $captionattributes;
+ }
+
+ /**
+ * This function renders a table caption.
+ *
+ * @return string $output Caption of table.
+ */
+ public function render_caption(): string {
+ if ($this->caption === null) {
+ return '';
+ }
+
+ return html_writer::tag(
+ 'caption',
+ $this->caption,
+ $this->captionattributes,
+ );
+ }
+
+ /**
+ * This function is not part of the public api.
+ * @param array $styles CSS-property => value
+ * @return string values suitably to go in a style="" attribute in HTML.
+ */
+ public function make_styles_string($styles) {
+ if (empty($styles)) {
+ return null;
+ }
+
+ $string = '';
+ foreach ($styles as $property => $value) {
+ $string .= $property . ':' . $value . ';';
+ }
+ return $string;
+ }
+
+ /**
+ * Generate the HTML for the table preferences reset button.
+ *
+ * @return string HTML fragment, empty string if no need to reset
+ */
+ protected function render_reset_button() {
+
+ if (!$this->can_be_reset()) {
+ return '';
+ }
+
+ $url = $this->baseurl->out(false, [$this->request[TABLE_VAR_RESET] => 1]);
+
+ $html = html_writer::start_div('resettable mdl-right');
+ $html .= html_writer::link($url, get_string('resettable'), ['role' => 'button']);
+ $html .= html_writer::end_div();
+
+ return $html;
+ }
+
+ /**
+ * Are there some table preferences that can be reset?
+ *
+ * If true, then the "reset table preferences" widget should be displayed.
+ *
+ * @return bool
+ */
+ protected function can_be_reset() {
+ // Loop through preferences and make sure they are empty or set to the default value.
+ foreach ($this->prefs as $prefname => $prefval) {
+ if ($prefname === 'sortby' && !empty($this->sort_default_column)) {
+ // Check if the actual sorting differs from the default one.
+ if (empty($prefval) || ($prefval !== [$this->sort_default_column => $this->sort_default_order])) {
+ return true;
+ }
+ } else if ($prefname === 'collapse' && !empty($prefval)) {
+ // Check if there are some collapsed columns (all are expanded by default).
+ foreach ($prefval as $columnname => $iscollapsed) {
+ if ($iscollapsed) {
+ return true;
+ }
+ }
+ } else if (!empty($prefval)) {
+ // For all other cases, we just check if some preference is set.
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Get the context for the table.
+ *
+ * Note: This function _must_ be overridden by dynamic tables to ensure that the context is correctly determined
+ * from the filterset parameters.
+ *
+ * @return context
+ */
+ public function get_context(): context {
+ global $PAGE;
+
+ if (is_a($this, dynamic::class)) {
+ throw new coding_exception('The get_context function must be defined for a dynamic table');
+ }
+
+ return $PAGE->context;
+ }
+
+ /**
+ * Set the filterset in the table class.
+ *
+ * The use of filtersets is a requirement for dynamic tables, but can be used by other tables too if desired.
+ *
+ * @param filterset $filterset The filterset object to get filters and table parameters from
+ */
+ public function set_filterset(filterset $filterset): void {
+ $this->filterset = $filterset;
+
+ $this->guess_base_url();
+ }
+
+ /**
+ * Get the currently defined filterset.
+ *
+ * @return filterset
+ */
+ public function get_filterset(): ?filterset {
+ return $this->filterset;
+ }
+
+ /**
+ * Get the class used as a filterset.
+ *
+ * @return string
+ */
+ public static function get_filterset_class(): string {
+ return static::class . '_filterset';
+ }
+
+ /**
+ * Attempt to guess the base URL.
+ */
+ public function guess_base_url(): void {
+ if (is_a($this, dynamic::class)) {
+ throw new coding_exception('The guess_base_url function must be defined for a dynamic table');
+ }
+ }
+}
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(flexible_table::class, \flexible_table::class);
diff --git a/lib/table/classes/output/html_table.php b/lib/table/classes/output/html_table.php
new file mode 100644
index 0000000000000..8ec95880ca0aa
--- /dev/null
+++ b/lib/table/classes/output/html_table.php
@@ -0,0 +1,213 @@
+.
+
+namespace core_table\output;
+
+/**
+ * Holds all the information required to render a
+
{{> block_myoverview/nav-grouping-selector }}
{{> block_myoverview/nav-search-widget }}
diff --git a/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature b/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature
index 1ff584bbc83a4..e646087e9c4cf 100644
--- a/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature
+++ b/blocks/tag_youtube/tests/behat/configure_tag_youtube_block.feature
@@ -7,7 +7,7 @@ Feature: Adding and configuring YouTube block
Background:
Given I log in as "admin"
And I navigate to "Plugins > Blocks > Manage blocks" in site administration
- And I click on "Enable YouTube" "icon" in the "YouTube" "table_row"
+ And I toggle the "Enable YouTube" admin switch "on"
@javascript
Scenario: Category options are not available (except default) in the block settings if the YouTube API key is not set.
diff --git a/blocks/timeline/templates/main.mustache b/blocks/timeline/templates/main.mustache
index b3f7ea87eb3cd..3f7a761a1af05 100644
--- a/blocks/timeline/templates/main.mustache
+++ b/blocks/timeline/templates/main.mustache
@@ -25,7 +25,7 @@
', $debuginfo); // keep newlines + $label = get_string('debuginfo', 'debug') . $labelsep; + $output .= $this->notification("$label " . $debuginfo, 'notifytiny'); + } + if (!empty($backtrace)) { + $label = get_string('stacktrace', 'debug') . $labelsep; + $output .= $this->notification("$label " . format_backtrace($backtrace), 'notifytiny'); + } + if ($obbuffer !== '') { + $label = get_string('outputbuffer', 'debug') . $labelsep; + $output .= $this->notification("$label " . s($obbuffer), 'notifytiny'); + } + } + + if (empty($CFG->rolesactive)) { + // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable + } else if (!empty($link)) { + $output .= $this->continue_button($link); + } + + $output .= $this->footer(); + + // Padding to encourage IE to display our error page, rather than its own. + $output .= str_repeat(' ', 512); + + return $output; + } + + /** + * Output a notification (that is, a status message about something that has just happened). + * + * Note: \core\notification::add() may be more suitable for your usage. + * + * @param string $message The message to print out. + * @param ?string $type The type of notification. See constants on notification. + * @param bool $closebutton Whether to show a close icon to remove the notification (default true). + * @return string the HTML to output. + */ + public function notification($message, $type = null, $closebutton = true) { + $typemappings = [ + // Valid types. + 'success' => notification::NOTIFY_SUCCESS, + 'info' => notification::NOTIFY_INFO, + 'warning' => notification::NOTIFY_WARNING, + 'error' => notification::NOTIFY_ERROR, + + // Legacy types mapped to current types. + 'notifyproblem' => notification::NOTIFY_ERROR, + 'notifytiny' => notification::NOTIFY_ERROR, + 'notifyerror' => notification::NOTIFY_ERROR, + 'notifysuccess' => notification::NOTIFY_SUCCESS, + 'notifymessage' => notification::NOTIFY_INFO, + 'notifyredirect' => notification::NOTIFY_INFO, + 'redirectmessage' => notification::NOTIFY_INFO, + ]; + + $extraclasses = []; + + if ($type) { + if (strpos($type, ' ') === false) { + // No spaces in the list of classes, therefore no need to loop over and determine the class. + if (isset($typemappings[$type])) { + $type = $typemappings[$type]; + } else { + // The value provided did not match a known type. It must be an extra class. + $extraclasses = [$type]; + } + } else { + // Identify what type of notification this is. + $classarray = explode(' ', self::prepare_classes($type)); + + // Separate out the type of notification from the extra classes. + foreach ($classarray as $class) { + if (isset($typemappings[$class])) { + $type = $typemappings[$class]; + } else { + $extraclasses[] = $class; + } + } + } + } + + $notification = new notification($message, $type, $closebutton); + if (count($extraclasses)) { + $notification->set_extra_classes($extraclasses); + } + + // Return the rendered template. + return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this)); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_problem() { + throw new coding_exception('core_renderer::notify_problem() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_success() { + throw new coding_exception('core_renderer::notify_success() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_message() { + throw new coding_exception('core_renderer::notify_message() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_redirect() { + throw new coding_exception('core_renderer::notify_redirect() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * Render a notification (that is, a status message about something that has + * just happened). + * + * @param notification $notification the notification to print out + * @return string the HTML to output. + */ + protected function render_notification(notification $notification) { + return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this)); + } + + /** + * Returns HTML to display a continue button that goes to a particular URL. + * + * @param string|moodle_url $url The url the button goes to. + * @return string the HTML to output. + */ + public function continue_button($url) { + if (!($url instanceof moodle_url)) { + $url = new moodle_url($url); + } + $button = new single_button($url, get_string('continue'), 'get', single_button::BUTTON_PRIMARY); + $button->class = 'continuebutton'; + + return $this->render($button); + } + + /** + * Returns HTML to display a single paging bar to provide access to other pages (usually in a search) + * + * Theme developers: DO NOT OVERRIDE! Please override function + * {@see core_renderer::render_paging_bar()} instead. + * + * @param int $totalcount The total number of entries available to be paged through + * @param int $page The page you are currently viewing + * @param int $perpage The number of entries that should be shown per page + * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added + * @param string $pagevar name of page parameter that holds the page number + * @return string the HTML to output. + */ + public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') { + $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar); + return $this->render($pb); + } + + /** + * Returns HTML to display the paging bar. + * + * @param paging_bar $pagingbar + * @return string the HTML to output. + */ + protected function render_paging_bar(paging_bar $pagingbar) { + // Any more than 10 is not usable and causes weird wrapping of the pagination. + $pagingbar->maxdisplay = 10; + return $this->render_from_template('core/paging_bar', $pagingbar->export_for_template($this)); + } + + /** + * Returns HTML to display initials bar to provide access to other pages (usually in a search) + * + * @param string $current the currently selected letter. + * @param string $class class name to add to this initial bar. + * @param string $title the name to put in front of this initial bar. + * @param string $urlvar URL parameter name for this initial. + * @param string $url URL object. + * @param array $alpha of letters in the alphabet. + * @param bool $minirender Return a trimmed down view of the initials bar. + * @return string the HTML to output. + */ + public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null, bool $minirender = false) { + $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha, $minirender); + return $this->render($ib); + } + + /** + * Internal implementation of initials bar rendering. + * + * @param initials_bar $initialsbar + * @return string + */ + protected function render_initials_bar(initials_bar $initialsbar) { + return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this)); + } + + /** + * Output the place a skip link goes to. + * + * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call. + * @return string the HTML to output. + */ + public function skip_link_target($id = null) { + return html_writer::span('', '', ['id' => $id]); + } + + /** + * Outputs a heading + * + * @param string $text The text of the heading + * @param int $level The level of importance of the heading. Defaulting to 2 + * @param string $classes A space-separated list of CSS classes. Defaulting to null + * @param string $id An optional ID + * @return string the HTML to output. + */ + public function heading($text, $level = 2, $classes = null, $id = null) { + $level = (int) $level; + if ($level < 1 or $level > 6) { + throw new coding_exception('Heading level must be an integer between 1 and 6.'); + } + return html_writer::tag('h' . $level, $text, ['id' => $id, 'class' => renderer_base::prepare_classes($classes)]); + } + + /** + * Outputs a box. + * + * @param string $contents The contents of the box + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes An array of other attributes to give the box. + * @return string the HTML to output. + */ + public function box($contents, $classes = 'generalbox', $id = null, $attributes = []) { + return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end(); + } + + /** + * Outputs the opening section of a box. + * + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes An array of other attributes to give the box. + * @return string the HTML to output. + */ + public function box_start($classes = 'generalbox', $id = null, $attributes = []) { + $this->opencontainers->push('box', html_writer::end_tag('div')); + $attributes['id'] = $id; + $attributes['class'] = 'box py-3 ' . renderer_base::prepare_classes($classes); + return html_writer::start_tag('div', $attributes); + } + + /** + * Outputs the closing section of a box. + * + * @return string the HTML to output. + */ + public function box_end() { + return $this->opencontainers->pop('box'); + } + + /** + * Outputs a paragraph. + * + * @param string $contents The contents of the paragraph + * @param string|null $classes A space-separated list of CSS classes + * @param string|null $id An optional ID + * @return string the HTML to output. + */ + public function paragraph(string $contents, ?string $classes = null, ?string $id = null): string { + return html_writer::tag( + 'p', + $contents, + ['id' => $id, 'class' => renderer_base::prepare_classes($classes)] + ); + } + + /** + * Outputs a screen reader only inline text. + * + * @param string $contents The contents of the paragraph + * @return string the HTML to output. + */ + public function sr_text(string $contents): string { + return html_writer::tag( + 'span', + $contents, + ['class' => 'sr-only'] + ) . ' '; + } + + /** + * Outputs a container. + * + * @param string $contents The contents of the box + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes Optional other attributes as array + * @return string the HTML to output. + */ + public function container($contents, $classes = null, $id = null, $attributes = []) { + return $this->container_start($classes, $id, $attributes) . $contents . $this->container_end(); + } + + /** + * Outputs the opening section of a container. + * + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes Optional other attributes as array + * @return string the HTML to output. + */ + public function container_start($classes = null, $id = null, $attributes = []) { + $this->opencontainers->push('container', html_writer::end_tag('div')); + $attributes = array_merge(['id' => $id, 'class' => renderer_base::prepare_classes($classes)], $attributes); + return html_writer::start_tag('div', $attributes); + } + + /** + * Outputs the closing section of a container. + * + * @return string the HTML to output. + */ + public function container_end() { + return $this->opencontainers->pop('container'); + } + + /** + * Make nested HTML lists out of the items + * + * The resulting list will look something like this: + * + *') . ' NA ',
+ check_result::OK => ' ' . cli_ansi_format('') . ' OK ',
+ check_result::INFO => ' ' . cli_ansi_format('') . ' INFO ',
+ check_result::UNKNOWN => ' ' . cli_ansi_format('') . ' UNKNOWN ',
+ check_result::WARNING => ' ' . cli_ansi_format('') . ' WARNING ',
+ check_result::ERROR => ' ' . cli_ansi_format('') . ' ERROR ',
+ check_result::CRITICAL => '' . cli_ansi_format('') . ' CRITICAL ',
+ ];
+ $string = $labels[$status] . cli_ansi_format('');
+ return $string;
+ }
+
+ /**
+ * Renders a Check API result
+ *
+ * @param check_result $result
+ * @return string fragment
+ */
+ public function check_result(check_result $result) {
+ return $this->render_check_result($result);
+ }
+
+ /**
+ * Renders a progress bar.
+ *
+ * Do not use $OUTPUT->render($bar), instead use progress_bar::create().
+ *
+ * @param progress_bar $bar The bar.
+ * @return string ascii fragment
+ */
+ public function render_progress_bar(progress_bar $bar) {
+ global $CFG;
+
+ $size = 55; // The width of the progress bar in chars.
+ $ascii = "\n";
+
+ if (stream_isatty(STDOUT)) {
+ require_once($CFG->libdir . '/clilib.php');
+
+ $ascii .= "[" . str_repeat(' ', $size) . "] 0% \n";
+ return cli_ansi_format($ascii);
+ }
+
+ $this->progressmaximums[$bar->get_id()] = 0;
+ $ascii .= '[';
+ return $ascii;
+ }
+
+ /**
+ * Renders an update to a progress bar.
+ *
+ * Note: This does not cleanly map to a renderable class and should
+ * never be used directly.
+ *
+ * @param string $id
+ * @param float $percent
+ * @param string $msg Message
+ * @param string $estimate time remaining message
+ * @return string ascii fragment
+ */
+ public function render_progress_bar_update(string $id, float $percent, string $msg, string $estimate): string {
+ $size = 55; // The width of the progress bar in chars.
+ $ascii = '';
+
+ // If we are rendering to a terminal then we can safely use ansii codes
+ // to move the cursor and redraw the complete progress bar each time
+ // it is updated.
+ if (stream_isatty(STDOUT)) {
+ $colour = $percent == 100 ? 'green' : 'blue';
+
+ $done = $percent * $size * 0.01;
+ $whole = floor($done);
+ $bar = "";
+ $bar .= str_repeat('█', $whole);
+
+ if ($whole < $size) {
+ // By using unicode chars for partial blocks we can have higher
+ // precision progress bar.
+ $fraction = floor(($done - $whole) * 8);
+ $bar .= core_text::substr(' ▏▎▍▌▋▊▉', $fraction, 1);
+
+ // Fill the rest of the empty bar.
+ $bar .= str_repeat(' ', $size - $whole - 1);
+ }
+
+ $bar .= '';
+
+ if ($estimate) {
+ $estimate = "- $estimate";
+ }
+
+ $ascii .= '';
+ $ascii .= '';
+ $ascii .= sprintf("[$bar] %3.1f%% %-22s\n", $percent, $estimate);
+ $ascii .= sprintf("%-80s\n", $msg);
+ return cli_ansi_format($ascii);
+ }
+
+ // If we are not rendering to a tty, ie when piped to another command
+ // or on windows we need to progressively render the progress bar
+ // which can only ever go forwards.
+ $done = round($percent * $size * 0.01);
+ $delta = max(0, $done - $this->progressmaximums[$id]);
+
+ $ascii .= str_repeat('#', $delta);
+ if ($percent >= 100 && $delta > 0) {
+ $ascii .= sprintf("] %3.1f%%", $percent) . "\n$msg\n";
+ }
+ $this->progressmaximums[$id] += $delta;
+ return $ascii;
+ }
+
+ /**
+ * Returns a template fragment representing a Heading.
+ *
+ * @param string $text The text of the heading
+ * @param int $level The level of importance of the heading
+ * @param string $classes A space-separated list of CSS classes
+ * @param string $id An optional ID
+ * @return string A template fragment for a heading
+ */
+ public function heading($text, $level = 2, $classes = 'main', $id = null) {
+ $text .= "\n";
+ switch ($level) {
+ case 1:
+ return '=>' . $text;
+ case 2:
+ return '-->' . $text;
+ default:
+ return $text;
+ }
+ }
+
+ /**
+ * Returns a template fragment representing a fatal error.
+ *
+ * @param string $message The message to output
+ * @param string $moreinfourl URL where more info can be found about the error
+ * @param string $link Link for the Continue button
+ * @param array $backtrace The execution backtrace
+ * @param null|string $debuginfo Debugging information
+ * @param string $errorcode
+ * @return string A template fragment for a fatal error
+ */
+ public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
+ global $CFG;
+
+ $output = "!!! $message !!!\n";
+
+ if ($CFG->debugdeveloper) {
+ if (!empty($debuginfo)) {
+ $output .= $this->notification($debuginfo, 'notifytiny');
+ }
+ if (!empty($backtrace)) {
+ $output .= $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
+ }
+ }
+
+ return $output;
+ }
+
+ /**
+ * Returns a template fragment representing a notification.
+ *
+ * @param string $message The message to print out.
+ * @param string $type The type of notification. See constants on \core\output\notification.
+ * @param bool $closebutton Whether to show a close icon to remove the notification (default true).
+ * @return string A template fragment for a notification
+ */
+ public function notification($message, $type = null, $closebutton = true) {
+ $message = clean_text($message);
+ if ($type === 'notifysuccess' || $type === 'success') {
+ return "++ $message ++\n";
+ }
+ return "!! $message !!\n";
+ }
+
+ /**
+ * There is no footer for a cli request, however we must override the
+ * footer method to prevent the default footer.
+ */
+ public function footer() {
+ }
+
+ /**
+ * Render a notification (that is, a status message about something that has
+ * just happened).
+ *
+ * @param notification $notification the notification to print out
+ * @return string plain text output
+ */
+ public function render_notification(notification $notification) {
+ return $this->notification($notification->get_message(), $notification->get_message_type());
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(core_renderer_cli::class, \core_renderer_cli::class);
diff --git a/lib/classes/output/core_renderer_maintenance.php b/lib/classes/output/core_renderer_maintenance.php
new file mode 100644
index 0000000000000..50b4153cb95e6
--- /dev/null
+++ b/lib/classes/output/core_renderer_maintenance.php
@@ -0,0 +1,250 @@
+.
+
+namespace core\output;
+
+use core_block\output\block_contents;
+use core\exception\coding_exception;
+use moodle_page;
+use moodle_url;
+use stdClass;
+
+/**
+ * The maintenance renderer.
+ *
+ * The purpose of this renderer is to block out the core renderer methods that are not usable when the site
+ * is running a maintenance related task.
+ * It must always extend the core_renderer as we switch from the core_renderer to this renderer in a couple of places.
+ *
+ * @since Moodle 2.6
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_renderer_maintenance extends core_renderer {
+ /**
+ * Initialises the renderer instance.
+ *
+ * @param moodle_page $page
+ * @param string $target
+ * @throws coding_exception
+ */
+ public function __construct(moodle_page $page, $target) {
+ if ($target !== RENDERER_TARGET_MAINTENANCE || $page->pagelayout !== 'maintenance') {
+ throw new coding_exception('Invalid request for the maintenance renderer.');
+ }
+ parent::__construct($page, $target);
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce blocks.
+ *
+ * @param block_contents $bc
+ * @param string $region
+ * @return string
+ */
+ public function block(block_contents $bc, $region) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce blocks.
+ *
+ * @param string $region
+ * @param array $classes
+ * @param string $tag
+ * @param boolean $fakeblocksonly
+ * @return string
+ */
+ public function blocks($region, $classes = [], $tag = 'aside', $fakeblocksonly = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce blocks.
+ *
+ * @param string $region
+ * @param boolean $fakeblocksonly Output fake block only.
+ * @return string
+ */
+ public function blocks_for_region($region, $fakeblocksonly = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course content header.
+ *
+ * @param bool $onlyifnotcalledbefore
+ * @return string
+ */
+ public function course_content_header($onlyifnotcalledbefore = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course content footer.
+ *
+ * @param bool $onlyifnotcalledbefore
+ * @return string
+ */
+ public function course_content_footer($onlyifnotcalledbefore = false) {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course header.
+ *
+ * @return string
+ */
+ public function course_header() {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a course footer.
+ *
+ * @return string
+ */
+ public function course_footer() {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a custom menu.
+ *
+ * @param string $custommenuitems
+ * @return string
+ */
+ public function custom_menu($custommenuitems = '') {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce a file picker.
+ *
+ * @param array $options
+ * @return string
+ */
+ public function file_picker($options) {
+ return '';
+ }
+
+ /**
+ * Overridden confirm message for upgrades.
+ *
+ * @param string $message The question to ask the user
+ * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer.
+ * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer.
+ * @param array $displayoptions optional extra display options
+ * @return string HTML fragment
+ */
+ public function confirm($message, $continue, $cancel, array $displayoptions = []) {
+ // We need plain styling of confirm boxes on upgrade because we don't know which stylesheet we have (it could be
+ // from any previous version of Moodle).
+ if ($continue instanceof single_button) {
+ $continue->type = single_button::BUTTON_PRIMARY;
+ } else if (is_string($continue)) {
+ $continue = new single_button(
+ new moodle_url($continue),
+ get_string('continue'),
+ 'post',
+ $displayoptions['type'] ?? single_button::BUTTON_PRIMARY
+ );
+ } else if ($continue instanceof moodle_url) {
+ $continue = new single_button(
+ $continue,
+ get_string('continue'),
+ 'post',
+ $displayoptions['type'] ?? single_button::BUTTON_PRIMARY
+ );
+ } else {
+ throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL' .
+ ' (string/moodle_url) or a single_button instance.');
+ }
+
+ if ($cancel instanceof single_button) {
+ $output = '';
+ } else if (is_string($cancel)) {
+ $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
+ } else if ($cancel instanceof moodle_url) {
+ $cancel = new single_button($cancel, get_string('cancel'), 'get');
+ } else {
+ throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL' .
+ ' (string/moodle_url) or a single_button instance.');
+ }
+
+ $output = $this->box_start('generalbox', 'notice');
+ $output .= html_writer::tag('h4', get_string('confirm'));
+ $output .= html_writer::tag('p', $message);
+ $output .= html_writer::tag('div', $this->render($cancel) . $this->render($continue), ['class' => 'buttons']);
+ $output .= $this->box_end();
+ return $output;
+ }
+
+ /**
+ * Does nothing. The maintenance renderer does not support JS.
+ *
+ * @param block_contents $bc
+ */
+ public function init_block_hider_js(block_contents $bc) {
+ // Does nothing.
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce language menus.
+ *
+ * @return string
+ */
+ public function lang_menu() {
+ return '';
+ }
+
+ /**
+ * Does nothing. The maintenance renderer has no need for login information.
+ *
+ * @param mixed $withlinks
+ * @return string
+ */
+ public function login_info($withlinks = null) {
+ return '';
+ }
+
+ /**
+ * Secure login info.
+ *
+ * @return string
+ */
+ public function secure_login_info() {
+ return $this->login_info(false);
+ }
+
+ /**
+ * Does nothing. The maintenance renderer cannot produce user pictures.
+ *
+ * @param stdClass $user
+ * @param null|array $options
+ * @return string
+ */
+ public function user_picture(stdClass $user, ?array $options = null) {
+ return '';
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(core_renderer_maintenance::class, \core_renderer_maintenance::class);
diff --git a/lib/classes/output/custom_menu.php b/lib/classes/output/custom_menu.php
new file mode 100644
index 0000000000000..5357df2b78d03
--- /dev/null
+++ b/lib/classes/output/custom_menu.php
@@ -0,0 +1,188 @@
+.
+
+namespace core\output;
+
+use core\exception\moodle_exception;
+use moodle_url;
+
+/**
+ * Custom menu class
+ *
+ * This class is used to operate a custom menu that can be rendered for the page.
+ * The custom menu is built using $CFG->custommenuitems and is a structured collection
+ * of custom_menu_item nodes that can be rendered by the core renderer.
+ *
+ * To configure the custom menu:
+ * Settings: Administration > Appearance > Advanced theme settings
+ *
+ * @copyright 2010 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class custom_menu extends custom_menu_item {
+ /**
+ * @var string The language we should render for, null disables multilang support.
+ */
+ protected $currentlanguage = null;
+
+ /**
+ * Creates the custom menu
+ *
+ * @param string $definition the menu items definition in syntax required by {@see convert_text_to_menu_nodes()}
+ * @param string $currentlanguage the current language code, null disables multilang support
+ */
+ public function __construct($definition = '', $currentlanguage = null) {
+ $this->currentlanguage = $currentlanguage;
+ parent::__construct('root'); // create virtual root element of the menu
+ if (!empty($definition)) {
+ $this->override_children(self::convert_text_to_menu_nodes($definition, $currentlanguage));
+ }
+ }
+
+ /**
+ * Overrides the children of this custom menu. Useful when getting children
+ * from $CFG->custommenuitems
+ *
+ * @param array $children
+ */
+ public function override_children(array $children) {
+ $this->children = [];
+ foreach ($children as $child) {
+ if ($child instanceof custom_menu_item) {
+ $this->children[] = $child;
+ }
+ }
+ }
+
+ /**
+ * Converts a string into a structured array of custom_menu_items which can
+ * then be added to a custom menu.
+ *
+ * Structure:
+ * text|url|title|langs
+ * The number of hyphens at the start determines the depth of the item. The
+ * languages are optional, comma separated list of languages the line is for.
+ *
+ * Example structure:
+ * First level first item|http://www.moodle.com/
+ * -Second level first item|http://www.moodle.com/partners/
+ * -Second level second item|http://www.moodle.com/hq/
+ * --Third level first item|http://www.moodle.com/jobs/
+ * -Second level third item|http://www.moodle.com/development/
+ * First level second item|http://www.moodle.com/feedback/
+ * First level third item
+ * English only|http://moodle.com|English only item|en
+ * German only|http://moodle.de|Deutsch|de,de_du,de_kids
+ *
+ *
+ * @static
+ * @param string $text the menu items definition
+ * @param string $language the language code, null disables multilang support
+ * @return array
+ */
+ public static function convert_text_to_menu_nodes($text, $language = null) {
+ $root = new custom_menu();
+ $lastitem = $root;
+ $lastdepth = 0;
+ $hiddenitems = [];
+ $lines = explode("\n", $text);
+ foreach ($lines as $linenumber => $line) {
+ $line = trim($line);
+ if (strlen($line) == 0) {
+ continue;
+ }
+ // Parse item settings.
+ $itemtext = null;
+ $itemurl = null;
+ $itemtitle = null;
+ $itemvisible = true;
+ $settings = explode('|', $line);
+ foreach ($settings as $i => $setting) {
+ $setting = trim($setting);
+ if ($setting !== '') {
+ switch ($i) {
+ case 0: // Menu text.
+ $itemtext = ltrim($setting, '-');
+ break;
+ case 1: // URL.
+ try {
+ $itemurl = new moodle_url($setting);
+ } catch (moodle_exception $exception) {
+ // We're not actually worried about this, we don't want to mess up the display
+ // just for a wrongly entered URL.
+ $itemurl = null;
+ }
+ break;
+ case 2: // Title attribute.
+ $itemtitle = $setting;
+ break;
+ case 3: // Language.
+ if (!empty($language)) {
+ $itemlanguages = array_map('trim', explode(',', $setting));
+ $itemvisible &= in_array($language, $itemlanguages);
+ }
+ break;
+ }
+ }
+ }
+ // Get depth of new item.
+ preg_match('/^(\-*)/', $line, $match);
+ $itemdepth = strlen($match[1]) + 1;
+ // Find parent item for new item.
+ while (($lastdepth - $itemdepth) >= 0) {
+ $lastitem = $lastitem->get_parent();
+ $lastdepth--;
+ }
+ $lastitem = $lastitem->add($itemtext, $itemurl, $itemtitle, $linenumber + 1);
+ $lastdepth++;
+ if (!$itemvisible) {
+ $hiddenitems[] = $lastitem;
+ }
+ }
+ foreach ($hiddenitems as $item) {
+ $item->parent->remove_child($item);
+ }
+ return $root->get_children();
+ }
+
+ /**
+ * Sorts two custom menu items
+ *
+ * This function is designed to be used with the usort method
+ * usort($this->children, array('custom_menu','sort_custom_menu_items'));
+ *
+ * @static
+ * @param custom_menu_item $itema
+ * @param custom_menu_item $itemb
+ * @return int
+ */
+ public static function sort_custom_menu_items(custom_menu_item $itema, custom_menu_item $itemb) {
+ $itema = $itema->get_sort_order();
+ $itemb = $itemb->get_sort_order();
+ if ($itema == $itemb) {
+ return 0;
+ }
+ return ($itema > $itemb) ? +1 : -1;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(custom_menu::class, \custom_menu::class);
diff --git a/lib/classes/output/custom_menu_item.php b/lib/classes/output/custom_menu_item.php
new file mode 100644
index 0000000000000..c1e1a389530fc
--- /dev/null
+++ b/lib/classes/output/custom_menu_item.php
@@ -0,0 +1,272 @@
+.
+
+namespace core\output;
+
+use core\context\system as context_system;
+use moodle_url;
+use stdClass;
+
+/**
+ * Custom menu item
+ *
+ * This class is used to represent one item within a custom menu that may or may
+ * not have children.
+ *
+ * @copyright 2010 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class custom_menu_item implements renderable, templatable {
+ /**
+ * @var string The text to show for the item
+ */
+ protected $text;
+
+ /**
+ * @var string A title to apply to the item. By default the text
+ */
+ protected $title;
+
+ /**
+ * @var int A sort order for the item, not necessary if you order things in
+ * the CFG var.
+ */
+ protected $sort;
+
+ /**
+ * @var array A array in which to store children this item has.
+ */
+ protected $children = [];
+
+ /**
+ * @var int A reference to the sort var of the last child that was added
+ */
+ protected $lastsort = 0;
+
+ /**
+ * Constructs the new custom menu item
+ *
+ * @param string $text
+ * @param null|moodle_url $url A moodle url to apply as the link for this item [Optional]
+ * @param string $title A title to apply to this item [Optional]
+ * @param int $sort A sort or to use if we need to sort differently [Optional]
+ * @param null|custom_menu_item $parent A reference to the parent custom_menu_item this child
+ * belongs to, only if the child has a parent. [Optional]
+ * @param array $attributes Array of other HTML attributes for the custom menu item.
+ */
+ public function __construct(
+ $text,
+ /** @var moodle_url The link to give the icon if it has no children */
+ protected ?moodle_url $url = null,
+ $title = null,
+ $sort = null,
+ /**
+ * @var custom_menu_item A reference to the parent for this item or NULL if
+ * it is a top level item
+ */
+ protected ?custom_menu_item $parent = null,
+ /** @var array Array of other HTML attributes for the custom menu item. */
+ protected array $attributes = [],
+ ) {
+
+ // Use class setter method for text to ensure it's always a string type.
+ $this->set_text($text);
+
+ $this->title = $title;
+ $this->sort = (int)$sort;
+ }
+
+ /**
+ * Adds a custom menu item as a child of this node given its properties.
+ *
+ * @param string $text
+ * @param null|moodle_url $url
+ * @param string $title
+ * @param int $sort
+ * @param array $attributes Array of other HTML attributes for the custom menu item.
+ * @return custom_menu_item
+ */
+ public function add(
+ $text,
+ ?moodle_url $url = null,
+ $title = null,
+ $sort = null,
+ $attributes = [],
+ ) {
+ $key = count($this->children);
+ if (empty($sort)) {
+ $sort = $this->lastsort + 1;
+ }
+ $this->children[$key] = new custom_menu_item($text, $url, $title, $sort, $this, $attributes);
+ $this->lastsort = (int)$sort;
+ return $this->children[$key];
+ }
+
+ /**
+ * Removes a custom menu item that is a child or descendant to the current menu.
+ *
+ * Returns true if child was found and removed.
+ *
+ * @param custom_menu_item $menuitem
+ * @return bool
+ */
+ public function remove_child(custom_menu_item $menuitem) {
+ $removed = false;
+ if (($key = array_search($menuitem, $this->children)) !== false) {
+ unset($this->children[$key]);
+ $this->children = array_values($this->children);
+ $removed = true;
+ } else {
+ foreach ($this->children as $child) {
+ if ($removed = $child->remove_child($menuitem)) {
+ break;
+ }
+ }
+ }
+ return $removed;
+ }
+
+ /**
+ * Returns the text for this item
+ * @return string
+ */
+ public function get_text() {
+ return $this->text;
+ }
+
+ /**
+ * Returns the url for this item
+ * @return moodle_url
+ */
+ public function get_url() {
+ return $this->url;
+ }
+
+ /**
+ * Returns the title for this item
+ * @return string
+ */
+ public function get_title() {
+ return $this->title;
+ }
+
+ /**
+ * Sorts and returns the children for this item
+ * @return array
+ */
+ public function get_children() {
+ $this->sort();
+ return $this->children;
+ }
+
+ /**
+ * Gets the sort order for this child
+ * @return int
+ */
+ public function get_sort_order() {
+ return $this->sort;
+ }
+
+ /**
+ * Gets the parent this child belong to
+ * @return custom_menu_item
+ */
+ public function get_parent() {
+ return $this->parent;
+ }
+
+ /**
+ * Sorts the children this item has
+ */
+ public function sort() {
+ usort($this->children, ['custom_menu', 'sort_custom_menu_items']);
+ }
+
+ /**
+ * Returns true if this item has any children
+ * @return bool
+ */
+ public function has_children() {
+ return (count($this->children) > 0);
+ }
+
+ /**
+ * Sets the text for the node
+ * @param string $text
+ */
+ public function set_text($text) {
+ $this->text = (string)$text;
+ }
+
+ /**
+ * Sets the title for the node
+ * @param string $title
+ */
+ public function set_title($title) {
+ $this->title = (string)$title;
+ }
+
+ /**
+ * Sets the url for the node
+ * @param moodle_url $url
+ */
+ public function set_url(moodle_url $url) {
+ $this->url = $url;
+ }
+
+ /**
+ * Export this data so it can be used as the context for a mustache template.
+ *
+ * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $syscontext = context_system::instance();
+
+ $context = new stdClass();
+ $context->moremenuid = uniqid();
+ $context->text = \core_external\util::format_string($this->text, $syscontext->id);
+ $context->url = $this->url ? $this->url->out() : null;
+ // No need for the title if it's the same with text.
+ if ($this->text !== $this->title) {
+ // Show the title attribute only if it's different from the text.
+ $context->title = \core_external\util::format_string($this->title, $syscontext->id);
+ }
+ $context->sort = $this->sort;
+ if (!empty($this->attributes)) {
+ $context->attributes = $this->attributes;
+ }
+ $context->children = [];
+ if (preg_match("/^#+$/", $this->text)) {
+ $context->divider = true;
+ }
+ $context->haschildren = !empty($this->children) && (count($this->children) > 0);
+ foreach ($this->children as $child) {
+ $child = $child->export_for_template($output);
+ array_push($context->children, $child);
+ }
+
+ return $context;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(custom_menu_item::class, \custom_menu_item::class);
diff --git a/lib/classes/output/datafilter.php b/lib/classes/output/datafilter.php
index ea28136d45ba1..e8cef3acf2dfe 100644
--- a/lib/classes/output/datafilter.php
+++ b/lib/classes/output/datafilter.php
@@ -16,10 +16,8 @@
namespace core\output;
-use context;
-use renderable;
+use core\context;
use stdClass;
-use templatable;
/**
* The filter renderable class.
@@ -30,7 +28,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class datafilter implements renderable, templatable {
-
/** @var int None of the following match */
public const JOINTYPE_NONE = 0;
@@ -110,7 +107,7 @@ protected function get_filter_object(
'values' => $values,
'filteroptions' => $filteroptions,
'required' => $required,
- 'joinlist' => json_encode($joinlist)
+ 'joinlist' => json_encode($joinlist),
];
}
}
diff --git a/lib/classes/output/dynamic_tabs.php b/lib/classes/output/dynamic_tabs.php
index c2592bb8134d4..c739934b0d190 100644
--- a/lib/classes/output/dynamic_tabs.php
+++ b/lib/classes/output/dynamic_tabs.php
@@ -19,8 +19,6 @@
namespace core\output;
use core\output\dynamic_tabs\base;
-use renderer_base;
-use templatable;
/**
* Class dynamic tabs
@@ -30,7 +28,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class dynamic_tabs implements templatable {
-
/** @var base[] */
protected $tabs = [];
@@ -62,7 +59,7 @@ public function add_tab(base $tab): void {
*/
public function export_for_template(renderer_base $output): array {
$data = [
- 'tabs' => []
+ 'tabs' => [],
];
foreach ($this->tabs as $tab) {
diff --git a/lib/classes/output/dynamic_tabs/base.php b/lib/classes/output/dynamic_tabs/base.php
index 2396ee645ec3b..213148be34bb0 100644
--- a/lib/classes/output/dynamic_tabs/base.php
+++ b/lib/classes/output/dynamic_tabs/base.php
@@ -18,8 +18,8 @@
namespace core\output\dynamic_tabs;
-use moodle_exception;
-use templatable;
+use core\exception\moodle_exception;
+use core\output\templatable;
/**
* Class tab_base
@@ -29,7 +29,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class base implements templatable {
-
/** @var array */
protected $data;
diff --git a/lib/classes/output/external.php b/lib/classes/output/external.php
index b9c24e049c3c2..181faf9d6caa1 100644
--- a/lib/classes/output/external.php
+++ b/lib/classes/output/external.php
@@ -39,13 +39,12 @@ class external extends external_api {
* @return external_function_parameters
*/
public static function load_template_parameters() {
- return new external_function_parameters(
- array('component' => new external_value(PARAM_COMPONENT, 'component containing the template'),
- 'template' => new external_value(PARAM_SAFEPATH, 'name of the template'),
- 'themename' => new external_value(PARAM_ALPHANUMEXT, 'The current theme.'),
- 'includecomments' => new external_value(PARAM_BOOL, 'Include comments or not', VALUE_DEFAULT, false)
- )
- );
+ return new external_function_parameters([
+ 'component' => new external_value(PARAM_COMPONENT, 'component containing the template'),
+ 'template' => new external_value(PARAM_SAFEPATH, 'name of the template'),
+ 'themename' => new external_value(PARAM_ALPHANUMEXT, 'The current theme.'),
+ 'includecomments' => new external_value(PARAM_BOOL, 'Include comments or not', VALUE_DEFAULT, false),
+ ]);
}
/**
@@ -60,11 +59,15 @@ public static function load_template($component, $template, $themename, $include
global $DB, $CFG, $PAGE;
$PAGE->set_context(context_system::instance());
- $params = self::validate_parameters(self::load_template_parameters(),
- array('component' => $component,
- 'template' => $template,
- 'themename' => $themename,
- 'includecomments' => $includecomments));
+ $params = self::validate_parameters(
+ self::load_template_parameters(),
+ [
+ 'component' => $component,
+ 'template' => $template,
+ 'themename' => $themename,
+ 'includecomments' => $includecomments,
+ ],
+ );
$loader = new mustache_template_source_loader();
// Will throw exceptions if the template does not exist.
@@ -72,7 +75,7 @@ public static function load_template($component, $template, $themename, $include
$params['component'],
$params['template'],
$params['themename'],
- $params['includecomments']
+ $params['includecomments'],
);
}
@@ -108,7 +111,7 @@ public static function load_template_with_dependencies_parameters() {
* @param string $themename The name of the current theme.
* @param bool $includecomments Whether to strip comments from the template source.
* @param string $lang moodle translation language, null means use current.
- * @return string the template
+ * @return array the template
*/
public static function load_template_with_dependencies(
string $component,
@@ -126,7 +129,7 @@ public static function load_template_with_dependencies(
'template' => $template,
'themename' => $themename,
'includecomments' => $includecomments,
- 'lang' => $lang
+ 'lang' => $lang,
]
);
@@ -141,14 +144,14 @@ public static function load_template_with_dependencies(
[],
$params['lang']
);
- $formatdependencies = function($dependency) {
+ $formatdependencies = function ($dependency) {
$results = [];
foreach ($dependency as $dependencycomponent => $dependencyvalues) {
foreach ($dependencyvalues as $dependencyname => $dependencyvalue) {
array_push($results, [
'component' => $dependencycomponent,
'name' => $dependencyname,
- 'value' => $dependencyvalue
+ 'value' => $dependencyvalue,
]);
}
}
@@ -159,7 +162,7 @@ public static function load_template_with_dependencies(
// by external functions (because they don't support dynamic keys).
return [
'templates' => $formatdependencies($dependencies['templates']),
- 'strings' => $formatdependencies($dependencies['strings'])
+ 'strings' => $formatdependencies($dependencies['strings']),
];
}
@@ -172,12 +175,12 @@ public static function load_template_with_dependencies_returns() {
$resourcestructure = new external_single_structure([
'component' => new external_value(PARAM_COMPONENT, 'component containing the resource'),
'name' => new external_value(PARAM_TEXT, 'name of the resource'),
- 'value' => new external_value(PARAM_RAW, 'resource value')
+ 'value' => new external_value(PARAM_RAW, 'resource value'),
]);
return new external_single_structure([
'templates' => new external_multiple_structure($resourcestructure),
- 'strings' => new external_multiple_structure($resourcestructure)
+ 'strings' => new external_multiple_structure($resourcestructure),
]);
}
diff --git a/lib/classes/output/file_picker.php b/lib/classes/output/file_picker.php
new file mode 100644
index 0000000000000..2a3bdd3e0d3c6
--- /dev/null
+++ b/lib/classes/output/file_picker.php
@@ -0,0 +1,107 @@
+.
+
+namespace core\output;
+
+use core\context\user as context_user;
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure representing a file picker.
+ *
+ * @copyright 2010 Dongsheng Cai
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class file_picker implements renderable {
+ /**
+ * @var stdClass An object containing options for the file picker
+ */
+ public $options;
+
+ /**
+ * Constructs a file picker object.
+ *
+ * The following are possible options for the filepicker:
+ * - accepted_types (*)
+ * - return_types (FILE_INTERNAL)
+ * - env (filepicker)
+ * - client_id (uniqid)
+ * - itemid (0)
+ * - maxbytes (-1)
+ * - maxfiles (1)
+ * - buttonname (false)
+ *
+ * @param stdClass $options An object containing options for the file picker.
+ */
+ public function __construct(stdClass $options) {
+ global $CFG, $USER, $PAGE;
+ require_once($CFG->dirroot . '/repository/lib.php');
+ $defaults = [
+ 'accepted_types' => '*',
+ 'return_types' => FILE_INTERNAL,
+ 'env' => 'filepicker',
+ 'client_id' => uniqid(),
+ 'itemid' => 0,
+ 'maxbytes' => -1,
+ 'maxfiles' => 1,
+ 'buttonname' => false,
+ ];
+ foreach ($defaults as $key => $value) {
+ if (empty($options->$key)) {
+ $options->$key = $value;
+ }
+ }
+
+ $options->currentfile = '';
+ if (!empty($options->itemid)) {
+ $fs = get_file_storage();
+ $usercontext = context_user::instance($USER->id);
+ if (empty($options->filename)) {
+ if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $options->itemid, 'id DESC', false)) {
+ $file = reset($files);
+ }
+ } else {
+ $file = $fs->get_file($usercontext->id, 'user', 'draft', $options->itemid, $options->filepath, $options->filename);
+ }
+ if (!empty($file)) {
+ $options->currentfile = html_writer::link(moodle_url::make_draftfile_url(
+ $file->get_itemid(),
+ $file->get_filepath(),
+ $file->get_filename(),
+ ), $file->get_filename());
+ }
+ }
+
+ // Initialise options, getting files in root path.
+ $this->options = initialise_filepicker($options);
+
+ // Copying other options.
+ foreach ($options as $name => $value) {
+ if (!isset($this->options->$name)) {
+ $this->options->$name = $value;
+ }
+ }
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(file_picker::class, \file_picker::class);
diff --git a/lib/classes/output/help_icon.php b/lib/classes/output/help_icon.php
new file mode 100644
index 0000000000000..91edfc91c83d6
--- /dev/null
+++ b/lib/classes/output/help_icon.php
@@ -0,0 +1,127 @@
+.
+
+namespace core\output;
+
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure representing a help icon.
+ *
+ * @copyright 2010 Petr Skoda (info@skodak.org)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class help_icon implements renderable, templatable {
+ /**
+ * @var string lang pack identifier (without the "_help" suffix),
+ * both get_string($identifier, $component) and get_string($identifier.'_help', $component)
+ * must exist.
+ */
+ public $identifier;
+
+ /**
+ * @var string Component name, the same as in get_string()
+ */
+ public $component;
+
+ /**
+ * @var string Extra descriptive text next to the icon
+ */
+ public $linktext = null;
+
+ /**
+ * @var mixed An object, string or number that can be used within translation strings
+ */
+ public $a = null;
+
+ /**
+ * Constructor
+ *
+ * @param string $identifier string for help page title,
+ * string with _help suffix is used for the actual help text.
+ * string with _link suffix is used to create a link to further info (if it exists)
+ * @param string $component
+ * @param string|object|array|int $a An object, string or number that can be used
+ * within translation strings
+ */
+ public function __construct($identifier, $component, $a = null) {
+ $this->identifier = $identifier;
+ $this->component = $component;
+ $this->a = $a;
+ }
+
+ /**
+ * Verifies that both help strings exists, shows debug warnings if not
+ */
+ public function diag_strings() {
+ $sm = get_string_manager();
+ if (!$sm->string_exists($this->identifier, $this->component)) {
+ debugging("Help title string does not exist: [$this->identifier, $this->component]");
+ }
+ if (!$sm->string_exists($this->identifier . '_help', $this->component)) {
+ debugging("Help contents string does not exist: [{$this->identifier}_help, $this->component]");
+ }
+ }
+
+ /**
+ * Export this data so it can be used as the context for a mustache template.
+ *
+ * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ global $CFG;
+
+ $title = get_string($this->identifier, $this->component, $this->a);
+
+ if (empty($this->linktext)) {
+ $alt = get_string('helpprefix2', '', trim($title, ". \t"));
+ } else {
+ $alt = get_string('helpwiththis');
+ }
+
+ $data = get_formatted_help_string($this->identifier, $this->component, false, $this->a);
+
+ $data->alt = $alt;
+ $data->icon = (new pix_icon('help', $alt, 'core'))->export_for_template($output);
+ $data->linktext = $this->linktext;
+ $data->title = get_string('helpprefix2', '', trim($title, ". \t"));
+
+ $options = [
+ 'component' => $this->component,
+ 'identifier' => $this->identifier,
+ 'lang' => current_language(),
+ ];
+
+ // Debugging feature lets you display string identifier and component.
+ if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
+ $options['strings'] = 1;
+ }
+
+ $data->url = (new moodle_url('/help.php', $options))->out(false);
+ $data->ltr = !right_to_left();
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(help_icon::class, \help_icon::class);
diff --git a/lib/classes/output/html_writer.php b/lib/classes/output/html_writer.php
new file mode 100644
index 0000000000000..f9331da60387e
--- /dev/null
+++ b/lib/classes/output/html_writer.php
@@ -0,0 +1,891 @@
+.
+
+namespace core\output;
+
+use core\exception\coding_exception;
+use core_table\output\html_table;
+use core_table\output\html_table_cell;
+use core_table\output\html_table_row;
+use core_text;
+use moodle_url;
+
+/**
+ * Simple html output class
+ *
+ * @copyright 2009 Tim Hunt, 2010 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class html_writer {
+ /**
+ * Outputs a tag with attributes and contents
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @param string $contents What goes between the opening and closing tags
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function tag($tagname, $contents, ?array $attributes = null) {
+ return self::start_tag($tagname, $attributes) . $contents . self::end_tag($tagname);
+ }
+
+ /**
+ * Outputs an opening tag with attributes
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function start_tag($tagname, ?array $attributes = null) {
+ return '<' . $tagname . self::attributes($attributes) . '>';
+ }
+
+ /**
+ * Outputs a closing tag
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @return string HTML fragment
+ */
+ public static function end_tag($tagname) {
+ return '';
+ }
+
+ /**
+ * Outputs an empty tag with attributes
+ *
+ * @param string $tagname The name of tag ('input', 'img', 'br' etc.)
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function empty_tag($tagname, ?array $attributes = null) {
+ return '<' . $tagname . self::attributes($attributes) . ' />';
+ }
+
+ /**
+ * Outputs a tag, but only if the contents are not empty
+ *
+ * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
+ * @param string $contents What goes between the opening and closing tags
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function nonempty_tag($tagname, $contents, ?array $attributes = null) {
+ if ($contents === '' || is_null($contents)) {
+ return '';
+ }
+ return self::tag($tagname, $contents, $attributes);
+ }
+
+ /**
+ * Outputs a HTML attribute and value
+ *
+ * @param string $name The name of the attribute ('src', 'href', 'class' etc.)
+ * @param string $value The value of the attribute. The value will be escaped with {@see s()}
+ * @return string HTML fragment
+ */
+ public static function attribute($name, $value) {
+ if ($value instanceof moodle_url) {
+ return ' ' . $name . '="' . $value->out() . '"';
+ }
+
+ // Special case, we do not want these in output.
+ if ($value === null) {
+ return '';
+ }
+
+ // No sloppy trimming here!
+ return ' ' . $name . '="' . s($value) . '"';
+ }
+
+ /**
+ * Outputs a list of HTML attributes and values
+ *
+ * @param null|array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
+ * The values will be escaped with {@see s()}
+ * @return string HTML fragment
+ */
+ public static function attributes(?array $attributes = null) {
+ $attributes = (array)$attributes;
+ $output = '';
+ foreach ($attributes as $name => $value) {
+ $output .= self::attribute($name, $value);
+ }
+ return $output;
+ }
+
+ /**
+ * Generates a simple image tag with attributes.
+ *
+ * @param string $src The source of image
+ * @param string $alt The alternate text for image
+ * @param null|array $attributes The tag attributes (array('height' => $max_height, 'class' => 'class1') etc.)
+ * @return string HTML fragment
+ */
+ public static function img($src, $alt, ?array $attributes = null) {
+ $attributes = (array)$attributes;
+ $attributes['src'] = $src;
+ // In case a null alt text is provided, set it to an empty string.
+ $attributes['alt'] = $alt ?? '';
+ if (array_key_exists('role', $attributes) && core_text::strtolower($attributes['role']) === 'presentation') {
+ // A presentation role is not necessary for the img tag.
+ // If a non-empty alt text is provided, the presentation role will conflict with the alt text.
+ // An empty alt text denotes a decorative image. The presence of a presentation role is redundant.
+ unset($attributes['role']);
+ debugging('The presentation role is not necessary for an img tag.', DEBUG_DEVELOPER);
+ }
+
+ return self::empty_tag('img', $attributes);
+ }
+
+ /**
+ * Generates random html element id.
+ *
+ * @staticvar int $counter
+ * @staticvar string $uniq
+ * @param string $base A string fragment that will be included in the random ID.
+ * @return string A unique ID
+ */
+ public static function random_id($base = 'random') {
+ static $counter = 0;
+ static $uniq;
+
+ if (!isset($uniq)) {
+ $uniq = uniqid();
+ }
+
+ $counter++;
+ return $base . $uniq . $counter;
+ }
+
+ /**
+ * Generates a simple html link
+ *
+ * @param string|moodle_url $url The URL
+ * @param string $text The text
+ * @param null|array $attributes HTML attributes
+ * @return string HTML fragment
+ */
+ public static function link($url, $text, ?array $attributes = null) {
+ $attributes = (array)$attributes;
+ $attributes['href'] = $url;
+ return self::tag('a', $text, $attributes);
+ }
+
+ /**
+ * Generates a simple checkbox with optional label
+ *
+ * @param string $name The name of the checkbox
+ * @param string $value The value of the checkbox
+ * @param bool $checked Whether the checkbox is checked
+ * @param string $label The label for the checkbox
+ * @param null|array $attributes Any attributes to apply to the checkbox
+ * @param null|array $labelattributes Any attributes to apply to the label, if present
+ * @return string html fragment
+ */
+ public static function checkbox(
+ $name,
+ $value,
+ $checked = true,
+ $label = '',
+ ?array $attributes = null,
+ ?array $labelattributes = null,
+ ) {
+ $attributes = (array) $attributes;
+ $output = '';
+
+ if ($label !== '' && !is_null($label)) {
+ if (empty($attributes['id'])) {
+ $attributes['id'] = self::random_id('checkbox_');
+ }
+ }
+ $attributes['type'] = 'checkbox';
+ $attributes['value'] = $value;
+ $attributes['name'] = $name;
+ $attributes['checked'] = $checked ? 'checked' : null;
+
+ $output .= self::empty_tag('input', $attributes);
+
+ if ($label !== '' && !is_null($label)) {
+ $labelattributes = (array) $labelattributes;
+ $labelattributes['for'] = $attributes['id'];
+ $output .= self::tag('label', $label, $labelattributes);
+ }
+
+ return $output;
+ }
+
+ /**
+ * Generates a simple select yes/no form field
+ *
+ * @param string $name name of select element
+ * @param bool $selected
+ * @param null|array $attributes - html select element attributes
+ * @return string HTML fragment
+ */
+ public static function select_yes_no($name, $selected = true, ?array $attributes = null) {
+ $options = ['1' => get_string('yes'), '0' => get_string('no')];
+ return self::select($options, $name, $selected, null, $attributes);
+ }
+
+ /**
+ * Generates a simple select form field
+ *
+ * Note this function does HTML escaping on the optgroup labels, but not on the choice labels.
+ *
+ * @param array $options associative array value=>label ex.:
+ * array(1=>'One, 2=>Two)
+ * it is also possible to specify optgroup as complex label array ex.:
+ * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
+ * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
+ * @param string $name name of select element
+ * @param string|array $selected value or array of values depending on multiple attribute
+ * @param array|bool|null $nothing add nothing selected option, or false of not added
+ * @param null|array $attributes html select element attributes
+ * @return string HTML fragment
+ */
+ public static function select(
+ array $options,
+ $name,
+ $selected = '',
+ $nothing = ['' => 'choosedots'],
+ ?array $attributes = null,
+ ) {
+ $attributes = (array)$attributes;
+ if (is_array($nothing)) {
+ foreach ($nothing as $k => $v) {
+ if ($v === 'choose' || $v === 'choosedots') {
+ $nothing[$k] = get_string('choosedots');
+ }
+ }
+ $options = $nothing + $options; // Keep keys, do not override.
+ } else if (is_string($nothing) && $nothing !== '') {
+ // BC.
+ $options = ['' => $nothing] + $options;
+ }
+
+ // We may accept more values if multiple attribute specified.
+ $selected = (array)$selected;
+ foreach ($selected as $k => $v) {
+ $selected[$k] = (string)$v;
+ }
+
+ if (!isset($attributes['id'])) {
+ $id = 'menu' . $name;
+ // Name may contain [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading.
+ $id = str_replace('[', '', $id);
+ $id = str_replace(']', '', $id);
+ $attributes['id'] = $id;
+ }
+
+ if (!isset($attributes['class'])) {
+ $class = 'menu' . $name;
+ // Name may contain [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading.
+ $class = str_replace('[', '', $class);
+ $class = str_replace(']', '', $class);
+ $attributes['class'] = $class;
+ }
+ $attributes['class'] = 'select custom-select ' . $attributes['class']; // Add 'select' selector always.
+
+ $attributes['name'] = $name;
+
+ if (!empty($attributes['disabled'])) {
+ $attributes['disabled'] = 'disabled';
+ } else {
+ unset($attributes['disabled']);
+ }
+
+ $output = '';
+ foreach ($options as $value => $label) {
+ if (is_array($label)) {
+ // Ignore key, it just has to be unique.
+ $output .= self::select_optgroup(key($label), current($label), $selected);
+ } else {
+ $output .= self::select_option($label, $value, $selected);
+ }
+ }
+ return self::tag('select', $output, $attributes);
+ }
+
+ /**
+ * Returns HTML to display a select box option.
+ *
+ * @param string $label The label to display as the option.
+ * @param string|int $value The value the option represents
+ * @param array $selected An array of selected options
+ * @return string HTML fragment
+ */
+ private static function select_option($label, $value, array $selected) {
+ $attributes = [];
+ $value = (string)$value;
+ if (in_array($value, $selected, true)) {
+ $attributes['selected'] = 'selected';
+ }
+ $attributes['value'] = $value;
+ return self::tag('option', $label, $attributes);
+ }
+
+ /**
+ * Returns HTML to display a select box option group.
+ *
+ * @param string $groupname The label to use for the group
+ * @param array $options The options in the group
+ * @param array $selected An array of selected values.
+ * @return string HTML fragment.
+ */
+ private static function select_optgroup($groupname, $options, array $selected) {
+ if (empty($options)) {
+ return '';
+ }
+ $attributes = ['label' => $groupname];
+ $output = '';
+ foreach ($options as $value => $label) {
+ $output .= self::select_option($label, $value, $selected);
+ }
+ return self::tag('optgroup', $output, $attributes);
+ }
+
+ /**
+ * This is a shortcut for making an hour selector menu.
+ *
+ * @param string $type The type of selector (years, months, days, hours, minutes)
+ * @param string $name fieldname
+ * @param int $currenttime A default timestamp in GMT
+ * @param int $step minute spacing
+ * @param null|array $attributes - html select element attributes
+ * @param float|int|string $timezone the timezone to use to calculate the time
+ * {@link https://moodledev.io/docs/apis/subsystems/time#timezone}
+ * @return string HTML fragment
+ */
+ public static function select_time($type, $name, $currenttime = 0, $step = 5, ?array $attributes = null, $timezone = 99) {
+ global $OUTPUT;
+
+ if (!$currenttime) {
+ $currenttime = time();
+ }
+ $calendartype = \core_calendar\type_factory::get_calendar_instance();
+ $currentdate = $calendartype->timestamp_to_date_array($currenttime, $timezone);
+
+ $userdatetype = $type;
+ $timeunits = [];
+
+ switch ($type) {
+ case 'years':
+ $timeunits = $calendartype->get_years();
+ $userdatetype = 'year';
+ break;
+ case 'months':
+ $timeunits = $calendartype->get_months();
+ $userdatetype = 'month';
+ $currentdate['month'] = (int)$currentdate['mon'];
+ break;
+ case 'days':
+ $timeunits = $calendartype->get_days();
+ $userdatetype = 'mday';
+ break;
+ case 'hours':
+ for ($i = 0; $i <= 23; $i++) {
+ $timeunits[$i] = sprintf("%02d", $i);
+ }
+ break;
+ case 'minutes':
+ if ($step != 1) {
+ $currentdate['minutes'] = ceil($currentdate['minutes'] / $step) * $step;
+ }
+
+ for ($i = 0; $i <= 59; $i += $step) {
+ $timeunits[$i] = sprintf("%02d", $i);
+ }
+ break;
+ default:
+ throw new coding_exception("Time type $type is not supported by html_writer::select_time().");
+ }
+
+ $attributes = (array) $attributes;
+ $data = (object) [
+ 'name' => $name,
+ 'id' => !empty($attributes['id']) ? $attributes['id'] : self::random_id('ts_'),
+ 'label' => get_string(substr($type, 0, -1), 'form'),
+ 'options' => array_map(function ($value) use ($timeunits, $currentdate, $userdatetype) {
+ return [
+ 'name' => $timeunits[$value],
+ 'value' => $value,
+ 'selected' => $currentdate[$userdatetype] == $value,
+ ];
+ }, array_keys($timeunits)),
+ ];
+
+ unset($attributes['id']);
+ unset($attributes['name']);
+ $data->attributes = array_map(function ($name) use ($attributes) {
+ return [
+ 'name' => $name,
+ 'value' => $attributes[$name],
+ ];
+ }, array_keys($attributes));
+
+ return $OUTPUT->render_from_template('core/select_time', $data);
+ }
+
+ /**
+ * Shortcut for quick making of lists
+ *
+ * Note: 'list' is a reserved keyword ;-)
+ *
+ * @param array $items
+ * @param null|array $attributes
+ * @param string $tag ul or ol
+ * @return string
+ */
+ public static function alist(array $items, ?array $attributes = null, $tag = 'ul') {
+ $output = self::start_tag($tag, $attributes) . "\n";
+ foreach ($items as $item) {
+ $output .= self::tag('li', $item) . "\n";
+ }
+ $output .= self::end_tag($tag);
+ return $output;
+ }
+
+ /**
+ * Returns hidden input fields created from url parameters.
+ *
+ * @param moodle_url $url
+ * @param null|array $exclude list of excluded parameters
+ * @return string HTML fragment
+ */
+ public static function input_hidden_params(moodle_url $url, ?array $exclude = null) {
+ $exclude = (array)$exclude;
+ $params = $url->params();
+ foreach ($exclude as $key) {
+ unset($params[$key]);
+ }
+
+ $output = '';
+ foreach ($params as $key => $value) {
+ $attributes = ['type' => 'hidden', 'name' => $key, 'value' => $value];
+ $output .= self::empty_tag('input', $attributes) . "\n";
+ }
+ return $output;
+ }
+
+ /**
+ * Generate a script tag containing the the specified code.
+ *
+ * @param string $jscode the JavaScript code
+ * @param moodle_url|string $url optional url of the external script, $code ignored if specified
+ * @return string HTML, the code wrapped in ';
+ } else {
+ $code = '';
+ foreach ($baserollups as $rollup) {
+ $code .= '';
+ }
+ return $code;
+ }
+ }
+
+ /**
+ * Returns html tags needed for inclusion of theme CSS.
+ *
+ * @return string
+ */
+ protected function get_css_code() {
+ // First of all the theme CSS, then any custom CSS
+ // Please note custom CSS is strongly discouraged,
+ // because it can not be overridden by themes!
+ // It is suitable only for things like mod/data which accepts CSS from teachers.
+ $attributes = ['rel' => 'stylesheet', 'type' => 'text/css'];
+
+ // Add the YUI code first. We want this to be overridden by any Moodle CSS.
+ $code = $this->get_yui3lib_headcss();
+
+ // This line of code may look funny but it is currently required in order
+ // to avoid MASSIVE display issues in Internet Explorer.
+ // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
+ // ignored whenever another resource is added until such time as a redraw
+ // is forced, usually by moving the mouse over the affected element.
+ $code .= html_writer::tag(
+ 'script',
+ '/** Required in order to fix style inclusion problems in IE with YUI **/',
+ ['id' => 'firstthemesheet', 'type' => 'text/css'],
+ );
+
+ $urls = $this->cssthemeurls + $this->cssurls;
+ foreach ($urls as $url) {
+ $attributes['href'] = $url;
+ $code .= html_writer::empty_tag('link', $attributes) . "\n";
+ // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly.
+ unset($attributes['id']);
+ }
+
+ return $code;
+ }
+
+ /**
+ * Adds extra modules specified after printing of page header.
+ *
+ * @return string
+ */
+ protected function get_extra_modules_code() {
+ if (empty($this->extramodules)) {
+ return '';
+ }
+ return html_writer::script(js_writer::function_call('M.yui.add_module', [$this->extramodules]));
+ }
+
+ /**
+ * Generate any HTML that needs to go inside the tag.
+ *
+ * Normally, this method is called automatically by the code that prints the
+ * tag. You should not normally need to call it in your own code.
+ *
+ * @param moodle_page $page
+ * @param core_renderer $renderer
+ * @return string the HTML code to to inside the tag.
+ */
+ public function get_head_code(moodle_page $page, core_renderer $renderer) {
+ global $CFG;
+
+ // Note: the $page and $output are not stored here because it would
+ // create circular references in memory which prevents garbage collection.
+ $this->init_requirements_data($page, $renderer);
+
+ $output = '';
+
+ // Add all standard CSS for this page.
+ $output .= $this->get_css_code();
+
+ // Set up the M namespace.
+ $js = "var M = {}; M.yui = {};\n";
+
+ // Capture the time now ASAP during page load. This minimises the lag when
+ // we try to relate times on the server to times in the browser.
+ // An example of where this is used is the quiz countdown timer.
+ $js .= "M.pageloadstarttime = new Date();\n";
+
+ // Add a subset of Moodle configuration to the M namespace.
+ $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
+
+ // Set up global YUI3 loader object - this should contain all code needed by plugins.
+ // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });",
+ // this needs to be done before including any other script.
+ $js .= $this->YUI_config->get_config_functions();
+ $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n";
+ $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more.
+ $js = $this->YUI_config->update_header_js($js);
+
+ $output .= html_writer::script($js);
+
+ // Add variables.
+ if ($this->jsinitvariables['head']) {
+ $js = '';
+ foreach ($this->jsinitvariables['head'] as $data) {
+ [$var, $value] = $data;
+ $js .= js_writer::set_variable($var, $value, true);
+ }
+ $output .= html_writer::script($js);
+ }
+
+ // Mark head sending done, it is not possible to anything there.
+ $this->headdone = true;
+
+ return $output;
+ }
+
+ /**
+ * Generate any HTML that needs to go at the start of the tag.
+ *
+ * Normally, this method is called automatically by the code that prints the
+ * tag. You should not normally need to call it in your own code.
+ *
+ * @param renderer_base $renderer
+ * @return string the HTML code to go at the start of the tag.
+ */
+ public function get_top_of_body_code(renderer_base $renderer) {
+ global $CFG;
+
+ // First the skip links.
+ $output = $renderer->render_skip_links($this->skiplinks);
+
+ // Include the Polyfills.
+ $output .= html_writer::script('', $this->js_fix_url('/lib/polyfills/polyfill.js'));
+
+ // YUI3 JS needs to be loaded early in the body. It should be cached well by the browser.
+ $output .= $this->get_yui3lib_headcode();
+
+ // Add hacked jQuery support, it is not intended for standard Moodle distribution!
+ $output .= $this->get_jquery_headcode();
+
+ // Link our main JS file, all core stuff should be there.
+ $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js'));
+
+ // All the other linked things from HEAD - there should be as few as possible.
+ if ($this->jsincludes['head']) {
+ foreach ($this->jsincludes['head'] as $url) {
+ $output .= html_writer::script('', $url);
+ }
+ }
+
+ // Then the clever trick for hiding of things not needed when JS works.
+ $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
+ $this->topofbodydone = true;
+ return $output;
+ }
+
+ /**
+ * Generate any HTML that needs to go at the end of the page.
+ *
+ * Normally, this method is called automatically by the code that prints the
+ * page footer. You should not normally need to call it in your own code.
+ *
+ * @return string the HTML code to to at the end of the page.
+ */
+ public function get_end_code() {
+ global $CFG;
+ $output = '';
+
+ // Set the log level for the JS logging.
+ $logconfig = new stdClass();
+ $logconfig->level = 'warn';
+ if ($CFG->debugdeveloper) {
+ $logconfig->level = 'trace';
+ }
+ $this->js_call_amd('core/log', 'setConfig', [$logconfig]);
+ // Add any global JS that needs to run on all pages.
+ $this->js_call_amd('core/page_global', 'init');
+ $this->js_call_amd('core/utility');
+
+ // Call amd init functions.
+ $output .= $this->get_amd_footercode();
+
+ // Add other requested modules.
+ $output .= $this->get_extra_modules_code();
+
+ $this->js_init_code('M.util.js_complete("init");', true);
+
+ // All the other linked scripts - there should be as few as possible.
+ if ($this->jsincludes['footer']) {
+ foreach ($this->jsincludes['footer'] as $url) {
+ $output .= html_writer::script('', $url);
+ }
+ }
+
+ // Add all needed strings.
+ // First add core strings required for some dialogues.
+ $this->strings_for_js([
+ 'confirm',
+ 'yes',
+ 'no',
+ 'areyousure',
+ 'closebuttontitle',
+ 'unknownerror',
+ 'error',
+ 'file',
+ 'url',
+ // TODO MDL-70830 shortforms should preload the collapseall/expandall strings properly.
+ 'collapseall',
+ 'expandall',
+ ], 'moodle');
+ $this->strings_for_js([
+ 'debuginfo',
+ 'line',
+ 'stacktrace',
+ ], 'debug');
+ $this->string_for_js('labelsep', 'langconfig');
+ if (!empty($this->stringsforjs)) {
+ $strings = [];
+ foreach ($this->stringsforjs as $component => $v) {
+ foreach ($v as $indentifier => $langstring) {
+ $strings[$component][$indentifier] = $langstring->out();
+ }
+ }
+ $output .= html_writer::script(js_writer::set_variable('M.str', $strings));
+ }
+
+ // Add variables.
+ if ($this->jsinitvariables['footer']) {
+ $js = '';
+ foreach ($this->jsinitvariables['footer'] as $data) {
+ [$var, $value] = $data;
+ $js .= js_writer::set_variable($var, $value, true);
+ }
+ $output .= html_writer::script($js);
+ }
+
+ $inyuijs = $this->get_javascript_code(false);
+ $ondomreadyjs = $this->get_javascript_code(true);
+ $jsinit = $this->get_javascript_init_code();
+ $handlersjs = $this->get_event_handler_code();
+
+ // There is a global Y, make sure it is available in your scope.
+ $js = "(function() {{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}})();";
+
+ $output .= html_writer::script($js);
+
+ return $output;
+ }
+
+ /**
+ * Have we already output the code in the tag?
+ *
+ * @return bool
+ */
+ public function is_head_done() {
+ return $this->headdone;
+ }
+
+ /**
+ * Have we already output the code at the start of the tag?
+ *
+ * @return bool
+ */
+ public function is_top_of_body_done() {
+ return $this->topofbodydone;
+ }
+
+ /**
+ * Should we generate a bit of content HTML that is only required once on
+ * this page (e.g. the contents of the modchooser), now? Basically, we call
+ * {@see has_one_time_item_been_created()}, and if the thing has not already
+ * been output, we return true to tell the caller to generate it, and also
+ * call {@see set_one_time_item_created()} to record the fact that it is
+ * about to be generated.
+ *
+ * That is, a typical usage pattern (in a renderer method) is:
+ *
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class select_menu implements \renderable, \templatable {
+class select_menu implements renderable, templatable {
/** @var array List of options. */
protected $options;
@@ -85,7 +83,7 @@ protected function flatten_options(): array {
'name' => $groupname,
'isgroup' => true,
'id' => \html_writer::random_id('select-menu-group'),
- 'options' => []
+ 'options' => [],
];
}
foreach ($optoptions as $optvalue => $optoption) {
diff --git a/lib/classes/output/single_button.php b/lib/classes/output/single_button.php
new file mode 100644
index 0000000000000..853f8d83f0817
--- /dev/null
+++ b/lib/classes/output/single_button.php
@@ -0,0 +1,282 @@
+.
+
+namespace core\output;
+
+use core\output\actions\confirm_action;
+use core\output\actions\component_action;
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure representing a simple form with only one button.
+ *
+ * @copyright 2009 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class single_button implements renderable {
+ /**
+ * Possible button types. From boostrap.
+ */
+ const BUTTON_TYPES = [
+ self::BUTTON_PRIMARY,
+ self::BUTTON_SECONDARY,
+ self::BUTTON_SUCCESS,
+ self::BUTTON_DANGER,
+ self::BUTTON_WARNING,
+ self::BUTTON_INFO,
+ ];
+
+ /**
+ * Possible button types - Primary.
+ */
+ const BUTTON_PRIMARY = 'primary';
+ /**
+ * Possible button types - Secondary.
+ */
+ const BUTTON_SECONDARY = 'secondary';
+ /**
+ * Possible button types - Danger.
+ */
+ const BUTTON_DANGER = 'danger';
+ /**
+ * Possible button types - Success.
+ */
+ const BUTTON_SUCCESS = 'success';
+ /**
+ * Possible button types - Warning.
+ */
+ const BUTTON_WARNING = 'warning';
+ /**
+ * Possible button types - Info.
+ */
+ const BUTTON_INFO = 'info';
+
+ /**
+ * @var moodle_url Target url
+ */
+ public $url;
+
+ /**
+ * @var string Button label
+ */
+ public $label;
+
+ /**
+ * @var string Form submit method post or get
+ */
+ public $method = 'post';
+
+ /**
+ * @var string Wrapping div class
+ */
+ public $class = 'singlebutton';
+
+ /**
+ * @var string Type of button (from defined types). Used for styling.
+ */
+ protected $type;
+
+ /**
+ * @var bool True if button is primary button. Used for styling.
+ * @deprecated since Moodle 4.2
+ */
+ private $primary = false;
+
+ /**
+ * @var bool True if button disabled, false if normal
+ */
+ public $disabled = false;
+
+ /**
+ * @var string Button tooltip
+ */
+ public $tooltip = null;
+
+ /**
+ * @var string Form id
+ */
+ public $formid;
+
+ /**
+ * @var array List of attached actions
+ */
+ public $actions = [];
+
+ /**
+ * @var array $params URL Params
+ */
+ public $params;
+
+ /**
+ * @var string Action id
+ */
+ public $actionid;
+
+ /**
+ * @var array
+ */
+ protected $attributes = [];
+
+ /**
+ * Constructor
+ *
+ * @param moodle_url $url
+ * @param string $label button text
+ * @param string $method get or post submit method
+ * @param string $type whether this is a primary button or another type, used for styling
+ * @param array $attributes Attributes for the HTML button tag
+ */
+ public function __construct(
+ moodle_url $url,
+ $label,
+ $method = 'post',
+ $type = self::BUTTON_SECONDARY,
+ $attributes = []
+ ) {
+ if (is_bool($type)) {
+ debugging('The boolean $primary is deprecated and replaced by $type,
+ use single_button::BUTTON_PRIMARY or self::BUTTON_SECONDARY instead');
+ $type = $type ? self::BUTTON_PRIMARY : self::BUTTON_SECONDARY;
+ }
+ $this->url = clone($url);
+ $this->label = $label;
+ $this->method = $method;
+ $this->type = $type;
+ $this->attributes = $attributes;
+ }
+
+ /**
+ * Shortcut for adding a JS confirm dialog when the button is clicked.
+ * The message must be a yes/no question.
+ *
+ * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
+ */
+ public function add_confirm_action($confirmmessage) {
+ $this->add_action(new confirm_action($confirmmessage));
+ }
+
+ /**
+ * Add action to the button.
+ * @param component_action $action
+ */
+ public function add_action(component_action $action) {
+ $this->actions[] = $action;
+ }
+
+ /**
+ * Sets an attribute for the HTML button tag.
+ *
+ * @param string $name The attribute name
+ * @param mixed $value The value
+ * @return null
+ */
+ public function set_attribute($name, $value) {
+ $this->attributes[$name] = $value;
+ }
+
+ /**
+ * Magic setter method.
+ *
+ * This method manages access to some properties and will display deprecation message when accessing 'primary' property.
+ *
+ * @param string $name
+ * @param mixed $value
+ */
+ public function __set($name, $value) {
+ switch ($name) {
+ case 'primary':
+ debugging('The primary field is deprecated, use the type field instead');
+ // Here just in case we modified the primary field from outside {@see \mod_quiz_renderer::summary_page_controls}.
+ $this->type = $value ? self::BUTTON_PRIMARY : self::BUTTON_SECONDARY;
+ break;
+ case 'type':
+ $this->type = in_array($value, self::BUTTON_TYPES) ? $value : self::BUTTON_SECONDARY;
+ break;
+ default:
+ $this->$name = $value;
+ }
+ }
+
+ /**
+ * Magic method getter.
+ *
+ * This method manages access to some properties and will display deprecation message when accessing 'primary' property.
+ *
+ * @param string $name
+ * @return mixed
+ */
+ public function __get($name) {
+ switch ($name) {
+ case 'primary':
+ debugging('The primary field is deprecated, use type field instead');
+ return $this->type == self::BUTTON_PRIMARY;
+ case 'type':
+ return $this->type;
+ default:
+ return $this->$name;
+ }
+ }
+
+ /**
+ * Export data.
+ *
+ * @param renderer_base $output Renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $url = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
+
+ $data = new stdClass();
+ $data->id = html_writer::random_id('single_button');
+ $data->formid = $this->formid;
+ $data->method = $this->method;
+ $data->url = $url === '' ? '#' : $url;
+ $data->label = $this->label;
+ $data->classes = $this->class;
+ $data->disabled = $this->disabled;
+ $data->tooltip = $this->tooltip;
+ $data->type = $this->type;
+ $data->attributes = [];
+ foreach ($this->attributes as $key => $value) {
+ $data->attributes[] = ['name' => $key, 'value' => $value];
+ }
+
+ // Form parameters.
+ $actionurl = new moodle_url($this->url);
+ if ($this->method === 'post') {
+ $actionurl->param('sesskey', sesskey());
+ }
+ $data->params = $actionurl->export_params_for_template();
+
+ // Button actions.
+ $actions = $this->actions;
+ $data->actions = array_map(function ($action) use ($output) {
+ return $action->export_for_template($output);
+ }, $actions);
+ $data->hasactions = !empty($data->actions);
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(single_button::class, \single_button::class);
diff --git a/lib/classes/output/single_select.php b/lib/classes/output/single_select.php
new file mode 100644
index 0000000000000..d4bfa8cc084c2
--- /dev/null
+++ b/lib/classes/output/single_select.php
@@ -0,0 +1,306 @@
+.
+
+namespace core\output;
+
+use core\exception\coding_exception;
+use core\output\actions\component_action;
+use moodle_url;
+use stdClass;
+
+/**
+ * Simple form with just one select field that gets submitted automatically.
+ *
+ * If JS not enabled small go button is printed too.
+ *
+ * @copyright 2009 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class single_select implements renderable, templatable {
+ /**
+ * @var moodle_url Target url - includes hidden fields
+ */
+ public $url;
+
+ /**
+ * @var string Name of the select element.
+ */
+ public $name;
+
+ /**
+ * @var array $options associative array value=>label ex.: array(1=>'One, 2=>Two)
+ * it is also possible to specify optgroup as complex label array ex.:
+ * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
+ * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
+ */
+ public $options;
+
+ /**
+ * @var string Selected option
+ */
+ public $selected;
+
+ /**
+ * @var array Nothing selected
+ */
+ public $nothing;
+
+ /**
+ * @var array Extra select field attributes
+ */
+ public $attributes = [];
+
+ /**
+ * @var string Button label
+ */
+ public $label = '';
+
+ /**
+ * @var array Button label's attributes
+ */
+ public $labelattributes = [];
+
+ /**
+ * @var string Form submit method post or get
+ */
+ public $method = 'get';
+
+ /**
+ * @var string Wrapping div class
+ */
+ public $class = 'singleselect';
+
+ /**
+ * @var bool True if button disabled, false if normal
+ */
+ public $disabled = false;
+
+ /**
+ * @var string Button tooltip
+ */
+ public $tooltip = null;
+
+ /**
+ * @var string Form id
+ */
+ public $formid = null;
+
+ /**
+ * @var help_icon The help icon for this element.
+ */
+ public $helpicon = null;
+
+ /** @var component_action[] component action. */
+ public $actions = [];
+
+ /**
+ * Constructor
+ * @param moodle_url $url form action target, includes hidden fields
+ * @param string $name name of selection field - the changing parameter in url
+ * @param array $options list of options
+ * @param string $selected selected element
+ * @param ?array $nothing
+ * @param string $formid
+ */
+ public function __construct(
+ moodle_url $url,
+ $name,
+ array $options,
+ $selected = '',
+ $nothing = ['' => 'choosedots'],
+ $formid = null,
+ ) {
+ $this->url = $url;
+ $this->name = $name;
+ $this->options = $options;
+ $this->selected = $selected;
+ $this->nothing = $nothing;
+ $this->formid = $formid;
+ }
+
+ /**
+ * Shortcut for adding a JS confirm dialog when the button is clicked.
+ * The message must be a yes/no question.
+ *
+ * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
+ */
+ public function add_confirm_action($confirmmessage) {
+ $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', ['message' => $confirmmessage]));
+ }
+
+ /**
+ * Add action to the button.
+ *
+ * @param component_action $action
+ */
+ public function add_action(component_action $action) {
+ $this->actions[] = $action;
+ }
+
+ /**
+ * Adds help icon.
+ *
+ * @deprecated since Moodle 2.0
+ */
+ public function set_old_help_icon($helppage, $title, $component = 'moodle') {
+ throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
+ }
+
+ /**
+ * Adds help icon.
+ *
+ * @param string $identifier The keyword that defines a help page
+ * @param string $component
+ */
+ public function set_help_icon($identifier, $component = 'moodle') {
+ $this->helpicon = new help_icon($identifier, $component);
+ }
+
+ /**
+ * Sets select's label
+ *
+ * @param string $label
+ * @param array $attributes (optional)
+ */
+ public function set_label($label, $attributes = []) {
+ $this->label = $label;
+ $this->labelattributes = $attributes;
+ }
+
+ /**
+ * Export data.
+ *
+ * @param renderer_base $output Renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $attributes = $this->attributes;
+
+ $data = new stdClass();
+ $data->name = $this->name;
+ $data->method = $this->method;
+ $data->action = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
+ $data->classes = $this->class;
+ $data->label = $this->label;
+ $data->disabled = $this->disabled;
+ $data->title = $this->tooltip;
+ $data->formid = !empty($this->formid) ? $this->formid : html_writer::random_id('single_select_f');
+ $data->id = !empty($attributes['id']) ? $attributes['id'] : html_writer::random_id('single_select');
+
+ // Select element attributes.
+ // Unset attributes that are already predefined in the template.
+ unset($attributes['id']);
+ unset($attributes['class']);
+ unset($attributes['name']);
+ unset($attributes['title']);
+ unset($attributes['disabled']);
+
+ // Map the attributes.
+ $data->attributes = array_map(function ($key) use ($attributes) {
+ return ['name' => $key, 'value' => $attributes[$key]];
+ }, array_keys($attributes));
+
+ // Form parameters.
+ $actionurl = new moodle_url($this->url);
+ if ($this->method === 'post') {
+ $actionurl->param('sesskey', sesskey());
+ }
+ $data->params = $actionurl->export_params_for_template();
+
+ // Select options.
+ $hasnothing = false;
+ if (is_string($this->nothing) && $this->nothing !== '') {
+ $nothing = ['' => $this->nothing];
+ $hasnothing = true;
+ $nothingkey = '';
+ } else if (is_array($this->nothing)) {
+ $nothingvalue = reset($this->nothing);
+ if ($nothingvalue === 'choose' || $nothingvalue === 'choosedots') {
+ $nothing = [key($this->nothing) => get_string('choosedots')];
+ } else {
+ $nothing = $this->nothing;
+ }
+ $hasnothing = true;
+ $nothingkey = key($this->nothing);
+ }
+ if ($hasnothing) {
+ $options = $nothing + $this->options;
+ } else {
+ $options = $this->options;
+ }
+
+ foreach ($options as $value => $name) {
+ if (is_array($options[$value])) {
+ foreach ($options[$value] as $optgroupname => $optgroupvalues) {
+ $sublist = [];
+ foreach ($optgroupvalues as $optvalue => $optname) {
+ $option = [
+ 'value' => $optvalue,
+ 'name' => $optname,
+ 'selected' => strval($this->selected) === strval($optvalue),
+ ];
+
+ if ($hasnothing && $nothingkey === $optvalue) {
+ $option['ignore'] = 'data-ignore';
+ }
+
+ $sublist[] = $option;
+ }
+ $data->options[] = [
+ 'name' => $optgroupname,
+ 'optgroup' => true,
+ 'options' => $sublist,
+ ];
+ }
+ } else {
+ $option = [
+ 'value' => $value,
+ 'name' => $options[$value],
+ 'selected' => strval($this->selected) === strval($value),
+ 'optgroup' => false,
+ ];
+
+ if ($hasnothing && $nothingkey === $value) {
+ $option['ignore'] = 'data-ignore';
+ }
+
+ $data->options[] = $option;
+ }
+ }
+
+ // Label attributes.
+ $data->labelattributes = [];
+ // Unset label attributes that are already in the template.
+ unset($this->labelattributes['for']);
+ // Map the label attributes.
+ foreach ($this->labelattributes as $key => $value) {
+ $data->labelattributes[] = ['name' => $key, 'value' => $value];
+ }
+
+ // Help icon.
+ $data->helpicon = !empty($this->helpicon) ? $this->helpicon->export_for_template($output) : false;
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(single_select::class, \single_select::class);
diff --git a/lib/classes/output/sticky_footer.php b/lib/classes/output/sticky_footer.php
index a007c2b060ee1..06e7e3723dab3 100644
--- a/lib/classes/output/sticky_footer.php
+++ b/lib/classes/output/sticky_footer.php
@@ -16,8 +16,6 @@
namespace core\output;
-use renderable;
-
/**
* Class to render a sticky footer element.
*
@@ -35,7 +33,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class sticky_footer implements named_templatable, renderable {
-
/**
* @var string content of the sticky footer.
*/
diff --git a/lib/classes/output/tabobject.php b/lib/classes/output/tabobject.php
new file mode 100644
index 0000000000000..d0943e6b16642
--- /dev/null
+++ b/lib/classes/output/tabobject.php
@@ -0,0 +1,149 @@
+.
+
+namespace core\output;
+
+use moodle_url;
+
+/**
+ * Stores one tab
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ * @copyright Marina Glancy
+ */
+class tabobject implements renderable, templatable {
+ /** @var string unique id of the tab in this tree, it is used to find selected and/or inactive tabs */
+ public $id;
+ /** @var moodle_url|string link */
+ public $link;
+ /** @var string text on the tab */
+ public $text;
+ /** @var string title under the link, by defaul equals to text */
+ public $title;
+ /** @var bool whether to display a link under the tab name when it's selected */
+ public $linkedwhenselected = false;
+ /** @var bool whether the tab is inactive */
+ public $inactive = false;
+ /** @var bool indicates that this tab's child is selected */
+ public $activated = false;
+ /** @var bool indicates that this tab is selected */
+ public $selected = false;
+ /** @var array stores children tabobjects */
+ public $subtree = [];
+ /** @var int level of tab in the tree, 0 for root (instance of tabtree), 1 for the first row of tabs */
+ public $level = 1;
+
+ /**
+ * Constructor
+ *
+ * @param string $id unique id of the tab in this tree, it is used to find selected and/or inactive tabs
+ * @param string|moodle_url $link
+ * @param string $text text on the tab
+ * @param string $title title under the link, by defaul equals to text
+ * @param bool $linkedwhenselected whether to display a link under the tab name when it's selected
+ */
+ public function __construct($id, $link = null, $text = '', $title = '', $linkedwhenselected = false) {
+ $this->id = $id;
+ $this->link = $link;
+ $this->text = $text;
+ $this->title = $title ? $title : $text;
+ $this->linkedwhenselected = $linkedwhenselected;
+ }
+
+ /**
+ * Travels through tree and finds the tab to mark as selected, all parents are automatically marked as activated
+ *
+ * @param string $selected the id of the selected tab (whatever row it's on),
+ * if null marks all tabs as unselected
+ * @return bool whether this tab is selected or contains selected tab in its subtree
+ */
+ protected function set_selected($selected) {
+ if ((string)$selected === (string)$this->id) {
+ $this->selected = true;
+ // This tab is selected. No need to travel through subtree.
+ return true;
+ }
+ foreach ($this->subtree as $subitem) {
+ if ($subitem->set_selected($selected)) {
+ // This tab has child that is selected. Mark it as activated. No need to check other children.
+ $this->activated = true;
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Travels through tree and finds a tab with specified id
+ *
+ * @param string $id
+ * @return tabtree|null
+ */
+ public function find($id) {
+ if ((string)$this->id === (string)$id) {
+ return $this;
+ }
+ foreach ($this->subtree as $tab) {
+ if ($obj = $tab->find($id)) {
+ return $obj;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Allows to mark each tab's level in the tree before rendering.
+ *
+ * @param int $level
+ */
+ protected function set_level($level) {
+ $this->level = $level;
+ foreach ($this->subtree as $tab) {
+ $tab->set_level($level + 1);
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output Renderer.
+ * @return object
+ */
+ public function export_for_template(renderer_base $output) {
+ if ($this->inactive || ($this->selected && !$this->linkedwhenselected) || $this->activated) {
+ $link = null;
+ } else {
+ $link = $this->link;
+ }
+ $active = $this->activated || $this->selected;
+
+ return (object) [
+ 'id' => $this->id,
+ 'link' => is_object($link) ? $link->out(false) : $link,
+ 'text' => $this->text,
+ 'title' => $this->title,
+ 'inactive' => !$active && $this->inactive,
+ 'active' => $active,
+ 'level' => $this->level,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(tabobject::class, \tabobject::class);
diff --git a/lib/classes/output/tabtree.php b/lib/classes/output/tabtree.php
new file mode 100644
index 0000000000000..0c47b4cb69bf4
--- /dev/null
+++ b/lib/classes/output/tabtree.php
@@ -0,0 +1,98 @@
+.
+
+namespace core\output;
+
+/**
+ * Stores tabs list
+ *
+ * Example how to print a single line tabs:
+ * $rows = array(
+ * new tabobject(...),
+ * new tabobject(...)
+ * );
+ * echo $OUTPUT->tabtree($rows, $selectedid);
+ *
+ * Multiple row tabs may not look good on some devices but if you want to use them
+ * you can specify ->subtree for the active tabobject.
+ *
+ * @copyright 2013 Marina Glancy
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.5
+ * @package core
+ * @category output
+ */
+class tabtree extends tabobject {
+ /**
+ * Constuctor
+ *
+ * It is highly recommended to call constructor when list of tabs is already
+ * populated, this way you ensure that selected and inactive tabs are located
+ * and attribute level is set correctly.
+ *
+ * @param array $tabs array of tabs, each of them may have it's own ->subtree
+ * @param string|null $selected which tab to mark as selected, all parent tabs will
+ * automatically be marked as activated
+ * @param array|string|null $inactive list of ids of inactive tabs, regardless of
+ * their level. Note that you can as weel specify tabobject::$inactive for separate instances
+ */
+ public function __construct($tabs, $selected = null, $inactive = null) {
+ $this->subtree = $tabs;
+ if ($selected !== null) {
+ $this->set_selected($selected);
+ }
+ if ($inactive !== null) {
+ if (is_array($inactive)) {
+ foreach ($inactive as $id) {
+ if ($tab = $this->find($id)) {
+ $tab->inactive = true;
+ }
+ }
+ } else if ($tab = $this->find($inactive)) {
+ $tab->inactive = true;
+ }
+ }
+ $this->set_level(0);
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output Renderer.
+ * @return \stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $tabs = [];
+ $secondrow = false;
+
+ foreach ($this->subtree as $tab) {
+ $tabs[] = $tab->export_for_template($output);
+ if (!empty($tab->subtree) && ($tab->level == 0 || $tab->selected || $tab->activated)) {
+ $secondrow = new tabtree($tab->subtree);
+ }
+ }
+
+ return (object) [
+ 'tabs' => $tabs,
+ 'secondrow' => $secondrow ? $secondrow->export_for_template($output) : false,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(tabtree::class, \tabtree::class);
diff --git a/lib/classes/output/templatable.php b/lib/classes/output/templatable.php
new file mode 100644
index 0000000000000..007335e697f32
--- /dev/null
+++ b/lib/classes/output/templatable.php
@@ -0,0 +1,44 @@
+.
+
+namespace core\output;
+
+/**
+ * Interface marking other classes having the ability to export their data for use by templates.
+ *
+ * @copyright 2015 Damyon Wiese
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ * @category output
+ * @since 2.9
+ */
+interface templatable {
+ /**
+ * Function to export the renderer data in a format that is suitable for a
+ * mustache template. This means:
+ * 1. No complex types - only stdClass, array, int, string, float, bool
+ * 2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
+ *
+ * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
+ * @return \stdClass|array
+ */
+ public function export_for_template(renderer_base $output);
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(templatable::class, \templatable::class);
diff --git a/lib/classes/output/theme_config.php b/lib/classes/output/theme_config.php
new file mode 100644
index 0000000000000..ae937078c932d
--- /dev/null
+++ b/lib/classes/output/theme_config.php
@@ -0,0 +1,2344 @@
+.
+
+namespace core\output;
+
+use block_manager;
+use cache;
+use cache_store;
+use core_component;
+use core_cssparser;
+use core_minify;
+use core_php_time_limit;
+use core_rtlcss;
+use core_scss;
+use core_useragent;
+use core\context\system as context_system;
+use core\exception\coding_exception;
+use core\output\renderer_factory\renderer_factory_interface as renderer_factory;
+use core\output\renderer_factory\standard_renderer_factory;
+use dml_exception;
+use moodle_page;
+use moodle_url;
+use stdClass;
+
+// phpcs:disable moodle.NamingConventions.ValidVariableName.VariableNameUnderscore
+// phpcs:disable moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+/**
+ * This class represents the configuration variables of a Moodle theme.
+ *
+ * All the variables with access: public below (with a few exceptions that are marked)
+ * are the properties you can set in your themes config.php file.
+ *
+ * There are also some methods and protected variables that are part of the inner
+ * workings of Moodle's themes system. If you are just editing a themes config.php
+ * file, you can just ignore those, and the following information for developers.
+ *
+ * Normally, to create an instance of this class, you should use the
+ * {@see theme_config::load()} factory method to load a themes config.php file.
+ * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
+ * will create one for you, accessible as $PAGE->theme.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ * @category output
+ */
+class theme_config {
+ /**
+ * @var string Default theme, used when requested theme not found.
+ */
+ const DEFAULT_THEME = 'boost';
+
+ /** The key under which the SCSS file is stored amongst the CSS files. */
+ const SCSS_KEY = '__SCSS__';
+
+ /**
+ * @var array You can base your theme on other themes by linking to the other theme as
+ * parents. This lets you use the CSS and layouts from the other themes
+ * (see {@see theme_config::$layouts}).
+ * That makes it easy to create a new theme that is similar to another one
+ * but with a few changes. In this themes CSS you only need to override
+ * those rules you want to change.
+ */
+ public $parents;
+
+ /**
+ * @var array The names of all the stylesheets from this theme that you would
+ * like included, in order. Give the names of the files without .css.
+ */
+ public $sheets = [];
+
+ /**
+ * @var array The names of all the stylesheets from parents that should be excluded.
+ * true value may be used to specify all parents or all themes from one parent.
+ * If no value specified value from parent theme used.
+ */
+ public $parents_exclude_sheets = null;
+
+ /**
+ * @var array List of plugin sheets to be excluded.
+ * If no value specified value from parent theme used.
+ */
+ public $plugins_exclude_sheets = null;
+
+ /**
+ * @var array List of style sheets that are included in the text editor bodies.
+ * Sheets from parent themes are used automatically and can not be excluded.
+ */
+ public $editor_sheets = [];
+
+ /**
+ * @var bool Whether a fallback version of the stylesheet will be used
+ * whilst the final version is generated.
+ */
+ public $usefallback = false;
+
+ /**
+ * @var array The names of all the javascript files this theme that you would
+ * like included from head, in order. Give the names of the files without .js.
+ */
+ public $javascripts = [];
+
+ /**
+ * @var array The names of all the javascript files this theme that you would
+ * like included from footer, in order. Give the names of the files without .js.
+ */
+ public $javascripts_footer = [];
+
+ /**
+ * @var array The names of all the javascript files from parents that should
+ * be excluded. true value may be used to specify all parents or all themes
+ * from one parent.
+ * If no value specified value from parent theme used.
+ */
+ public $parents_exclude_javascripts = null;
+
+ /**
+ * @var array Which file to use for each page layout.
+ *
+ * This is an array of arrays. The keys of the outer array are the different layouts.
+ * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
+ * 'popup', 'form', .... The most reliable way to get a complete list is to look at
+ * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
+ * That file also has a good example of how to set this setting.
+ *
+ * For each layout, the value in the outer array is an array that describes
+ * how you want that type of page to look. For example
+ * ' . $action . ' ' . $type . ' at:' .
+ format_backtrace(debug_backtrace()) . ' ';
+ }
+
+ /**
+ * Outputs the log's contents as a HTML list.
+ *
+ * @return string HTML list of the log
+ */
+ protected function output_log() {
+ return '
+ * @copyright Monash University 2024
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class update_geoip2file_task extends scheduled_task {
+
+ /**
+ * Get a descriptive name for this task (shown to admins).
+ *
+ * @return string
+ */
+ public function get_name(): string {
+ return get_string('taskupdategeoip2file', 'admin');
+ }
+
+ /**
+ * Execute the task to update the GeoIP2 database file.
+ *
+ * @throws \GuzzleHttp\Exception\GuzzleException
+ * @throws moodle_exception
+ */
+ public function execute(): void {
+ global $CFG;
+
+ if (!$CFG->geoipmaxmindaccid || !$CFG->geoipmaxmindlicensekey) {
+ mtrace("MaxMind account information is incomplete. Please configure the account ID and license key.");
+ return;
+ }
+
+ // Setup base directory path and permissions.
+ $geoip2file = $CFG->geoip2file;
+ $geoipdirectory = dirname($geoip2file);
+ if (!check_dir_exists($geoipdirectory) && !mkdir($geoipdirectory, $CFG->directorypermissions, true)) {
+ throw new moodle_exception("Cannot create output directory $geoipdirectory");
+ }
+
+ $geoippermalink = 'https://download.maxmind.com/geoip/databases/' . $CFG->geoipdbedition . '/download';
+
+ $client = new http_client(['auth' => [$CFG->geoipmaxmindaccid, $CFG->geoipmaxmindlicensekey]]);
+ $response = $client->head($geoippermalink, ['query' => ['suffix' => 'tar.gz']]);
+ $headers = $response->getHeaders();
+ $lastmodified = strtotime($headers['Last-Modified'][0]);
+ if (!$this->is_update_needed($geoip2file, $lastmodified)) {
+ mtrace("No update needed. The GeoIP database is up to date.");
+ return;
+ }
+
+ // Define path for downloading the GeoIP2 archive.
+ $archivefilename = 'GeoIP-City.tar.gz';
+ $tempdirectory = make_request_directory(true);
+ $geoipdownloadpath = $tempdirectory . '/' . $archivefilename;
+
+ mtrace("Downloading $CFG->geoipdbedition database from MaxMind......");
+ $response = $client->request('GET', $geoippermalink, [
+ 'query' => ['suffix' => 'tar.gz'],
+ 'sink' => $geoipdownloadpath,
+ ]);
+ if ($response->getStatusCode() != 200) {
+ throw new moodle_exception("Error downloading file.");
+ }
+
+ mtrace("File downloaded successfully to $geoipdownloadpath");
+ mtrace("Verifying checksum......");
+
+ // Get the latest checksum from MaxMind.
+ $checksumcontent = $client->get($geoippermalink, ['query' => ['suffix' => 'tar.gz.sha256']])->getBody()->getContents();
+ list($checksum) = explode(' ', $checksumcontent);
+ if (!$this->verify_checksum($checksum, $geoipdownloadpath)) {
+ throw new moodle_exception("Checksum verification failed.");
+ }
+
+ mtrace("Checksum verified successfully.");
+ if ($this->update_geoip2file($geoipdownloadpath, $tempdirectory, $geoip2file)) {
+ // Store the last seen timestamp.
+ set_config('geoip_last_seen_timestamp', $lastmodified);
+ mtrace("GeoIP database update successful!");
+ } else {
+ throw new moodle_exception("GeoIP database update failed.");
+ }
+ }
+
+ /**
+ * Determines if an update is needed for the GeoIP2 file based on the last modified date.
+ *
+ * @param string $geoip2file The path to the GeoIP2 file that needs to be checked for updates.
+ * @param string $lastmodified The last modified date to be compared against the stored last seen timestamp.
+ * @return bool
+ */
+ private function is_update_needed(string $geoip2file, string $lastmodified): bool {
+ return !file_exists($geoip2file) || $lastmodified !== get_config('core', 'geoip_last_seen_timestamp');
+ }
+
+ /**
+ * Verify the checksum of the downloaded file against an expected checksum.
+ *
+ * @param string $expectedchecksum The checksum expected for the file.
+ * @param string $geoipdownloadpath The path where the downloaded geoip archive is located.
+ * @return bool Returns true if the checksums match, returns false otherwise.
+ */
+ private function verify_checksum(string $expectedchecksum, string $geoipdownloadpath): bool {
+ $actualchecksum = hash_file('sha256', $geoipdownloadpath);
+ return $expectedchecksum === $actualchecksum;
+ }
+
+ /**
+ * Extract the archive and update the GeoIP2 database file.
+ *
+ * @param string $archivepath The path to the archive file that needs to be extracted.
+ * @param string $targetdirectory Directory where the archive contents will be extracted.
+ * @param string $geoip2file The path to move the extracted GeoIP2 file.
+ * @return bool Returns true if the file was successfully extracted and moved to the specified location,
+ * false if any part of the process fails.
+ */
+ private function update_geoip2file(string $archivepath, string $targetdirectory, string $geoip2file): bool {
+ $archive = new PharData($archivepath);
+ $archivename = $archive->getFilename();
+
+ mtrace("Extracting file......");
+ $archive->extractTo($targetdirectory);
+ $sourcefolder = $targetdirectory . '/' . $archivename;
+
+ // Find the mmdb file.
+ $mmdbfiles = glob($sourcefolder . '/*.mmdb');
+ if (count($mmdbfiles) > 1) {
+ throw new moodle_exception("Multiple .mmdb files found in the extracted folder.");
+ } else if (count($mmdbfiles) === 0) {
+ throw new moodle_exception("GeoIP file does not exist.");
+ }
+
+ // Backup existing GeoIP file before attempting to update.
+ $geoip2filename = basename($geoip2file);
+ $backuppath = $targetdirectory . '/' . 'backup_' . $geoip2filename;
+ if (file_exists($geoip2file)) {
+ if (!rename($geoip2file, $backuppath)) {
+ mtrace("Failed to create a backup of the existing GeoIP database.");
+ }
+ mtrace("Temporary backup of existing GeoIP file has been created.");
+ }
+
+ mtrace("Moving {$mmdbfiles[0]} into $geoip2file");
+ if (!copy($mmdbfiles[0], $geoip2file)) {
+ mtrace("Failed to update $geoip2filename.");
+ // Attempt to restore the original file from the backup.
+ if (file_exists($backuppath)) {
+ mtrace("Attempting to restore from backup.");
+ if (!copy($backuppath, $geoip2file)) {
+ throw new moodle_exception("Failed to restore the GeoIP database from backup.");
+ } else {
+ mtrace("The GeoIP database has been restored from the backup successfully.");
+ }
+ }
+ return false;
+ }
+ mtrace("$geoip2filename updated successfully.");
+ return true;
+ }
+}
diff --git a/lib/classes/update/code_manager.php b/lib/classes/update/code_manager.php
index 3493ad427fb99..9be25ed00a420 100644
--- a/lib/classes/update/code_manager.php
+++ b/lib/classes/update/code_manager.php
@@ -14,16 +14,9 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
namespace core\update;
+use core_collator;
use core_component;
use coding_exception;
use moodle_exception;
@@ -44,7 +37,8 @@
* - archive existing version of the plugin source code
* - move (deploy) the plugin source code into the $CFG->dirroot
*
- * @copyright 2015 David Mudrak
+ * @package core
+ * @copyright 2012 David Mudrak
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class code_manager {
@@ -539,6 +533,8 @@ protected function set_plugin_files_permissions($targetdir, array $files) {
protected function move_extracted_plugin_files($sourcedir, $targetdir, array $files) {
global $CFG;
+ // Iterate sorted file list (to ensure directories precede files within them).
+ core_collator::ksort($files);
foreach ($files as $file => $status) {
if ($status !== true) {
throw new moodle_exception('corrupted_archive_structure', 'core_plugin', '', $file, $status);
@@ -548,12 +544,8 @@ protected function move_extracted_plugin_files($sourcedir, $targetdir, array $fi
$target = $targetdir.'/'.$file;
if (is_dir($source)) {
- continue;
-
+ mkdir($target, $CFG->directorypermissions, true);
} else {
- if (!is_dir(dirname($target))) {
- mkdir(dirname($target), $CFG->directorypermissions, true);
- }
rename($source, $target);
}
}
diff --git a/lib/classes/url.php b/lib/classes/url.php
new file mode 100644
index 0000000000000..af29e06d832da
--- /dev/null
+++ b/lib/classes/url.php
@@ -0,0 +1,875 @@
+.
+
+namespace core;
+
+use core\context\user as context_user;
+use core\exception\coding_exception;
+use core\exception\moodle_exception;
+use Psr\Http\Message\UriInterface;
+
+/**
+ * Class for creating and manipulating urls.
+ *
+ * It can be used in moodle pages where config.php has been included without any further includes.
+ *
+ * It is useful for manipulating urls with long lists of params.
+ * One situation where it will be useful is a page which links to itself to perform various actions
+ * and / or to process form data. A url object:
+ * can be created for a page to refer to itself with all the proper get params being passed from page call to
+ * page call and methods can be used to output a url including all the params, optionally adding and overriding
+ * params and can also be used to
+ * - output the url without any get params
+ * - and output the params as hidden fields to be output within a form
+ *
+ * @copyright 2007 jamiesensei
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ */
+class url {
+ /**
+ * Scheme, ex.: http, https
+ * @var string
+ */
+ protected $scheme = '';
+
+ /**
+ * Hostname.
+ * @var string
+ */
+ protected $host = '';
+
+ /**
+ * Port number, empty means default 80 or 443 in case of http.
+ * @var int
+ */
+ protected $port = '';
+
+ /**
+ * Username for http auth.
+ * @var string
+ */
+ protected $user = '';
+
+ /**
+ * Password for http auth.
+ * @var string
+ */
+ protected $pass = '';
+
+ /**
+ * Script path.
+ * @var string
+ */
+ protected $path = '';
+
+ /**
+ * Optional slash argument value.
+ * @var string
+ */
+ protected $slashargument = '';
+
+ /**
+ * Anchor, may be also empty, null means none.
+ * @var string
+ */
+ protected $anchor = null;
+
+ /**
+ * Url parameters as associative array.
+ * @var array
+ */
+ protected $params = [];
+
+ /**
+ * Create new instance of url.
+ *
+ * @param self|string $url - moodle_url means make a copy of another
+ * moodle_url and change parameters, string means full url or shortened
+ * form (ex.: '/course/view.php'). It is strongly encouraged to not include
+ * query string because it may result in double encoded values. Use the
+ * $params instead. For admin URLs, just use /admin/script.php, this
+ * class takes care of the $CFG->admin issue.
+ * @param null|array $params these params override current params or add new
+ * @param string $anchor The anchor to use as part of the URL if there is one.
+ * @throws moodle_exception
+ */
+ public function __construct(
+ $url,
+ ?array $params = null,
+ $anchor = null,
+ ) {
+ global $CFG;
+
+ if ($url instanceof self) {
+ $this->scheme = $url->scheme;
+ $this->host = $url->host;
+ $this->port = $url->port;
+ $this->user = $url->user;
+ $this->pass = $url->pass;
+ $this->path = $url->path;
+ $this->slashargument = $url->slashargument;
+ $this->params = $url->params;
+ $this->anchor = $url->anchor;
+ } else {
+ $url = $url ?? '';
+ // Detect if anchor used.
+ $apos = strpos($url, '#');
+ if ($apos !== false) {
+ $anchor = substr($url, $apos);
+ $anchor = ltrim($anchor, '#');
+ $this->set_anchor($anchor);
+ $url = substr($url, 0, $apos);
+ }
+
+ // Normalise shortened form of our url ex.: '/course/view.php'.
+ if (strpos($url, '/') === 0) {
+ $url = $CFG->wwwroot . $url;
+ }
+
+ if ($CFG->admin !== 'admin') {
+ if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
+ $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
+ }
+ }
+
+ // Parse the $url.
+ $parts = parse_url($url);
+ if ($parts === false) {
+ throw new moodle_exception('invalidurl');
+ }
+ if (isset($parts['query'])) {
+ // Note: the values may not be correctly decoded, url parameters should be always passed as array.
+ parse_str(str_replace('&', '&', $parts['query']), $this->params);
+ }
+ unset($parts['query']);
+ foreach ($parts as $key => $value) {
+ $this->$key = $value;
+ }
+
+ // Detect slashargument value from path - we do not support directory names ending with .php.
+ $pos = strpos($this->path, '.php/');
+ if ($pos !== false) {
+ $this->slashargument = substr($this->path, $pos + 4);
+ $this->path = substr($this->path, 0, $pos + 4);
+ }
+ }
+
+ $this->params($params);
+ if ($anchor !== null) {
+ $this->anchor = (string)$anchor;
+ }
+ }
+
+ /**
+ * Add an array of params to the params for this url.
+ *
+ * The added params override existing ones if they have the same name.
+ *
+ * @param null|array $params Defaults to null. If null then returns all params.
+ * @return array Array of Params for url.
+ * @throws coding_exception
+ */
+ public function params(?array $params = null) {
+ $params = (array)$params;
+
+ foreach ($params as $key => $value) {
+ if (is_int($key)) {
+ throw new coding_exception('Url parameters can not have numeric keys!');
+ }
+ if (!is_string($value)) {
+ if (is_array($value)) {
+ throw new coding_exception('Url parameters values can not be arrays!');
+ }
+ if (is_object($value) && !method_exists($value, '__toString')) {
+ throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
+ }
+ }
+ $this->params[$key] = (string)$value;
+ }
+ return $this->params;
+ }
+
+ /**
+ * Remove all params if no arguments passed.
+ * Remove selected params if arguments are passed.
+ *
+ * Can be called as either remove_params('param1', 'param2')
+ * or remove_params(array('param1', 'param2')).
+ *
+ * @param string[]|string ...$params either an array of param names, or 1..n string params to remove as args.
+ * @return array url parameters
+ */
+ public function remove_params(...$params) {
+ if (empty($params)) {
+ return $this->params;
+ }
+
+ $firstparam = reset($params);
+ if (is_array($firstparam)) {
+ $params = $firstparam;
+ }
+
+ foreach ($params as $param) {
+ unset($this->params[$param]);
+ }
+ return $this->params;
+ }
+
+ /**
+ * Remove all url parameters.
+ *
+ * @param array $unused Unused param
+ */
+ public function remove_all_params($unused = null) {
+ $this->params = [];
+ $this->slashargument = '';
+ }
+
+ /**
+ * Add a param to the params for this url.
+ *
+ * The added param overrides existing one if they have the same name.
+ *
+ * @param string $paramname name
+ * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
+ * @return mixed string parameter value, null if parameter does not exist
+ */
+ public function param($paramname, $newvalue = '') {
+ if (func_num_args() > 1) {
+ // Set new value.
+ $this->params([$paramname => $newvalue]);
+ }
+ if (isset($this->params[$paramname])) {
+ return $this->params[$paramname];
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Merges parameters and validates them
+ *
+ * @param null|array $overrideparams
+ * @return array merged parameters
+ * @throws coding_exception
+ */
+ protected function merge_overrideparams(?array $overrideparams = null) {
+ $overrideparams = (array)$overrideparams;
+ $params = $this->params;
+ foreach ($overrideparams as $key => $value) {
+ if (is_int($key)) {
+ throw new coding_exception('Overridden parameters can not have numeric keys!');
+ }
+ if (is_array($value)) {
+ throw new coding_exception('Overridden parameters values can not be arrays!');
+ }
+ if (is_object($value) && !method_exists($value, '__toString')) {
+ throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
+ }
+ $params[$key] = (string)$value;
+ }
+ return $params;
+ }
+
+ /**
+ * Get the params as as a query string.
+ *
+ * This method should not be used outside of this method.
+ *
+ * @param bool $escaped Use & as params separator instead of plain &
+ * @param null|array $overrideparams params to add to the output params, these
+ * override existing ones with the same name.
+ * @return string query string that can be added to a url.
+ */
+ public function get_query_string($escaped = true, ?array $overrideparams = null) {
+ $arr = [];
+ if ($overrideparams !== null) {
+ $params = $this->merge_overrideparams($overrideparams);
+ } else {
+ $params = $this->params;
+ }
+ foreach ($params as $key => $val) {
+ if (is_array($val)) {
+ foreach ($val as $index => $value) {
+ $arr[] = rawurlencode($key . '[' . $index . ']') . "=" . rawurlencode($value);
+ }
+ } else {
+ if (isset($val) && $val !== '') {
+ $arr[] = rawurlencode($key) . "=" . rawurlencode($val);
+ } else {
+ $arr[] = rawurlencode($key);
+ }
+ }
+ }
+ if ($escaped) {
+ return implode('&', $arr);
+ } else {
+ return implode('&', $arr);
+ }
+ }
+
+ /**
+ * Get the url params as an array of key => value pairs.
+ *
+ * This helps in handling cases where url params contain arrays.
+ *
+ * @return array params array for templates.
+ */
+ public function export_params_for_template(): array {
+ $data = [];
+ foreach ($this->params as $key => $val) {
+ if (is_array($val)) {
+ foreach ($val as $index => $value) {
+ $data[] = ['name' => $key . '[' . $index . ']', 'value' => $value];
+ }
+ } else {
+ $data[] = ['name' => $key, 'value' => $val];
+ }
+ }
+ return $data;
+ }
+
+ /**
+ * Shortcut for printing of encoded URL.
+ *
+ * @return string
+ */
+ public function __toString() {
+ return $this->out(true);
+ }
+
+ /**
+ * Output url.
+ *
+ * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
+ * the returned URL in HTTP headers, you want $escaped=false.
+ *
+ * @param bool $escaped Use & as params separator instead of plain &
+ * @param null|array $overrideparams params to add to the output url, these override existing ones with the same name.
+ * @return string Resulting URL
+ */
+ public function out($escaped = true, ?array $overrideparams = null) {
+
+ global $CFG;
+
+ if (!is_bool($escaped)) {
+ debugging('Escape parameter must be of type boolean, ' . gettype($escaped) . ' given instead.');
+ }
+
+ $url = $this;
+
+ // Allow url's to be rewritten by a plugin.
+ if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
+ $class = $CFG->urlrewriteclass;
+ $pluginurl = $class::url_rewrite($url);
+ if ($pluginurl instanceof url) {
+ $url = $pluginurl;
+ }
+ }
+
+ return $url->raw_out($escaped, $overrideparams);
+ }
+
+ /**
+ * Output url without any rewrites
+ *
+ * This is identical in signature and use to out() but doesn't call the rewrite handler.
+ *
+ * @param bool $escaped Use & as params separator instead of plain &
+ * @param null|array $overrideparams params to add to the output url, these override existing ones with the same name.
+ * @return string Resulting URL
+ */
+ public function raw_out($escaped = true, ?array $overrideparams = null) {
+ if (!is_bool($escaped)) {
+ debugging('Escape parameter must be of type boolean, ' . gettype($escaped) . ' given instead.');
+ }
+
+ $uri = $this->out_omit_querystring() . $this->slashargument;
+
+ $querystring = $this->get_query_string($escaped, $overrideparams);
+ if ($querystring !== '') {
+ $uri .= '?' . $querystring;
+ }
+
+ $uri .= $this->get_encoded_anchor();
+
+ return $uri;
+ }
+
+ /**
+ * Encode the anchor according to RFC 3986.
+ *
+ * @return string The encoded anchor
+ */
+ public function get_encoded_anchor(): string {
+ if (is_null($this->anchor)) {
+ return '';
+ }
+
+ // RFC 3986 allows the following characters in a fragment without them being encoded:
+ // pct-encoded: "%" HEXDIG HEXDIG
+ // unreserved: ALPHA / DIGIT / "-" / "." / "_" / "~" /
+ // sub-delims: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" / ":" / "@"
+ // fragment: "/" / "?"
+ //
+ // All other characters should be encoded.
+ // These should not be encoded in the fragment unless they were already encoded.
+
+ // The following characters are allowed in the fragment without encoding.
+ // In addition to this list is pct-encoded, but we can't easily handle this with a regular expression.
+ $allowed = 'a-zA-Z0-9\\-._~!$&\'()*+,;=:@\/?';
+ $anchor = '#';
+
+ $remainder = $this->anchor;
+ do {
+ // Split the string on any %.
+ $parts = explode('%', $remainder, 2);
+ $anchorparts = array_shift($parts);
+
+ // The first part can go through our preg_replace_callback to quote any relevant characters.
+ $anchor .= preg_replace_callback(
+ '/[^' . $allowed . ']/',
+ fn ($matches) => rawurlencode($matches[0]),
+ $anchorparts,
+ );
+
+ // The second part _might_ be a valid pct-encoded character.
+ if (count($parts) === 0) {
+ break;
+ }
+
+ // If the second part is a valid pct-encoded character, append it to the anchor.
+ $remainder = array_shift($parts);
+ if (preg_match('/^[a-fA-F0-9]{2}/', $remainder, $matches)) {
+ $anchor .= "%{$matches[0]}";
+ $remainder = substr($remainder, 2);
+ } else {
+ // This was not a valid pct-encoded character. Encode the % and continue with the next part.
+ $anchor .= rawurlencode('%');
+ }
+ } while (strlen($remainder) > 0);
+
+ return $anchor;
+ }
+
+ /**
+ * Returns url without parameters, everything before '?'.
+ *
+ * @param bool $includeanchor if {@see self::anchor} is defined, should it be returned?
+ * @return string
+ */
+ public function out_omit_querystring($includeanchor = false) {
+
+ $uri = $this->scheme ? $this->scheme . ':' . ((strtolower($this->scheme) == 'mailto') ? '' : '//') : '';
+ $uri .= $this->user ? $this->user . ($this->pass ? ':' . $this->pass : '') . '@' : '';
+ $uri .= $this->host ? $this->host : '';
+ $uri .= $this->port ? ':' . $this->port : '';
+ $uri .= $this->path ? $this->path : '';
+ if ($includeanchor) {
+ $uri .= $this->get_encoded_anchor();
+ }
+
+ return $uri;
+ }
+
+ /**
+ * Compares this url with another.
+ *
+ * See documentation of constants for an explanation of the comparison flags.
+ *
+ * @param self $url The moodle_url object to compare
+ * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
+ * @return bool
+ */
+ public function compare(self $url, $matchtype = URL_MATCH_EXACT) {
+
+ $baseself = $this->out_omit_querystring();
+ $baseother = $url->out_omit_querystring();
+
+ // Append index.php if there is no specific file.
+ if (substr($baseself, -1) == '/') {
+ $baseself .= 'index.php';
+ }
+ if (substr($baseother, -1) == '/') {
+ $baseother .= 'index.php';
+ }
+
+ // Compare the two base URLs.
+ if ($baseself != $baseother) {
+ return false;
+ }
+
+ if ($matchtype == URL_MATCH_BASE) {
+ return true;
+ }
+
+ $urlparams = $url->params();
+ foreach ($this->params() as $param => $value) {
+ if ($param == 'sesskey') {
+ continue;
+ }
+ if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
+ return false;
+ }
+ }
+
+ if ($matchtype == URL_MATCH_PARAMS) {
+ return true;
+ }
+
+ foreach ($urlparams as $param => $value) {
+ if ($param == 'sesskey') {
+ continue;
+ }
+ if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
+ return false;
+ }
+ }
+
+ if ($url->anchor !== $this->anchor) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Sets the anchor for the URI (the bit after the hash)
+ *
+ * @param string $anchor null means remove previous
+ */
+ public function set_anchor($anchor) {
+ if (is_null($anchor)) {
+ // Remove.
+ $this->anchor = null;
+ } else {
+ $this->anchor = $anchor;
+ }
+ }
+
+ /**
+ * Sets the scheme for the URI (the bit before ://)
+ *
+ * @param string $scheme
+ */
+ public function set_scheme($scheme) {
+ // See http://www.ietf.org/rfc/rfc3986.txt part 3.1.
+ if (preg_match('/^[a-zA-Z][a-zA-Z0-9+.-]*$/', $scheme)) {
+ $this->scheme = $scheme;
+ } else {
+ throw new coding_exception('Bad URL scheme.');
+ }
+ }
+
+ /**
+ * Sets the url slashargument value.
+ *
+ * @param string $path usually file path
+ * @param string $parameter name of page parameter if slasharguments not supported
+ * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
+ */
+ public function set_slashargument($path, $parameter = 'file', $supported = null) {
+ global $CFG;
+ if (is_null($supported)) {
+ $supported = !empty($CFG->slasharguments);
+ }
+
+ if ($supported) {
+ $parts = explode('/', $path);
+ $parts = array_map('rawurlencode', $parts);
+ $path = implode('/', $parts);
+ $this->slashargument = $path;
+ unset($this->params[$parameter]);
+ } else {
+ $this->slashargument = '';
+ $this->params[$parameter] = $path;
+ }
+ }
+
+ // Static factory methods.
+
+ /**
+ * Create a new url instance from a UriInterface.
+ *
+ * @param UriInterface $uri
+ * @return self
+ */
+ public static function from_uri(UriInterface $uri): self {
+ $url = new self(
+ url: $uri->getScheme() . '://' . $uri->getAuthority() . $uri->getPath(),
+ anchor: $uri->getFragment() ?: null,
+ );
+
+ $params = $uri->getQuery();
+ foreach (explode('&', $params) as $param) {
+ $url->param(...explode('=', $param, 2));
+ }
+
+ return $url;
+ }
+
+ /**
+ * General moodle file url.
+ *
+ * @param string $urlbase the script serving the file
+ * @param string $path
+ * @param bool $forcedownload
+ * @return self
+ */
+ public static function make_file_url($urlbase, $path, $forcedownload = false) {
+ $params = [];
+ if ($forcedownload) {
+ $params['forcedownload'] = 1;
+ }
+ $url = new self($urlbase, $params);
+ $url->set_slashargument($path);
+ return $url;
+ }
+
+ /**
+ * Factory method for creation of url pointing to plugin file.
+ *
+ * Please note this method can be used only from the plugins to
+ * create urls of own files, it must not be used outside of plugins!
+ *
+ * @param int $contextid
+ * @param string $component
+ * @param string $area
+ * @param ?int $itemid
+ * @param string $pathname
+ * @param string $filename
+ * @param bool $forcedownload
+ * @param mixed $includetoken Whether to use a user token when displaying this group image.
+ * True indicates to generate a token for current user, and integer value indicates to generate a token for the
+ * user whose id is the value indicated.
+ * If the group picture is included in an e-mail or some other location where the audience is a specific
+ * user who will not be logged in when viewing, then we use a token to authenticate the user.
+ * @return url
+ */
+ public static function make_pluginfile_url(
+ $contextid,
+ $component,
+ $area,
+ $itemid,
+ $pathname,
+ $filename,
+ $forcedownload = false,
+ $includetoken = false
+ ) {
+ global $CFG, $USER;
+
+ $path = [];
+
+ if ($includetoken) {
+ $urlbase = "$CFG->wwwroot/tokenpluginfile.php";
+ $userid = $includetoken === true ? $USER->id : $includetoken;
+ $token = get_user_key('core_files', $userid);
+ if ($CFG->slasharguments) {
+ $path[] = $token;
+ }
+ } else {
+ $urlbase = "$CFG->wwwroot/pluginfile.php";
+ }
+ $path[] = $contextid;
+ $path[] = $component;
+ $path[] = $area;
+
+ if ($itemid !== null) {
+ $path[] = $itemid;
+ }
+
+ $path = "/" . implode('/', $path) . "{$pathname}{$filename}";
+
+ $url = self::make_file_url($urlbase, $path, $forcedownload, $includetoken);
+ if ($includetoken && empty($CFG->slasharguments)) {
+ $url->param('token', $token);
+ }
+ return $url;
+ }
+
+ /**
+ * Factory method for creation of url pointing to plugin file.
+ * This method is the same that make_pluginfile_url but pointing to the webservice pluginfile.php script.
+ * It should be used only in external functions.
+ *
+ * @since 2.8
+ * @param int $contextid
+ * @param string $component
+ * @param string $area
+ * @param int $itemid
+ * @param string $pathname
+ * @param string $filename
+ * @param bool $forcedownload
+ * @return url
+ */
+ public static function make_webservice_pluginfile_url(
+ $contextid,
+ $component,
+ $area,
+ $itemid,
+ $pathname,
+ $filename,
+ $forcedownload = false
+ ) {
+ global $CFG;
+ $urlbase = "$CFG->wwwroot/webservice/pluginfile.php";
+ if ($itemid === null) {
+ return self::make_file_url($urlbase, "/$contextid/$component/$area" . $pathname . $filename, $forcedownload);
+ } else {
+ return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid" . $pathname . $filename, $forcedownload);
+ }
+ }
+
+ /**
+ * Factory method for creation of url pointing to draft file of current user.
+ *
+ * @param int $draftid draft item id
+ * @param string $pathname
+ * @param string $filename
+ * @param bool $forcedownload
+ * @return url
+ */
+ public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
+ global $CFG, $USER;
+ $urlbase = "$CFG->wwwroot/draftfile.php";
+ $context = context_user::instance($USER->id);
+
+ return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid" . $pathname . $filename, $forcedownload);
+ }
+
+ /**
+ * Factory method for creating of links to legacy course files.
+ *
+ * @param int $courseid
+ * @param string $filepath
+ * @param bool $forcedownload
+ * @return url
+ */
+ public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
+ global $CFG;
+
+ $urlbase = "$CFG->wwwroot/file.php";
+ return self::make_file_url($urlbase, '/' . $courseid . '/' . $filepath, $forcedownload);
+ }
+
+ /**
+ * Checks if URL is relative to $CFG->wwwroot.
+ *
+ * @return bool True if URL is relative to $CFG->wwwroot; otherwise, false.
+ */
+ public function is_local_url(): bool {
+ global $CFG;
+
+ $url = $this->out();
+ // Does URL start with wwwroot? Otherwise, URL isn't relative to wwwroot.
+ return ( ($url === $CFG->wwwroot) || (strpos($url, $CFG->wwwroot . '/') === 0) );
+ }
+
+ /**
+ * Returns URL as relative path from $CFG->wwwroot
+ *
+ * Can be used for passing around urls with the wwwroot stripped
+ *
+ * @param boolean $escaped Use & as params separator instead of plain &
+ * @param ?array $overrideparams params to add to the output url, these override existing ones with the same name.
+ * @return string Resulting URL
+ * @throws coding_exception if called on a non-local url
+ */
+ public function out_as_local_url($escaped = true, ?array $overrideparams = null) {
+ global $CFG;
+
+ // URL should be relative to wwwroot. If not then throw exception.
+ if ($this->is_local_url()) {
+ $url = $this->out($escaped, $overrideparams);
+ $localurl = substr($url, strlen($CFG->wwwroot));
+ return !empty($localurl) ? $localurl : '';
+ } else {
+ throw new coding_exception('out_as_local_url called on a non-local URL');
+ }
+ }
+
+ /**
+ * Returns the 'path' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return '/my/file/is/here.txt'.
+ *
+ * By default the path includes slash-arguments (for example,
+ * '/myfile.php/extra/arguments') so it is what you would expect from a
+ * URL path. If you don't want this behaviour, you can opt to exclude the
+ * slash arguments. (Be careful: if the $CFG variable slasharguments is
+ * disabled, these URLs will have a different format and you may need to
+ * look at the 'file' parameter too.)
+ *
+ * @param bool $includeslashargument If true, includes slash arguments
+ * @return string Path of URL
+ */
+ public function get_path($includeslashargument = true) {
+ return $this->path . ($includeslashargument ? $this->slashargument : '');
+ }
+
+ /**
+ * Returns a given parameter value from the URL.
+ *
+ * @param string $name Name of parameter
+ * @return string Value of parameter or null if not set
+ */
+ public function get_param($name) {
+ if (array_key_exists($name, $this->params)) {
+ return $this->params[$name];
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Returns the 'scheme' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return 'http' (without the colon).
+ *
+ * @return string Scheme of the URL.
+ */
+ public function get_scheme() {
+ return $this->scheme;
+ }
+
+ /**
+ * Returns the 'host' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return 'www.example.org'.
+ *
+ * @return string Host of the URL.
+ */
+ public function get_host() {
+ return $this->host;
+ }
+
+ /**
+ * Returns the 'port' portion of a URL. For example, if the URL is
+ * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
+ * return '447'.
+ *
+ * @return string Port of the URL.
+ */
+ public function get_port() {
+ return $this->port;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(url::class, \moodle_url::class);
diff --git a/lib/completionlib.php b/lib/completionlib.php
index 95ed97a4f1220..b18d4768b58cc 100644
--- a/lib/completionlib.php
+++ b/lib/completionlib.php
@@ -1631,11 +1631,12 @@ public function get_completion_data(int $coursemoduleid, int $userid, array $def
$data->coursemoduleid = $data->cmvcoursemoduleid;
$data->userid = $data->cmvuserid;
}
+ // When reseting all state in the completion, we need to keep current view state.
+ // We cannot assume the activity has been viewed, so we should check if there is any course_modules_viewed already.
+ $data->viewed = is_null($data->cmvuserid) ? 0 : 1;
+
unset($data->cmvcoursemoduleid);
unset($data->cmvuserid);
-
- // When reseting all state in the completion, we need to keep current view state.
- $data->viewed = 1;
}
return (array)$data;
diff --git a/lib/components.json b/lib/components.json
index 651654cc583b4..72680af683e9d 100644
--- a/lib/components.json
+++ b/lib/components.json
@@ -109,6 +109,7 @@
"privacy": "privacy",
"question": "question",
"rating": "rating",
+ "report": "report",
"reportbuilder": "reportbuilder",
"repository": "repository",
"rss": "rss",
diff --git a/lib/db/access.php b/lib/db/access.php
index 69b687aef83a3..eda798dd5b1ed 100644
--- a/lib/db/access.php
+++ b/lib/db/access.php
@@ -2748,4 +2748,14 @@
'manager' => CAP_ALLOW,
]
],
+
+ // Allow users to edit course welcome messages.
+ 'moodle/course:editcoursewelcomemessage' => [
+ 'captype' => 'write',
+ 'contextlevel' => CONTEXT_COURSE,
+ 'archetypes' => [
+ 'editingteacher' => CAP_ALLOW,
+ 'manager' => CAP_ALLOW,
+ ],
+ ],
);
diff --git a/lib/db/legacyclasses.php b/lib/db/legacyclasses.php
index 75076d95c3217..9a244e4b5a37f 100644
--- a/lib/db/legacyclasses.php
+++ b/lib/db/legacyclasses.php
@@ -27,10 +27,17 @@
defined('MOODLE_INTERNAL') || die();
// Like other files in the db directory this file uses an array.
-// The old class name is the key, the path to the file containing the class is the vlaue.
+// The old class name is the key, the path to the file containing the class is the value.
// The array must be called $legacyclasses.
$legacyclasses = [
\bootstrap_renderer::class => 'output/bootstrap_renderer.php',
+
+ // Core API.
+ \emoticon_manager::class => 'emoticon_manager.php',
+ \lang_string::class => 'lang_string.php',
+ \moodle_url::class => 'url.php',
+
+ // Exception API.
\coding_exception::class => 'exception/coding_exception.php',
\file_serving_exception::class => 'exception/file_serving_exception.php',
\invalid_dataroot_permissions::class => 'exception/invalid_dataroot_permissions.php',
@@ -42,4 +49,113 @@
\require_login_session_timeout_exception::class => 'exception/require_login_session_timeout_exception.php',
\required_capability_exception::class => 'exception/required_capability_exception.php',
\webservice_parameter_exception::class => 'exception/webservice_parameter_exception.php',
+
+ // Output API.
+ \theme_config::class => 'output/theme_config.php',
+ \xhtml_container_stack::class => 'output/xhtml_container_stack.php',
+
+ \renderable::class => 'output/renderable.php',
+ \templatable::class => 'output/templatable.php',
+
+ // Output API: Renderer Factories.
+ \renderer_factory::class => 'output/renderer_factory/renderer_factory_interface.php',
+ \renderer_factory_base::class => 'output/renderer_factory/renderer_factory_base.php',
+ \standard_renderer_factory::class => 'output/renderer_factory/standard_renderer_factory.php',
+ \theme_overridden_renderer_factory::class => 'output/renderer_factory/theme_overridden_renderer_factory.php',
+
+ // Output API: Renderers.
+ \renderer_base::class => 'output/renderer_base.php',
+ \plugin_renderer_base::class => 'output/plugin_renderer_base.php',
+ \core_renderer::class => 'output/core_renderer.php',
+ \core_renderer_cli::class => 'output/core_renderer_cli.php',
+ \core_renderer_ajax::class => 'output/core_renderer_ajax.php',
+ \core_renderer_maintenance::class => 'output/core_renderer_maintenance.php',
+ \page_requirements_manager::class => 'output/requirements/page_requirements_manager.php',
+ \YUI_config::class => 'output/requirements/yui.php',
+ \fragment_requirements_manager::class => 'output/requirements/fragment_requirements_manager.php',
+
+ // Output API: components.
+ \file_picker::class => 'output/file_picker.php',
+ \user_picture::class => 'output/user_picture.php',
+ \help_icon::class => 'output/help_icon.php',
+ \pix_icon_font::class => 'output/pix_icon_font.php',
+ \pix_icon_fontawesome::class => 'output/pix_icon_fontawesome.php',
+ \pix_icon::class => 'output/pix_icon.php',
+ \image_icon::class => 'output/image_icon.php',
+ \pix_emoticon::class => 'output/pix_emoticon.php',
+ \single_button::class => 'output/single_button.php',
+ \single_select::class => 'output/single_select.php',
+ \url_select::class => 'output/url_select.php',
+ \action_link::class => 'output/action_link.php',
+ \html_writer::class => 'output/html_writer.php',
+ \js_writer::class => 'output/js_writer.php',
+ \paging_bar::class => 'output/paging_bar.php',
+ \initials_bar::class => 'output/initials_bar.php',
+ \custom_menu_item::class => 'output/custom_menu_item.php',
+ \custom_menu::class => 'output/custom_menu.php',
+ \tabobject::class => 'output/tabobject.php',
+ \context_header::class => 'output/context_header.php',
+ \tabtree::class => 'output/tabtree.php',
+ \action_menu::class => 'output/action_menu.php',
+ \action_menu_filler::class => 'output/action_menu/filler.php',
+ \action_menu_link::class => 'output/action_menu/link.php',
+ \action_menu_link_primary::class => 'output/action_menu/link_primary.php',
+ \action_menu_link_secondary::class => 'output/action_menu/link_secondary.php',
+ \core\output\local\action_menu\subpanel::class => 'output/action_menu/subpanel.php',
+ \preferences_groups::class => 'output/preferences_groups.php',
+ \preferences_group::class => 'output/preferences_group.php',
+ \progress_bar::class => 'output/progress_bar.php',
+ \component_action::class => 'output/actions/component_action.php',
+ \confirm_action::class => 'output/actions/confirm_action.php',
+ \popup_action::class => 'output/actions/popup_action.php',
+
+ // Block Subsystem.
+ \block_contents::class => [
+ 'core_block',
+ 'output/block_contents.php',
+ ],
+ \block_move_target::class => [
+ 'core_block',
+ 'output/block_move_target.php',
+ ],
+
+ // Table Subsystem.
+ \html_table::class => [
+ 'core_table',
+ 'output/html_table.php',
+ ],
+ \html_table_row::class => [
+ 'core_table',
+ 'output/html_table_row.php',
+ ],
+ \html_table_cell::class => [
+ 'core_table',
+ 'output/html_table_cell.php',
+ ],
+ \flexible_table::class => [
+ 'core_table',
+ 'flexible_table.php',
+ ],
+ \table_sql::class => [
+ 'core_table',
+ 'sql_table.php',
+ ],
+ \table_default_export_format_parent::class => [
+ 'core_table',
+ 'base_export_format.php',
+ ],
+ \table_dataformat_export_format::class => [
+ 'core_table',
+ 'dataformat_export_format.php',
+ ],
+
+ // The progress_trace classes.
+ \combined_progress_trace::class => 'output/progress_trace/combined_progress_trace.php',
+ \error_log_progress_trace::class => 'output/progress_trace/error_log_progress_trace.php',
+ \html_list_progress_trace::class => 'output/progress_trace/html_list_progress_trace.php',
+ \html_progress_trace::class => 'output/progress_trace/html_progress_trace.php',
+ \null_progress_trace::class => 'output/progress_trace/null_progress_trace.php',
+ \progress_trace::class => 'output/progress_trace.php',
+ \progress_trace_buffer::class => 'output/progress_trace/progress_trace_buffer.php',
+ \text_progress_trace::class => 'output/progress_trace/text_progress_trace.php',
];
diff --git a/lib/db/services.php b/lib/db/services.php
index 0fffbe9295f0a..feb0ce346c4d9 100644
--- a/lib/db/services.php
+++ b/lib/db/services.php
@@ -373,7 +373,8 @@
'classpath' => 'cohort/externallib.php',
'description' => 'Deletes all specified cohorts.',
'type' => 'write',
- 'capabilities' => 'moodle/cohort:manage'
+ 'capabilities' => 'moodle/cohort:manage',
+ 'ajax' => true,
),
'core_cohort_get_cohort_members' => array(
'classname' => 'core_cohort_external',
diff --git a/lib/db/tasks.php b/lib/db/tasks.php
index 905c73f06e360..0a9548e4b45dc 100644
--- a/lib/db/tasks.php
+++ b/lib/db/tasks.php
@@ -466,4 +466,14 @@
'month' => '*',
'dayofweek' => '*',
],
+ [
+ 'classname' => 'core\task\update_geoip2file_task',
+ 'blocking' => 0,
+ 'minute' => '0',
+ 'hour' => 'R',
+ 'day' => '*',
+ 'month' => '*',
+ 'dayofweek' => 'R',
+ 'disabled' => true,
+ ],
);
diff --git a/lib/dml/tests/dml_read_slave_test.php b/lib/dml/tests/dml_read_slave_test.php
index 9d7514629263c..5bd00d0ab9471 100644
--- a/lib/dml/tests/dml_read_slave_test.php
+++ b/lib/dml/tests/dml_read_slave_test.php
@@ -291,8 +291,6 @@ public function test_read_excluded_tables(): void {
* so the latency parameter is applied properly.
*
* @return void
- * @covers ::can_use_readonly
- * @covers ::commit_delegated_transaction
*/
public function test_transaction(): void {
$DB = $this->new_db(true);
@@ -339,8 +337,6 @@ public function test_transaction(): void {
* so the latency parameter is applied properly.
*
* @return void
- * @covers ::can_use_readonly
- * @covers ::query_end
*/
public function test_long_update(): void {
$DB = $this->new_db(true);
@@ -382,8 +378,6 @@ public function test_long_update(): void {
* when the latency parameter is applied properly.
*
* @return void
- * @covers ::can_use_readonly
- * @covers ::commit_delegated_transaction
*/
public function test_transaction_with_events(): void {
$this->with_global_db(function () {
diff --git a/lib/dml/tests/dml_test.php b/lib/dml/tests/dml_test.php
index f131a84ce3eff..33383df8aa280 100644
--- a/lib/dml/tests/dml_test.php
+++ b/lib/dml/tests/dml_test.php
@@ -530,8 +530,6 @@ public function test_add_sql_debugging(): void {
/**
* Test the database debugging as SQL comment in anon class
- *
- * @covers ::add_sql_debugging
*/
public function test_sql_debugging_anon_class(): void {
global $CFG;
@@ -3924,8 +3922,6 @@ public function test_sql_ceil(): void {
/**
* Test DML libraries sql_cast_to_char method
- *
- * @covers ::sql_cast_to_char
*/
public function test_cast_to_char(): void {
$DB = $this->tdb;
diff --git a/lib/dml/tests/pgsql_native_moodle_database_test.php b/lib/dml/tests/pgsql_native_moodle_database_test.php
index 476d9eae76a3d..a2e12ae7ecaf6 100644
--- a/lib/dml/tests/pgsql_native_moodle_database_test.php
+++ b/lib/dml/tests/pgsql_native_moodle_database_test.php
@@ -395,9 +395,6 @@ public function new_connection($ssl) {
/**
* Test SSL connection.
- *
- * @return void
- * @covers ::raw_connect
*/
public function test_ssl_connection(): void {
$pgconnerr = 'pg_connect(): Unable to connect to PostgreSQL server:';
diff --git a/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature b/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature
index 8b96d75ed4358..74b4a2e387db8 100644
--- a/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature
+++ b/lib/editor/tiny/plugins/noautolink/tests/behat/noautolink.feature
@@ -7,7 +7,9 @@ Feature: Tiny noautolink
Background:
Given I log in as "admin"
And I navigate to "Plugins > Text editors > TinyMCE editor > General settings" in site administration
- And I click on "Enable No auto-link" "link"
+ And I toggle the "Enable No auto-link" admin switch "on"
+ When I open my profile in edit mode
+ And I set the field "Description" to "\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {getString, getStrings} from 'core/str';\nimport {component} from './common';\nimport Pending from 'core/pending';\nimport {getData} from './options';\nimport uploadFile from 'editor_tiny/uploader';\nimport {add as addToast} from 'core/toast';\nimport * as ModalEvents from 'core/modal_events';\nimport * as Templates from 'core/templates';\nimport {saveCancelPromise} from 'core/notification';\nimport {prefetchStrings, prefetchTemplates} from 'core/prefetch';\nimport AlertModal from 'core/local/modal/alert';\n\n/**\n * The RecordRTC base class for audio, video, and any other future types\n */\nexport default class {\n\n stopRequested = false;\n\n /**\n * Constructor for the RecordRTC class\n *\n * @param {TinyMCE} editor The Editor to which the content will be inserted\n * @param {Modal} modal The Moodle Modal that contains the interface used for recording\n */\n constructor(editor, modal) {\n this.ready = false;\n\n if (!this.checkAndWarnAboutBrowserCompatibility()) {\n return;\n }\n\n this.editor = editor;\n this.config = getData(editor).params;\n this.modal = modal;\n this.modalRoot = modal.getRoot()[0];\n this.startStopButton = this.modalRoot.querySelector('button[data-action=\"startstop\"]');\n this.uploadButton = this.modalRoot.querySelector('button[data-action=\"upload\"]');\n\n // Disable the record button untilt he stream is acquired.\n this.setRecordButtonState(false);\n\n this.player = this.configurePlayer();\n this.registerEventListeners();\n this.ready = true;\n\n this.captureUserMedia();\n this.prefetchContent();\n }\n\n /**\n * Check whether the browser is compatible.\n *\n * @returns {boolean}\n */\n isReady() {\n return this.ready;\n }\n\n // Disable eslint's valid-jsdoc rule as the following methods are abstract and mnust be overridden by the child class.\n\n /* eslint-disable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the Player element for this type.\n *\n * @returns {HTMLElement} The player element, typically an audio or video tag.\n */\n configurePlayer() {\n throw new Error(`configurePlayer() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the list of supported mimetypes for this recorder.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/isTypeSupported}\n *\n * @returns {string[]} The list of supported mimetypes.\n */\n getSupportedTypes() {\n throw new Error(`getSupportedTypes() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get any recording options passed into the MediaRecorder.\n * Please note that the mimeType will be fetched from {@link getSupportedTypes()}.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder#options}\n * @returns {Object}\n */\n getRecordingOptions() {\n throw new Error(`getRecordingOptions() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a filename for the generated file.\n *\n * Typically this function will take a prefix and add a type-specific suffix such as the extension to it.\n *\n * @param {string} prefix The prefix for the filename generated by the recorder.\n * @returns {string}\n */\n getFileName(prefix) {\n throw new Error(`getFileName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a list of constraints as required by the getUserMedia() function.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#constraints}\n *\n * @returns {Object}\n */\n getMediaConstraints() {\n throw new Error(`getMediaConstraints() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Whether to start playing the recording as it is captured.\n * @returns {boolean} Whether to start playing the recording as it is captured.\n */\n playOnCapture() {\n return false;\n }\n\n /**\n * Get the time limit for this recording type.\n *\n * @returns {number} The time limit in seconds.\n */\n getTimeLimit() {\n throw new Error(`getTimeLimit() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the name of the template used when embedding the URL in the editor content.\n *\n * @returns {string}\n */\n getEmbedTemplateName() {\n throw new Error(`getEmbedTemplateName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Fetch the Class of the Modal to be displayed.\n *\n * @returns {Modal}\n */\n static getModalClass() {\n throw new Error(`getModalClass() must be implemented in ${this.constructor.name}`);\n }\n\n /* eslint-enable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the options for the MediaRecorder.\n *\n * @returns {object} The options for the MediaRecorder instance.\n */\n getParsedRecordingOptions() {\n const requestedTypes = this.getSupportedTypes();\n const possibleTypes = requestedTypes.reduce((result, type) => {\n result.push(type);\n // Safari seems to use codecs: instead of codecs=.\n // It is safe to add both, so we do, but we want them to remain in order.\n result.push(type.replace('=', ':'));\n return result;\n }, []);\n\n const compatTypes = possibleTypes.filter((type) => window.MediaRecorder.isTypeSupported(type));\n\n const options = this.getRecordingOptions();\n if (compatTypes.length !== 0) {\n options.mimeType = compatTypes[0];\n }\n window.console.info(\n `Selected codec ${options.mimeType} from ${compatTypes.length} options.`,\n compatTypes,\n );\n\n return options;\n }\n\n /**\n * Start capturing the User Media and handle success or failure of the capture.\n */\n async captureUserMedia() {\n try {\n const stream = await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());\n this.handleCaptureSuccess(stream);\n } catch (error) {\n this.handleCaptureFailure(error);\n }\n }\n\n /**\n * Prefetch some of the content that will be used in the UI.\n *\n * Note: not all of the strings used are pre-fetched.\n * Some of the strings will be fetched because their template is used.\n */\n prefetchContent() {\n prefetchStrings(component, [\n 'uploading',\n 'recordagain_title',\n 'recordagain_desc',\n 'discard_title',\n 'discard_desc',\n 'confirm_yes',\n 'recordinguploaded',\n 'maxfilesizehit',\n 'maxfilesizehit_title',\n 'uploadfailed',\n ]);\n\n prefetchTemplates([\n this.getEmbedTemplateName(),\n 'tiny_recordrtc/timeremaining',\n ]);\n }\n\n /**\n * Display an error message to the user.\n *\n * @param {Promise} title The error title\n * @param {Promise} content The error message\n * @returns {Promise}\n */\n async displayAlert(title, content) {\n const pendingPromise = new Pending('core/confirm:alert');\n const modal = await AlertModal.create({\n title: title,\n body: content,\n removeOnClose: true,\n });\n\n modal.show();\n pendingPromise.resolve();\n\n return modal;\n }\n\n /**\n * Handle successful capture of the User Media.\n *\n * @param {MediaStream} stream The stream as captured by the User Media.\n */\n handleCaptureSuccess(stream) {\n // Set audio player source to microphone stream.\n this.player.srcObject = stream;\n\n if (this.playOnCapture()) {\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n\n this.stream = stream;\n this.setupPlayerSource();\n this.setRecordButtonState(true);\n }\n\n /**\n * Setup the player to use the stream as a source.\n */\n setupPlayerSource() {\n if (!this.player.srcObject) {\n this.player.srcObject = this.stream;\n\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n }\n\n /**\n * Enable the record button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setRecordButtonState(enabled) {\n this.startStopButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the record button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setRecordButtonVisibility(visible) {\n const container = this.getButtonContainer('start-stop');\n container.classList.toggle('hide', !visible);\n }\n\n /**\n * Enable the upload button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setUploadButtonState(enabled) {\n this.uploadButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the upload button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setUploadButtonVisibility(visible) {\n const container = this.getButtonContainer('upload');\n container.classList.toggle('hide', !visible);\n }\n /**\n * Handle failure to capture the User Media.\n *\n * @param {Error} error\n */\n handleCaptureFailure(error) {\n // Changes 'CertainError' -> 'gumcertain' to match language string names.\n var subject = `gum${error.name.replace('Error', '').toLowerCase()}`;\n this.displayAlert(\n getString(`${subject}_title`, component),\n getString(subject, component)\n );\n }\n\n /**\n * Close the modal and stop recording.\n */\n close() {\n // Closing the modal will destroy it and remove it from the DOM.\n // It will also stop the recording via the hidden Modal Event.\n this.modal.hide();\n }\n\n /**\n * Register event listeners for the modal.\n */\n registerEventListeners() {\n this.modalRoot.addEventListener('click', this.handleModalClick.bind(this));\n this.modal.getRoot().on(ModalEvents.outsideClick, this.outsideClickHandler.bind(this));\n this.modal.getRoot().on(ModalEvents.hidden, () => {\n this.cleanupStream();\n this.requestRecordingStop();\n });\n }\n\n /**\n * Prevent the Modal from closing when recording is on process.\n *\n * @param {MouseEvent} event The click event\n */\n async outsideClickHandler(event) {\n if (this.isRecording()) {\n // The user is recording.\n // Do not distract with a confirmation, just prevent closing.\n event.preventDefault();\n } else if (this.hasData()) {\n // If there is a blobsize then there is data that may be lost.\n // Ask the user to confirm they want to close the modal.\n // We prevent default here, and then close the modal if they confirm.\n event.preventDefault();\n\n try {\n await saveCancelPromise(\n await getString(\"discard_title\", component),\n await getString(\"discard_desc\", component),\n await getString(\"confirm_yes\", component),\n );\n this.modal.hide();\n } catch (error) {\n // Do nothing, the modal will not close.\n }\n }\n }\n\n /**\n * Handle a click within the Modal.\n *\n * @param {MouseEvent} event The click event\n */\n handleModalClick(event) {\n const button = event.target.closest('button');\n if (button && button.dataset.action) {\n const action = button.dataset.action;\n if (action === 'startstop') {\n this.handleRecordingStartStopRequested();\n }\n\n if (action === 'upload') {\n this.uploadRecording();\n }\n }\n }\n\n /**\n * Handle the click event for the recording start/stop button.\n */\n handleRecordingStartStopRequested() {\n if (this.mediaRecorder?.state === 'recording') {\n this.requestRecordingStop();\n } else {\n this.startRecording();\n }\n }\n\n /**\n * Handle the media stream after it has finished.\n */\n async onMediaStopped() {\n // Set source of audio player.\n this.blob = new Blob(this.data.chunks, {\n type: this.mediaRecorder.mimeType\n });\n this.player.srcObject = null;\n this.player.src = URL.createObjectURL(this.blob);\n\n // Change the label to \"Record again\".\n this.setRecordButtonTextFromString('recordagain');\n\n // Show audio player with controls enabled, and unmute.\n this.player.muted = false;\n this.player.controls = true;\n this.getButtonContainer('player')?.classList.toggle('hide', false);\n\n // Show upload button.\n this.setUploadButtonVisibility(true);\n this.setUploadButtonState(true);\n }\n\n /**\n * Upload the recording and insert it into the editor content.\n */\n async uploadRecording() {\n // Trigger error if no recording has been made.\n if (this.data.chunks.length === 0) {\n this.displayAlert('norecordingfound');\n return;\n }\n\n const fileName = this.getFileName((Math.random() * 1000).toString().replace('.', ''));\n\n // Upload recording to server.\n try {\n // Once uploading starts, do not allow any further changes to the recording.\n this.setRecordButtonVisibility(false);\n\n // Disable the upload button.\n this.setUploadButtonState(false);\n\n // Upload the recording.\n const fileURL = await uploadFile(this.editor, 'media', this.blob, fileName, (progress) => {\n this.setUploadButtonTextProgress(progress);\n });\n this.insertMedia(fileURL);\n this.close();\n addToast(await getString('recordinguploaded', component));\n } catch (error) {\n // Show a toast and unhide the button.\n this.setUploadButtonState(true);\n\n addToast(await getString('uploadfailed', component, {error}), {\n type: 'error',\n });\n\n }\n }\n\n /**\n * Helper to get the container that a button is in.\n *\n * @param {string} purpose The button purpose\n * @returns {HTMLElement}\n */\n getButtonContainer(purpose) {\n return this.modalRoot.querySelector(`[data-purpose=\"${purpose}-container\"]`);\n }\n\n /**\n * Check whether the browser is compatible with capturing media.\n *\n * @returns {boolean}\n */\n static isBrowserCompatible() {\n return this.checkSecure() && this.hasUserMedia();\n }\n\n static async display(editor) {\n const ModalClass = this.getModalClass();\n const modal = await ModalClass.create({\n templateContext: {},\n large: true,\n removeOnClose: true,\n });\n\n // Set up the VideoRecorder.\n const recorder = new this(editor, modal);\n if (recorder.isReady()) {\n modal.show();\n }\n return modal;\n }\n\n /**\n * Check whether the browser is compatible with capturing media, and display a warning if not.\n *\n * @returns {boolean}\n */\n checkAndWarnAboutBrowserCompatibility() {\n if (!this.constructor.checkSecure()) {\n getStrings(['insecurealert_title', 'insecurealert'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n if (!this.constructor.hasUserMedia) {\n getStrings(['nowebrtc_title', 'nowebrtc'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n return true;\n }\n\n /**\n * Check whether the browser supports WebRTC.\n *\n * @returns {boolean}\n */\n static hasUserMedia() {\n return (navigator.mediaDevices && window.MediaRecorder);\n }\n\n /**\n * Check whether the hostname is either hosted over SSL, or from a valid localhost hostname.\n *\n * The UserMedia API can only be used in secure contexts as noted.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#privacy_and_security}\n *\n * @returns {boolean} Whether the plugin can be loaded.\n */\n static checkSecure() {\n // Note: We can now use window.isSecureContext.\n // https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts#feature_detection\n // https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext\n return window.isSecureContext;\n }\n\n /**\n * Update the content of the stop recording button timer.\n */\n async setStopRecordingButton() {\n const {html, js} = await Templates.renderForPromise('tiny_recordrtc/timeremaining', this.getTimeRemaining());\n Templates.replaceNodeContents(this.startStopButton, html, js);\n this.buttonTimer = setInterval(this.updateRecordButtonTime.bind(this), 500);\n }\n\n /**\n * Update the time on the stop recording button.\n */\n updateRecordButtonTime() {\n const {remaining, minutes, seconds} = this.getTimeRemaining();\n if (remaining < 0) {\n this.requestRecordingStop();\n } else {\n this.startStopButton.querySelector('[data-type=\"minutes\"]').textContent = minutes;\n this.startStopButton.querySelector('[data-type=\"seconds\"]').textContent = seconds;\n }\n }\n\n /**\n * Set the text of the record button using a language string.\n *\n * @param {string} string The string identifier\n */\n async setRecordButtonTextFromString(string) {\n this.startStopButton.textContent = await getString(string, component);\n }\n\n /**\n * Set the upload button text progress.\n *\n * @param {number} progress The progress\n */\n async setUploadButtonTextProgress(progress) {\n this.uploadButton.textContent = await getString('uploading', component, {\n progress: Math.round(progress * 100) / 100,\n });\n }\n\n async resetUploadButtonText() {\n this.uploadButton.textContent = await getString('upload', component);\n }\n\n /**\n * Clear the timer for the stop recording button.\n */\n clearButtonTimer() {\n if (this.buttonTimer) {\n clearInterval(this.buttonTimer);\n }\n this.buttonTimer = null;\n }\n\n /**\n * Get the time remaining for the recording.\n *\n * @returns {Object} The minutes and seconds remaining.\n */\n getTimeRemaining() {\n // All times are in milliseconds\n const now = new Date().getTime();\n const remaining = Math.floor(this.getTimeLimit() - ((now - this.startTime) / 1000));\n\n const formatter = new Intl.NumberFormat(navigator.language, {minimumIntegerDigits: 2});\n const seconds = formatter.format(remaining % 60);\n const minutes = formatter.format(Math.floor((remaining - seconds) / 60));\n return {\n remaining,\n minutes,\n seconds,\n };\n }\n\n /**\n * Get the maximum file size that can be uploaded.\n *\n * @returns {number} The max byte size\n */\n getMaxUploadSize() {\n return this.config.maxrecsize;\n }\n\n /**\n * Stop the recording.\n * Please note that this should only stop the recording.\n * Anything related to processing the recording should be handled by the\n * mediaRecorder's stopped event handler which is processed after it has stopped.\n */\n requestRecordingStop() {\n if (this.mediaRecorder && this.mediaRecorder.state !== 'inactive') {\n this.stopRequested = true;\n } else {\n // There is no recording to stop, but the stream must still be cleaned up.\n this.cleanupStream();\n }\n }\n\n stopRecorder() {\n this.mediaRecorder.stop();\n\n // Unmute the player so that the audio is heard during playback.\n this.player.muted = false;\n }\n\n /**\n * Clean up the stream.\n *\n * This involves stopping any track which is still active.\n */\n cleanupStream() {\n if (this.stream) {\n this.stream.getTracks()\n .filter((track) => track.readyState !== 'ended')\n .forEach((track) => track.stop());\n }\n }\n\n /**\n * Handle the mediaRecorder `stop` event.\n */\n handleStopped() {\n // Handle the stream data.\n this.onMediaStopped();\n\n // Clear the button timer.\n this.clearButtonTimer();\n }\n\n /**\n * Handle the mediaRecorder `start` event.\n *\n * This event is called when the recording starts.\n */\n handleStarted() {\n this.startTime = new Date().getTime();\n this.setStopRecordingButton();\n }\n\n /**\n * Handle the mediaRecorder `dataavailable` event.\n *\n * @param {Event} event\n */\n handleDataAvailable(event) {\n if (this.isRecording()) {\n const newSize = this.data.blobSize + event.data.size;\n // Recording stops when either the maximum upload size is reached, or the time limit expires.\n // The time limit is checked in the `updateButtonTime` function.\n if (newSize >= this.getMaxUploadSize()) {\n this.stopRecorder();\n this.displayFileLimitHitMessage();\n } else {\n // Push recording slice to array.\n this.data.chunks.push(event.data);\n\n // Size of all recorded data so far.\n this.data.blobSize = newSize;\n\n if (this.stopRequested) {\n this.stopRecorder();\n }\n }\n }\n }\n\n async displayFileLimitHitMessage() {\n addToast(await getString('maxfilesizehit', component), {\n title: await getString('maxfilesizehit_title', component),\n type: 'error',\n });\n }\n\n /**\n * Check whether the recording is in progress.\n *\n * @returns {boolean}\n */\n isRecording() {\n return this.mediaRecorder?.state === 'recording';\n }\n\n /**\n * Whether any data has been recorded.\n *\n * @returns {boolean}\n */\n hasData() {\n return !!this.data?.blobSize;\n }\n\n /**\n * Start the recording\n */\n async startRecording() {\n if (this.mediaRecorder) {\n // Stop the existing recorder if it exists.\n if (this.isRecording()) {\n this.mediaRecorder.stop();\n }\n\n if (this.hasData()) {\n const resetRecording = await this.recordAgainConfirmation();\n if (!resetRecording) {\n // User cancelled at the confirmation to reset the data, so exit early.\n return;\n }\n this.setUploadButtonVisibility(false);\n if (!this.stream.active) {\n await this.captureUserMedia();\n }\n }\n\n this.mediaRecorder = null;\n }\n\n // The options for the recording codecs and bitrates.\n this.mediaRecorder = new MediaRecorder(this.stream, this.getParsedRecordingOptions());\n\n this.mediaRecorder.addEventListener('dataavailable', this.handleDataAvailable.bind(this));\n this.mediaRecorder.addEventListener('stop', this.handleStopped.bind(this));\n this.mediaRecorder.addEventListener('start', this.handleStarted.bind(this));\n\n this.data = {\n chunks: [],\n blobSize: 0\n };\n this.setupPlayerSource();\n this.stopRequested = false;\n\n // Capture in 50ms chunks.\n this.mediaRecorder.start(50);\n }\n\n /**\n * Confirm whether the user wants to reset the existing recoring.\n *\n * @returns {Promise} Whether the user confirmed the reset.\n */\n async recordAgainConfirmation() {\n try {\n await saveCancelPromise(\n await getString(\"recordagain_title\", component),\n await getString(\"recordagain_desc\", component),\n await getString(\"confirm_yes\", component)\n );\n return true;\n } catch {\n return false;\n }\n }\n\n /**\n * Insert the HTML to embed the recording into the editor content.\n *\n * @param {string} source The URL to view the media.\n */\n async insertMedia(source) {\n const {html} = await Templates.renderForPromise(\n this.getEmbedTemplateName(),\n this.getEmbedTemplateContext({\n source,\n })\n );\n this.editor.insertContent(html);\n }\n\n /**\n * Add or modify the template parameters for the specified type.\n *\n * @param {Object} templateContext The Tempalte context to use\n * @returns {Object} The finalised template context\n */\n getEmbedTemplateContext(templateContext) {\n return templateContext;\n }\n}\n"],"names":["constructor","editor","modal","ready","this","checkAndWarnAboutBrowserCompatibility","config","params","modalRoot","getRoot","startStopButton","querySelector","uploadButton","setRecordButtonState","player","configurePlayer","registerEventListeners","captureUserMedia","prefetchContent","isReady","Error","name","getSupportedTypes","getRecordingOptions","getFileName","prefix","getMediaConstraints","playOnCapture","getTimeLimit","getEmbedTemplateName","getParsedRecordingOptions","compatTypes","reduce","result","type","push","replace","filter","window","MediaRecorder","isTypeSupported","options","length","mimeType","console","info","stream","navigator","mediaDevices","getUserMedia","handleCaptureSuccess","error","handleCaptureFailure","component","title","content","pendingPromise","Pending","AlertModal","create","body","removeOnClose","show","resolve","srcObject","muted","play","setupPlayerSource","enabled","disabled","setRecordButtonVisibility","visible","getButtonContainer","classList","toggle","setUploadButtonState","setUploadButtonVisibility","subject","toLowerCase","displayAlert","close","hide","addEventListener","handleModalClick","bind","on","ModalEvents","outsideClick","outsideClickHandler","hidden","cleanupStream","requestRecordingStop","event","isRecording","preventDefault","hasData","button","target","closest","dataset","action","handleRecordingStartStopRequested","uploadRecording","mediaRecorder","state","startRecording","blob","Blob","data","chunks","src","URL","createObjectURL","setRecordButtonTextFromString","controls","fileName","Math","random","toString","fileURL","progress","setUploadButtonTextProgress","insertMedia","purpose","checkSecure","hasUserMedia","ModalClass","getModalClass","templateContext","large","map","key","then","_ref2","message","catch","_ref","isSecureContext","html","js","Templates","renderForPromise","getTimeRemaining","replaceNodeContents","buttonTimer","setInterval","updateRecordButtonTime","remaining","minutes","seconds","textContent","string","round","clearButtonTimer","clearInterval","now","Date","getTime","floor","startTime","formatter","Intl","NumberFormat","language","minimumIntegerDigits","format","getMaxUploadSize","maxrecsize","stopRequested","stopRecorder","stop","getTracks","track","readyState","forEach","handleStopped","onMediaStopped","handleStarted","setStopRecordingButton","handleDataAvailable","newSize","blobSize","size","displayFileLimitHitMessage","_this$data","recordAgainConfirmation","active","start","source","getEmbedTemplateContext","insertContent"],"mappings":"mrDAiDIA,YAAYC,OAAQC,gCARJ,+IASPC,OAAQ,EAERC,KAAKC,+CAILJ,OAASA,YACTK,QAAS,oBAAQL,QAAQM,YACzBL,MAAQA,WACRM,UAAYN,MAAMO,UAAU,QAC5BC,gBAAkBN,KAAKI,UAAUG,cAAc,wCAC/CC,aAAeR,KAAKI,UAAUG,cAAc,qCAG5CE,sBAAqB,QAErBC,OAASV,KAAKW,uBACdC,8BACAb,OAAQ,OAERc,wBACAC,mBAQTC,iBACWf,KAAKD,MAYhBY,wBACU,IAAIK,yDAAkDhB,KAAKJ,YAAYqB,OASjFC,0BACU,IAAIF,2DAAoDhB,KAAKJ,YAAYqB,OAUnFE,4BACU,IAAIH,6DAAsDhB,KAAKJ,YAAYqB,OAWrFG,YAAYC,cACF,IAAIL,qDAA8ChB,KAAKJ,YAAYqB,OAS7EK,4BACU,IAAIN,6DAAsDhB,KAAKJ,YAAYqB,OAOrFM,uBACW,EAQXC,qBACU,IAAIR,sDAA+ChB,KAAKJ,YAAYqB,OAQ9EQ,6BACU,IAAIT,8DAAuDhB,KAAKJ,YAAYqB,oCAS5E,IAAID,uDAAgDhB,KAAKJ,YAAYqB,OAU/ES,kCAUUC,YATiB3B,KAAKkB,oBACSU,QAAO,CAACC,OAAQC,QACjDD,OAAOE,KAAKD,MAGZD,OAAOE,KAAKD,KAAKE,QAAQ,IAAK,MACvBH,SACR,IAE+BI,QAAQH,MAASI,OAAOC,cAAcC,gBAAgBN,QAElFO,QAAUrC,KAAKmB,6BACM,IAAvBQ,YAAYW,SACZD,QAAQE,SAAWZ,YAAY,IAEnCO,OAAOM,QAAQC,8BACOJ,QAAQE,0BAAiBZ,YAAYW,oBACvDX,aAGGU,2CAQGK,aAAeC,UAAUC,aAAaC,aAAa7C,KAAKsB,4BACzDwB,qBAAqBJ,QAC5B,MAAOK,YACAC,qBAAqBD,QAUlCjC,gDACoBmC,kBAAW,CACvB,YACA,oBACA,mBACA,gBACA,eACA,cACA,oBACA,iBACA,uBACA,iDAGc,CACdjD,KAAKyB,uBACL,oDAWWyB,MAAOC,eAChBC,eAAiB,IAAIC,iBAAQ,sBAC7BvD,YAAcwD,eAAWC,OAAO,CAClCL,MAAOA,MACPM,KAAML,QACNM,eAAe,WAGnB3D,MAAM4D,OACNN,eAAeO,UAER7D,MAQXgD,qBAAqBJ,aAEZhC,OAAOkD,UAAYlB,OAEpB1C,KAAKuB,uBAEAb,OAAOmD,OAAQ,OAEfnD,OAAOoD,aAGXpB,OAASA,YACTqB,yBACAtD,sBAAqB,GAM9BsD,oBACS/D,KAAKU,OAAOkD,iBACRlD,OAAOkD,UAAY5D,KAAK0C,YAGxBhC,OAAOmD,OAAQ,OAEfnD,OAAOoD,QASpBrD,qBAAqBuD,cACZ1D,gBAAgB2D,UAAYD,QAQrCE,0BAA0BC,SACJnE,KAAKoE,mBAAmB,cAChCC,UAAUC,OAAO,QAASH,SAQxCI,qBAAqBP,cACZxD,aAAayD,UAAYD,QAQlCQ,0BAA0BL,SACJnE,KAAKoE,mBAAmB,UAChCC,UAAUC,OAAO,QAASH,SAOxCnB,qBAAqBD,WAEb0B,qBAAgB1B,MAAM9B,KAAKe,QAAQ,QAAS,IAAI0C,oBAC/CC,cACD,4BAAaF,kBAAiBxB,oBAC9B,kBAAUwB,QAASxB,oBAO3B2B,aAGS9E,MAAM+E,OAMfjE,8BACSR,UAAU0E,iBAAiB,QAAS9E,KAAK+E,iBAAiBC,KAAKhF,YAC/DF,MAAMO,UAAU4E,GAAGC,YAAYC,aAAcnF,KAAKoF,oBAAoBJ,KAAKhF,YAC3EF,MAAMO,UAAU4E,GAAGC,YAAYG,QAAQ,UACnCC,qBACAC,oDASaC,UAClBxF,KAAKyF,cAGLD,MAAME,sBACH,GAAI1F,KAAK2F,UAAW,CAIvBH,MAAME,2BAGI,yCACI,kBAAU,gBAAiBzC,yBAC3B,kBAAU,eAAgBA,yBAC1B,kBAAU,cAAeA,yBAE9BnD,MAAM+E,OACb,MAAO9B,UAWjBgC,iBAAiBS,aACPI,OAASJ,MAAMK,OAAOC,QAAQ,aAChCF,QAAUA,OAAOG,QAAQC,OAAQ,OAC3BA,OAASJ,OAAOG,QAAQC,OACf,cAAXA,aACKC,oCAGM,WAAXD,aACKE,mBAQjBD,4DACsC,gDAAzBE,wEAAeC,YACfb,4BAEAc,uEASJC,KAAO,IAAIC,KAAKvG,KAAKwG,KAAKC,OAAQ,CACnC3E,KAAM9B,KAAKmG,cAAc5D,gBAExB7B,OAAOkD,UAAY,UACnBlD,OAAOgG,IAAMC,IAAIC,gBAAgB5G,KAAKsG,WAGtCO,8BAA8B,oBAG9BnG,OAAOmD,OAAQ,OACfnD,OAAOoG,UAAW,qCAClB1C,mBAAmB,kEAAWC,UAAUC,OAAO,QAAQ,QAGvDE,2BAA0B,QAC1BD,sBAAqB,8BAQM,IAA5BvE,KAAKwG,KAAKC,OAAOnE,wBACZqC,aAAa,0BAIhBoC,SAAW/G,KAAKoB,aAA6B,IAAhB4F,KAAKC,UAAiBC,WAAWlF,QAAQ,IAAK,cAKxEkC,2BAA0B,QAG1BK,sBAAqB,SAGpB4C,cAAgB,qBAAWnH,KAAKH,OAAQ,QAASG,KAAKsG,KAAMS,UAAWK,gBACpEC,4BAA4BD,kBAEhCE,YAAYH,cACZvC,6BACU,kBAAU,oBAAqB3B,oBAChD,MAAOF,YAEAwB,sBAAqB,wBAEX,kBAAU,eAAgBtB,kBAAW,CAACF,MAAAA,QAAS,CAC1DjB,KAAM,WAYlBsC,mBAAmBmD,gBACRvH,KAAKI,UAAUG,uCAAgCgH,6DAS/CvH,KAAKwH,eAAiBxH,KAAKyH,oCAGjB5H,cACX6H,WAAa1H,KAAK2H,gBAClB7H,YAAc4H,WAAWnE,OAAO,CAClCqE,gBAAiB,GACjBC,OAAO,EACPpE,eAAe,WAIF,IAAIzD,KAAKH,OAAQC,OACrBiB,WACTjB,MAAM4D,OAEH5D,MAQXG,+CACSD,KAAKJ,YAAY4H,gBAOjBxH,KAAKJ,YAAY6H,mCACP,CAAC,iBAAkB,YAAYK,KAAKC,OAAUA,IAAAA,IAAK9E,UAAAA,uBACzD+E,MAAKC,YAAE/E,MAAOgF,sBAAa,cAASA,QAAS,CAAChF,MAAAA,MAAOpB,KAAM,aAC3DqG,SACE,wBAVI,CAAC,sBAAuB,iBAAiBL,KAAKC,OAAUA,IAAAA,IAAK9E,UAAAA,uBACnE+E,MAAKI,WAAElF,MAAOgF,qBAAa,cAASA,QAAS,CAAChF,MAAAA,MAAOpB,KAAM,aAC3DqG,SACE,gCAmBHxF,UAAUC,cAAgBV,OAAOC,0CAelCD,OAAOmG,qDAORC,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,+BAAgCzI,KAAK0I,oBACzFF,UAAUG,oBAAoB3I,KAAKM,gBAAiBgI,KAAMC,SACrDK,YAAcC,YAAY7I,KAAK8I,uBAAuB9D,KAAKhF,MAAO,KAM3E8I,+BACUC,UAACA,UAADC,QAAYA,QAAZC,QAAqBA,SAAWjJ,KAAK0I,mBACvCK,UAAY,OACPxD,6BAEAjF,gBAAgBC,cAAc,yBAAyB2I,YAAcF,aACrE1I,gBAAgBC,cAAc,yBAAyB2I,YAAcD,6CAS9CE,aAC3B7I,gBAAgB4I,kBAAoB,kBAAUC,OAAQlG,qDAQ7BmE,eACzB5G,aAAa0I,kBAAoB,kBAAU,YAAajG,kBAAW,CACpEmE,SAAUJ,KAAKoC,MAAiB,IAAXhC,UAAkB,yCAKtC5G,aAAa0I,kBAAoB,kBAAU,SAAUjG,mBAM9DoG,mBACQrJ,KAAK4I,aACLU,cAActJ,KAAK4I,kBAElBA,YAAc,KAQvBF,yBAEUa,KAAM,IAAIC,MAAOC,UACjBV,UAAY/B,KAAK0C,MAAM1J,KAAKwB,gBAAmB+H,IAAMvJ,KAAK2J,WAAa,KAEvEC,UAAY,IAAIC,KAAKC,aAAanH,UAAUoH,SAAU,CAACC,qBAAsB,IAC7Ef,QAAUW,UAAUK,OAAOlB,UAAY,UAEtC,CACHA,UAAAA,UACAC,QAHYY,UAAUK,OAAOjD,KAAK0C,OAAOX,UAAYE,SAAW,KAIhEA,QAAAA,SASRiB,0BACWlK,KAAKE,OAAOiK,WASvB5E,uBACQvF,KAAKmG,eAA8C,aAA7BnG,KAAKmG,cAAcC,WACpCgE,eAAgB,OAGhB9E,gBAIb+E,oBACSlE,cAAcmE,YAGd5J,OAAOmD,OAAQ,EAQxByB,gBACQtF,KAAK0C,aACAA,OAAO6H,YACPtI,QAAQuI,OAA+B,UAArBA,MAAMC,aACxBC,SAASF,OAAUA,MAAMF,SAOtCK,qBAESC,sBAGAvB,mBAQTwB,qBACSlB,WAAY,IAAIH,MAAOC,eACvBqB,yBAQTC,oBAAoBvF,UACZxF,KAAKyF,cAAe,OACduF,QAAUhL,KAAKwG,KAAKyE,SAAWzF,MAAMgB,KAAK0E,KAG5CF,SAAWhL,KAAKkK,yBACXG,oBACAc,oCAGA3E,KAAKC,OAAO1E,KAAKyD,MAAMgB,WAGvBA,KAAKyE,SAAWD,QAEjBhL,KAAKoK,oBACAC,yEAOF,kBAAU,iBAAkBpH,mBAAY,CACnDC,YAAa,kBAAU,uBAAwBD,mBAC/CnB,KAAM,UASd2D,6CACyC,iDAAzBU,0EAAeC,OAQ/BT,oDACa3F,KAAKwG,6BAAL4E,WAAWH,oCAOhBjL,KAAKmG,cAAe,IAEhBnG,KAAKyF,oBACAU,cAAcmE,OAGnBtK,KAAK2F,UAAW,WACa3F,KAAKqL,sCAK7B7G,2BAA0B,GAC1BxE,KAAK0C,OAAO4I,cACPtL,KAAKa,wBAIdsF,cAAgB,UAIpBA,cAAgB,IAAIhE,cAAcnC,KAAK0C,OAAQ1C,KAAK0B,kCAEpDyE,cAAcrB,iBAAiB,gBAAiB9E,KAAK+K,oBAAoB/F,KAAKhF,YAC9EmG,cAAcrB,iBAAiB,OAAQ9E,KAAK2K,cAAc3F,KAAKhF,YAC/DmG,cAAcrB,iBAAiB,QAAS9E,KAAK6K,cAAc7F,KAAKhF,YAEhEwG,KAAO,CACRC,OAAQ,GACRwE,SAAU,QAETlH,yBACAqG,eAAgB,OAGhBjE,cAAcoF,MAAM,qDAUf,yCACI,kBAAU,oBAAqBtI,yBAC/B,kBAAU,mBAAoBA,yBAC9B,kBAAU,cAAeA,qBAE5B,EACT,aACS,qBASGuI,cACRlD,KAACA,YAAcE,UAAUC,iBAC3BzI,KAAKyB,uBACLzB,KAAKyL,wBAAwB,CACzBD,OAAAA,eAGH3L,OAAO6L,cAAcpD,MAS9BmD,wBAAwB7D,wBACbA"}
\ No newline at end of file
+{"version":3,"file":"base_recorder.min.js","sources":["../src/base_recorder.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {getString, getStrings} from 'core/str';\nimport {component} from './common';\nimport Pending from 'core/pending';\nimport {getData, isPausingAllowed} from './options';\nimport uploadFile from 'editor_tiny/uploader';\nimport {add as addToast} from 'core/toast';\nimport * as ModalEvents from 'core/modal_events';\nimport * as Templates from 'core/templates';\nimport {saveCancelPromise} from 'core/notification';\nimport {prefetchStrings, prefetchTemplates} from 'core/prefetch';\nimport AlertModal from 'core/local/modal/alert';\n\n/**\n * The RecordRTC base class for audio, video, and any other future types\n */\nexport default class {\n\n stopRequested = false;\n buttonTimer = null;\n pauseTime = null;\n startTime = null;\n\n /**\n * Constructor for the RecordRTC class\n *\n * @param {TinyMCE} editor The Editor to which the content will be inserted\n * @param {Modal} modal The Moodle Modal that contains the interface used for recording\n */\n constructor(editor, modal) {\n this.ready = false;\n\n if (!this.checkAndWarnAboutBrowserCompatibility()) {\n return;\n }\n\n this.editor = editor;\n this.config = getData(editor).params;\n this.modal = modal;\n this.modalRoot = modal.getRoot()[0];\n this.startStopButton = this.modalRoot.querySelector('button[data-action=\"startstop\"]');\n this.uploadButton = this.modalRoot.querySelector('button[data-action=\"upload\"]');\n this.pauseResumeButton = this.modalRoot.querySelector('button[data-action=\"pauseresume\"]');\n\n // Disable the record button untilt he stream is acquired.\n this.setRecordButtonState(false);\n\n this.player = this.configurePlayer();\n this.registerEventListeners();\n this.ready = true;\n\n this.captureUserMedia();\n this.prefetchContent();\n }\n\n /**\n * Check whether the browser is compatible.\n *\n * @returns {boolean}\n */\n isReady() {\n return this.ready;\n }\n\n // Disable eslint's valid-jsdoc rule as the following methods are abstract and mnust be overridden by the child class.\n\n /* eslint-disable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the Player element for this type.\n *\n * @returns {HTMLElement} The player element, typically an audio or video tag.\n */\n configurePlayer() {\n throw new Error(`configurePlayer() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the list of supported mimetypes for this recorder.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/isTypeSupported}\n *\n * @returns {string[]} The list of supported mimetypes.\n */\n getSupportedTypes() {\n throw new Error(`getSupportedTypes() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get any recording options passed into the MediaRecorder.\n * Please note that the mimeType will be fetched from {@link getSupportedTypes()}.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/MediaRecorder#options}\n * @returns {Object}\n */\n getRecordingOptions() {\n throw new Error(`getRecordingOptions() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a filename for the generated file.\n *\n * Typically this function will take a prefix and add a type-specific suffix such as the extension to it.\n *\n * @param {string} prefix The prefix for the filename generated by the recorder.\n * @returns {string}\n */\n getFileName(prefix) {\n throw new Error(`getFileName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get a list of constraints as required by the getUserMedia() function.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#constraints}\n *\n * @returns {Object}\n */\n getMediaConstraints() {\n throw new Error(`getMediaConstraints() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Whether to start playing the recording as it is captured.\n * @returns {boolean} Whether to start playing the recording as it is captured.\n */\n playOnCapture() {\n return false;\n }\n\n /**\n * Get the time limit for this recording type.\n *\n * @returns {number} The time limit in seconds.\n */\n getTimeLimit() {\n throw new Error(`getTimeLimit() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Get the name of the template used when embedding the URL in the editor content.\n *\n * @returns {string}\n */\n getEmbedTemplateName() {\n throw new Error(`getEmbedTemplateName() must be implemented in ${this.constructor.name}`);\n }\n\n /**\n * Fetch the Class of the Modal to be displayed.\n *\n * @returns {Modal}\n */\n static getModalClass() {\n throw new Error(`getModalClass() must be implemented in ${this.constructor.name}`);\n }\n\n /* eslint-enable valid-jsdoc, no-unused-vars */\n\n /**\n * Get the options for the MediaRecorder.\n *\n * @returns {object} The options for the MediaRecorder instance.\n */\n getParsedRecordingOptions() {\n const requestedTypes = this.getSupportedTypes();\n const possibleTypes = requestedTypes.reduce((result, type) => {\n result.push(type);\n // Safari seems to use codecs: instead of codecs=.\n // It is safe to add both, so we do, but we want them to remain in order.\n result.push(type.replace('=', ':'));\n return result;\n }, []);\n\n const compatTypes = possibleTypes.filter((type) => window.MediaRecorder.isTypeSupported(type));\n\n const options = this.getRecordingOptions();\n if (compatTypes.length !== 0) {\n options.mimeType = compatTypes[0];\n }\n window.console.info(\n `Selected codec ${options.mimeType} from ${compatTypes.length} options.`,\n compatTypes,\n );\n\n return options;\n }\n\n /**\n * Start capturing the User Media and handle success or failure of the capture.\n */\n async captureUserMedia() {\n try {\n const stream = await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());\n this.handleCaptureSuccess(stream);\n } catch (error) {\n this.handleCaptureFailure(error);\n }\n }\n\n /**\n * Prefetch some of the content that will be used in the UI.\n *\n * Note: not all of the strings used are pre-fetched.\n * Some of the strings will be fetched because their template is used.\n */\n prefetchContent() {\n prefetchStrings(component, [\n 'uploading',\n 'recordagain_title',\n 'recordagain_desc',\n 'discard_title',\n 'discard_desc',\n 'confirm_yes',\n 'recordinguploaded',\n 'maxfilesizehit',\n 'maxfilesizehit_title',\n 'uploadfailed',\n 'pause',\n 'resume',\n ]);\n\n prefetchTemplates([\n this.getEmbedTemplateName(),\n 'tiny_recordrtc/timeremaining',\n ]);\n }\n\n /**\n * Display an error message to the user.\n *\n * @param {Promise} title The error title\n * @param {Promise} content The error message\n * @returns {Promise}\n */\n async displayAlert(title, content) {\n const pendingPromise = new Pending('core/confirm:alert');\n const modal = await AlertModal.create({\n title: title,\n body: content,\n removeOnClose: true,\n });\n\n modal.show();\n pendingPromise.resolve();\n\n return modal;\n }\n\n /**\n * Handle successful capture of the User Media.\n *\n * @param {MediaStream} stream The stream as captured by the User Media.\n */\n handleCaptureSuccess(stream) {\n // Set audio player source to microphone stream.\n this.player.srcObject = stream;\n\n if (this.playOnCapture()) {\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n\n this.stream = stream;\n this.setupPlayerSource();\n this.setRecordButtonState(true);\n }\n\n /**\n * Setup the player to use the stream as a source.\n */\n setupPlayerSource() {\n if (!this.player.srcObject) {\n this.player.srcObject = this.stream;\n\n // Mute audio, distracting while recording.\n this.player.muted = true;\n\n this.player.play();\n }\n }\n\n /**\n * Enable the record button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setRecordButtonState(enabled) {\n this.startStopButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the record button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setRecordButtonVisibility(visible) {\n const container = this.getButtonContainer('start-stop');\n container.classList.toggle('hide', !visible);\n }\n\n /**\n * Configure button visibility for the pause button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setPauseButtonVisibility(visible) {\n if (this.pauseResumeButton) {\n this.pauseResumeButton.classList.toggle('hidden', !visible);\n }\n }\n\n /**\n * Enable the upload button.\n *\n * @param {boolean|null} enabled Set the button state\n */\n setUploadButtonState(enabled) {\n this.uploadButton.disabled = !enabled;\n }\n\n /**\n * Configure button visibility for the upload button.\n *\n * @param {boolean} visible Set the visibility of the button.\n */\n setUploadButtonVisibility(visible) {\n const container = this.getButtonContainer('upload');\n container.classList.toggle('hide', !visible);\n }\n\n /**\n * Sets the state of the audio player, including visibility, muting, and controls.\n *\n * @param {boolean} state A boolean indicating the audio player state.\n */\n setPlayerState(state) {\n // Mute or unmute the audio player and show or hide controls.\n this.player.muted = !state;\n this.player.controls = state;\n // Toggle the 'hide' class on the player button container based on state.\n this.getButtonContainer('player')?.classList.toggle('hide', !state);\n }\n\n /**\n * Handle failure to capture the User Media.\n *\n * @param {Error} error\n */\n handleCaptureFailure(error) {\n // Changes 'CertainError' -> 'gumcertain' to match language string names.\n var subject = `gum${error.name.replace('Error', '').toLowerCase()}`;\n this.displayAlert(\n getString(`${subject}_title`, component),\n getString(subject, component)\n );\n }\n\n /**\n * Close the modal and stop recording.\n */\n close() {\n // Closing the modal will destroy it and remove it from the DOM.\n // It will also stop the recording via the hidden Modal Event.\n this.modal.hide();\n }\n\n /**\n * Register event listeners for the modal.\n */\n registerEventListeners() {\n this.modalRoot.addEventListener('click', this.handleModalClick.bind(this));\n this.modal.getRoot().on(ModalEvents.outsideClick, this.outsideClickHandler.bind(this));\n this.modal.getRoot().on(ModalEvents.hidden, () => {\n this.cleanupStream();\n this.requestRecordingStop();\n });\n }\n\n /**\n * Prevent the Modal from closing when recording is on process.\n *\n * @param {MouseEvent} event The click event\n */\n async outsideClickHandler(event) {\n if (this.isRecording() || this.isPaused()) {\n // The user is recording.\n // Do not distract with a confirmation, just prevent closing.\n event.preventDefault();\n } else if (this.hasData()) {\n // If there is a blobsize then there is data that may be lost.\n // Ask the user to confirm they want to close the modal.\n // We prevent default here, and then close the modal if they confirm.\n event.preventDefault();\n\n try {\n await saveCancelPromise(\n await getString(\"discard_title\", component),\n await getString(\"discard_desc\", component),\n await getString(\"confirm_yes\", component),\n );\n this.modal.hide();\n } catch (error) {\n // Do nothing, the modal will not close.\n }\n }\n }\n\n /**\n * Handle a click within the Modal.\n *\n * @param {MouseEvent} event The click event\n */\n handleModalClick(event) {\n const button = event.target.closest('button');\n if (button && button.dataset.action) {\n const action = button.dataset.action;\n if (action === 'startstop') {\n this.handleRecordingStartStopRequested();\n }\n\n if (action === 'upload') {\n this.uploadRecording();\n }\n\n if (action === 'pauseresume') {\n this.handleRecordingPauseResumeRequested();\n }\n }\n }\n\n /**\n * Handle the click event for the recording start/stop button.\n */\n handleRecordingStartStopRequested() {\n if (this.isRecording() || this.isPaused()) {\n this.requestRecordingStop();\n } else {\n this.startRecording();\n }\n }\n\n /**\n * Handle the click event for the recording pause/resume button.\n */\n handleRecordingPauseResumeRequested() {\n if (this.isRecording()) {\n // Pause recording.\n this.mediaRecorder.pause();\n } else if (this.isPaused()) {\n // Resume recording.\n this.mediaRecorder.resume();\n }\n }\n\n /**\n * Handle the media stream after it has finished.\n */\n async onMediaStopped() {\n // Set source of audio player.\n this.blob = new Blob(this.data.chunks, {\n type: this.mediaRecorder.mimeType\n });\n this.player.srcObject = null;\n this.player.src = URL.createObjectURL(this.blob);\n\n // Change the label to \"Record again\".\n this.setRecordButtonTextFromString('recordagain');\n\n // Show upload button.\n this.setUploadButtonVisibility(true);\n this.setPlayerState(true);\n this.setUploadButtonState(true);\n\n // Hide the pause button.\n this.setPauseButtonVisibility(false);\n if (this.mediaRecorder.state === 'inactive') {\n this.setPauseButtonTextFromString('pause');\n }\n }\n\n /**\n * Upload the recording and insert it into the editor content.\n */\n async uploadRecording() {\n // Trigger error if no recording has been made.\n if (this.data.chunks.length === 0) {\n this.displayAlert('norecordingfound');\n return;\n }\n\n const fileName = this.getFileName((Math.random() * 1000).toString().replace('.', ''));\n\n // Upload recording to server.\n try {\n // Once uploading starts, do not allow any further changes to the recording.\n this.setRecordButtonVisibility(false);\n\n // Disable the upload button.\n this.setUploadButtonState(false);\n\n // Upload the recording.\n const fileURL = await uploadFile(this.editor, 'media', this.blob, fileName, (progress) => {\n this.setUploadButtonTextProgress(progress);\n });\n this.insertMedia(fileURL);\n this.close();\n addToast(await getString('recordinguploaded', component));\n } catch (error) {\n // Show a toast and unhide the button.\n this.setUploadButtonState(true);\n\n addToast(await getString('uploadfailed', component, {error}), {\n type: 'error',\n });\n\n }\n }\n\n /**\n * Helper to get the container that a button is in.\n *\n * @param {string} purpose The button purpose\n * @returns {HTMLElement}\n */\n getButtonContainer(purpose) {\n return this.modalRoot.querySelector(`[data-purpose=\"${purpose}-container\"]`);\n }\n\n /**\n * Check whether the browser is compatible with capturing media.\n *\n * @returns {boolean}\n */\n static isBrowserCompatible() {\n return this.checkSecure() && this.hasUserMedia();\n }\n\n static async display(editor) {\n const ModalClass = this.getModalClass();\n const modal = await ModalClass.create({\n templateContext: {\n isallowedpausing: isPausingAllowed(editor),\n },\n large: true,\n removeOnClose: true,\n });\n\n // Set up the VideoRecorder.\n const recorder = new this(editor, modal);\n if (recorder.isReady()) {\n modal.show();\n }\n return modal;\n }\n\n /**\n * Check whether the browser is compatible with capturing media, and display a warning if not.\n *\n * @returns {boolean}\n */\n checkAndWarnAboutBrowserCompatibility() {\n if (!this.constructor.checkSecure()) {\n getStrings(['insecurealert_title', 'insecurealert'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n if (!this.constructor.hasUserMedia) {\n getStrings(['nowebrtc_title', 'nowebrtc'].map((key) => ({key, component})))\n .then(([title, message]) => addToast(message, {title, type: 'error'}))\n .catch();\n return false;\n }\n\n return true;\n }\n\n /**\n * Check whether the browser supports WebRTC.\n *\n * @returns {boolean}\n */\n static hasUserMedia() {\n return (navigator.mediaDevices && window.MediaRecorder);\n }\n\n /**\n * Check whether the hostname is either hosted over SSL, or from a valid localhost hostname.\n *\n * The UserMedia API can only be used in secure contexts as noted.\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#privacy_and_security}\n *\n * @returns {boolean} Whether the plugin can be loaded.\n */\n static checkSecure() {\n // Note: We can now use window.isSecureContext.\n // https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts#feature_detection\n // https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext\n return window.isSecureContext;\n }\n\n /**\n * Update the content of the stop recording button timer.\n */\n async setStopRecordingButton() {\n const {html, js} = await Templates.renderForPromise('tiny_recordrtc/timeremaining', this.getTimeRemaining());\n Templates.replaceNodeContents(this.startStopButton, html, js);\n this.startButtonTimer();\n }\n\n /**\n * Update the time on the stop recording button.\n */\n updateRecordButtonTime() {\n const {remaining, minutes, seconds} = this.getTimeRemaining();\n if (remaining < 0) {\n this.requestRecordingStop();\n } else {\n this.startStopButton.querySelector('[data-type=\"minutes\"]').textContent = minutes;\n this.startStopButton.querySelector('[data-type=\"seconds\"]').textContent = seconds;\n }\n }\n\n /**\n * Set the text of the record button using a language string.\n *\n * @param {string} string The string identifier\n */\n async setRecordButtonTextFromString(string) {\n this.startStopButton.textContent = await getString(string, component);\n }\n\n /**\n * Set the text of the pause button using a language string.\n *\n * @param {string} string The string identifier\n */\n async setPauseButtonTextFromString(string) {\n if (this.pauseResumeButton) {\n this.pauseResumeButton.textContent = await getString(string, component);\n }\n }\n\n /**\n * Set the upload button text progress.\n *\n * @param {number} progress The progress\n */\n async setUploadButtonTextProgress(progress) {\n this.uploadButton.textContent = await getString('uploading', component, {\n progress: Math.round(progress * 100) / 100,\n });\n }\n\n async resetUploadButtonText() {\n this.uploadButton.textContent = await getString('upload', component);\n }\n\n /**\n * Clear the timer for the stop recording button.\n */\n clearButtonTimer() {\n if (this.buttonTimer) {\n clearInterval(this.buttonTimer);\n }\n this.buttonTimer = null;\n this.pauseTime = null;\n this.startTime = null;\n }\n\n /**\n * Pause the timer for the stop recording button.\n */\n pauseButtonTimer() {\n // Stop the countdown timer.\n this.pauseTime = new Date().getTime(); // Store pause time.\n if (this.buttonTimer) {\n clearInterval(this.buttonTimer);\n }\n }\n\n /**\n * Start the timer for the start recording button.\n * If the recording was paused, the timer will resume from the pause time.\n */\n startButtonTimer() {\n if (this.pauseTime !== null) {\n // Resume from pause.\n const pauseDuration = new Date().getTime() - this.pauseTime;\n // Adjust start time by pause duration.\n this.startTime += pauseDuration;\n this.pauseTime = null;\n }\n this.buttonTimer = setInterval(this.updateRecordButtonTime.bind(this), 500);\n }\n\n /**\n * Get the time remaining for the recording.\n *\n * @returns {Object} The minutes and seconds remaining.\n */\n getTimeRemaining() {\n // All times are in milliseconds.\n let now = new Date().getTime();\n if (this.pauseTime !== null) {\n // If paused, use pauseTime instead of current time.\n now = this.pauseTime;\n }\n const remaining = Math.floor(this.getTimeLimit() - ((now - this.startTime) / 1000));\n\n const formatter = new Intl.NumberFormat(navigator.language, {minimumIntegerDigits: 2});\n const seconds = formatter.format(remaining % 60);\n const minutes = formatter.format(Math.floor((remaining - seconds) / 60));\n return {\n remaining,\n minutes,\n seconds,\n };\n }\n\n /**\n * Get the maximum file size that can be uploaded.\n *\n * @returns {number} The max byte size\n */\n getMaxUploadSize() {\n return this.config.maxrecsize;\n }\n\n /**\n * Stop the recording.\n * Please note that this should only stop the recording.\n * Anything related to processing the recording should be handled by the\n * mediaRecorder's stopped event handler which is processed after it has stopped.\n */\n requestRecordingStop() {\n if (this.mediaRecorder && this.mediaRecorder.state !== 'inactive') {\n this.stopRequested = true;\n if (this.isPaused()) {\n this.stopRecorder();\n }\n } else {\n // There is no recording to stop, but the stream must still be cleaned up.\n this.cleanupStream();\n }\n }\n\n stopRecorder() {\n if (this.isPaused()) {\n this.pauseTime = null;\n }\n this.mediaRecorder.stop();\n\n // Unmute the player so that the audio is heard during playback.\n this.player.muted = false;\n }\n\n /**\n * Clean up the stream.\n *\n * This involves stopping any track which is still active.\n */\n cleanupStream() {\n if (this.stream) {\n this.stream.getTracks()\n .filter((track) => track.readyState !== 'ended')\n .forEach((track) => track.stop());\n }\n }\n\n /**\n * Handle the mediaRecorder `stop` event.\n */\n handleStopped() {\n // Handle the stream data.\n this.onMediaStopped();\n\n // Clear the button timer.\n this.clearButtonTimer();\n }\n\n /**\n * Handle the mediaRecorder `start` event.\n *\n * This event is called when the recording starts.\n */\n handleStarted() {\n this.startTime = new Date().getTime();\n if (isPausingAllowed(this.editor) && !this.isPaused()) {\n this.setPauseButtonVisibility(true);\n }\n this.setStopRecordingButton();\n }\n\n /**\n * Handle the mediaRecorder `pause` event.\n *\n * This event is called when the recording pauses.\n */\n handlePaused() {\n this.pauseButtonTimer();\n this.setPauseButtonTextFromString('resume');\n }\n\n /**\n * Handle the mediaRecorder `resume` event.\n *\n * This event is called when the recording resumes.\n */\n handleResume() {\n this.startButtonTimer();\n this.setPauseButtonTextFromString('pause');\n }\n\n /**\n * Handle the mediaRecorder `dataavailable` event.\n *\n * @param {Event} event\n */\n handleDataAvailable(event) {\n if (this.isRecording() || this.isPaused()) {\n const newSize = this.data.blobSize + event.data.size;\n // Recording stops when either the maximum upload size is reached, or the time limit expires.\n // The time limit is checked in the `updateButtonTime` function.\n if (newSize >= this.getMaxUploadSize()) {\n this.stopRecorder();\n this.displayFileLimitHitMessage();\n } else {\n // Push recording slice to array.\n this.data.chunks.push(event.data);\n\n // Size of all recorded data so far.\n this.data.blobSize = newSize;\n\n if (this.stopRequested) {\n this.stopRecorder();\n }\n }\n }\n }\n\n async displayFileLimitHitMessage() {\n addToast(await getString('maxfilesizehit', component), {\n title: await getString('maxfilesizehit_title', component),\n type: 'error',\n });\n }\n\n /**\n * Check whether the recording is in progress.\n *\n * @returns {boolean}\n */\n isRecording() {\n return this.mediaRecorder?.state === 'recording';\n }\n\n /**\n * Check whether the recording is paused.\n *\n * @returns {boolean}\n */\n isPaused() {\n return this.mediaRecorder?.state === 'paused';\n }\n\n /**\n * Whether any data has been recorded.\n *\n * @returns {boolean}\n */\n hasData() {\n return !!this.data?.blobSize;\n }\n\n /**\n * Start the recording\n */\n async startRecording() {\n if (this.mediaRecorder) {\n // Stop the existing recorder if it exists.\n if (this.isRecording() || this.isPaused()) {\n this.mediaRecorder.stop();\n }\n\n if (this.hasData()) {\n const resetRecording = await this.recordAgainConfirmation();\n if (!resetRecording) {\n // User cancelled at the confirmation to reset the data, so exit early.\n return;\n }\n this.setUploadButtonVisibility(false);\n this.setPlayerState(false);\n if (!this.stream.active) {\n await this.captureUserMedia();\n }\n }\n\n this.mediaRecorder = null;\n }\n\n // The options for the recording codecs and bitrates.\n this.mediaRecorder = new MediaRecorder(this.stream, this.getParsedRecordingOptions());\n\n this.mediaRecorder.addEventListener('dataavailable', this.handleDataAvailable.bind(this));\n this.mediaRecorder.addEventListener('stop', this.handleStopped.bind(this));\n this.mediaRecorder.addEventListener('start', this.handleStarted.bind(this));\n this.mediaRecorder.addEventListener('pause', this.handlePaused.bind(this));\n this.mediaRecorder.addEventListener('resume', this.handleResume.bind(this));\n\n this.data = {\n chunks: [],\n blobSize: 0\n };\n this.setupPlayerSource();\n this.stopRequested = false;\n\n // Capture in 50ms chunks.\n this.mediaRecorder.start(50);\n }\n\n /**\n * Confirm whether the user wants to reset the existing recoring.\n *\n * @returns {Promise} Whether the user confirmed the reset.\n */\n async recordAgainConfirmation() {\n try {\n await saveCancelPromise(\n await getString(\"recordagain_title\", component),\n await getString(\"recordagain_desc\", component),\n await getString(\"confirm_yes\", component)\n );\n return true;\n } catch {\n return false;\n }\n }\n\n /**\n * Insert the HTML to embed the recording into the editor content.\n *\n * @param {string} source The URL to view the media.\n */\n async insertMedia(source) {\n const {html} = await Templates.renderForPromise(\n this.getEmbedTemplateName(),\n this.getEmbedTemplateContext({\n source,\n })\n );\n this.editor.insertContent(html);\n }\n\n /**\n * Add or modify the template parameters for the specified type.\n *\n * @param {Object} templateContext The Tempalte context to use\n * @returns {Object} The finalised template context\n */\n getEmbedTemplateContext(templateContext) {\n return templateContext;\n }\n}\n"],"names":["constructor","editor","modal","ready","this","checkAndWarnAboutBrowserCompatibility","config","params","modalRoot","getRoot","startStopButton","querySelector","uploadButton","pauseResumeButton","setRecordButtonState","player","configurePlayer","registerEventListeners","captureUserMedia","prefetchContent","isReady","Error","name","getSupportedTypes","getRecordingOptions","getFileName","prefix","getMediaConstraints","playOnCapture","getTimeLimit","getEmbedTemplateName","getParsedRecordingOptions","compatTypes","reduce","result","type","push","replace","filter","window","MediaRecorder","isTypeSupported","options","length","mimeType","console","info","stream","navigator","mediaDevices","getUserMedia","handleCaptureSuccess","error","handleCaptureFailure","component","title","content","pendingPromise","Pending","AlertModal","create","body","removeOnClose","show","resolve","srcObject","muted","play","setupPlayerSource","enabled","disabled","setRecordButtonVisibility","visible","getButtonContainer","classList","toggle","setPauseButtonVisibility","setUploadButtonState","setUploadButtonVisibility","setPlayerState","state","controls","subject","toLowerCase","displayAlert","close","hide","addEventListener","handleModalClick","bind","on","ModalEvents","outsideClick","outsideClickHandler","hidden","cleanupStream","requestRecordingStop","event","isRecording","isPaused","preventDefault","hasData","button","target","closest","dataset","action","handleRecordingStartStopRequested","uploadRecording","handleRecordingPauseResumeRequested","startRecording","mediaRecorder","pause","resume","blob","Blob","data","chunks","src","URL","createObjectURL","setRecordButtonTextFromString","setPauseButtonTextFromString","fileName","Math","random","toString","fileURL","progress","setUploadButtonTextProgress","insertMedia","purpose","checkSecure","hasUserMedia","ModalClass","getModalClass","templateContext","isallowedpausing","large","map","key","then","_ref2","message","catch","_ref","isSecureContext","html","js","Templates","renderForPromise","getTimeRemaining","replaceNodeContents","startButtonTimer","updateRecordButtonTime","remaining","minutes","seconds","textContent","string","round","clearButtonTimer","buttonTimer","clearInterval","pauseTime","startTime","pauseButtonTimer","Date","getTime","pauseDuration","setInterval","now","floor","formatter","Intl","NumberFormat","language","minimumIntegerDigits","format","getMaxUploadSize","maxrecsize","stopRequested","stopRecorder","stop","getTracks","track","readyState","forEach","handleStopped","onMediaStopped","handleStarted","setStopRecordingButton","handlePaused","handleResume","handleDataAvailable","newSize","blobSize","size","displayFileLimitHitMessage","_this$data","recordAgainConfirmation","active","start","source","getEmbedTemplateContext","insertContent"],"mappings":"u1DAoDIA,YAAYC,OAAQC,6CAXJ,sCACF,uCACF,uCACA,WASHC,OAAQ,EAERC,KAAKC,+CAILJ,OAASA,YACTK,QAAS,oBAAQL,QAAQM,YACzBL,MAAQA,WACRM,UAAYN,MAAMO,UAAU,QAC5BC,gBAAkBN,KAAKI,UAAUG,cAAc,wCAC/CC,aAAeR,KAAKI,UAAUG,cAAc,qCAC5CE,kBAAoBT,KAAKI,UAAUG,cAAc,0CAGjDG,sBAAqB,QAErBC,OAASX,KAAKY,uBACdC,8BACAd,OAAQ,OAERe,wBACAC,mBAQTC,iBACWhB,KAAKD,MAYhBa,wBACU,IAAIK,yDAAkDjB,KAAKJ,YAAYsB,OASjFC,0BACU,IAAIF,2DAAoDjB,KAAKJ,YAAYsB,OAUnFE,4BACU,IAAIH,6DAAsDjB,KAAKJ,YAAYsB,OAWrFG,YAAYC,cACF,IAAIL,qDAA8CjB,KAAKJ,YAAYsB,OAS7EK,4BACU,IAAIN,6DAAsDjB,KAAKJ,YAAYsB,OAOrFM,uBACW,EAQXC,qBACU,IAAIR,sDAA+CjB,KAAKJ,YAAYsB,OAQ9EQ,6BACU,IAAIT,8DAAuDjB,KAAKJ,YAAYsB,oCAS5E,IAAID,uDAAgDjB,KAAKJ,YAAYsB,OAU/ES,kCAUUC,YATiB5B,KAAKmB,oBACSU,QAAO,CAACC,OAAQC,QACjDD,OAAOE,KAAKD,MAGZD,OAAOE,KAAKD,KAAKE,QAAQ,IAAK,MACvBH,SACR,IAE+BI,QAAQH,MAASI,OAAOC,cAAcC,gBAAgBN,QAElFO,QAAUtC,KAAKoB,6BACM,IAAvBQ,YAAYW,SACZD,QAAQE,SAAWZ,YAAY,IAEnCO,OAAOM,QAAQC,8BACOJ,QAAQE,0BAAiBZ,YAAYW,oBACvDX,aAGGU,2CAQGK,aAAeC,UAAUC,aAAaC,aAAa9C,KAAKuB,4BACzDwB,qBAAqBJ,QAC5B,MAAOK,YACAC,qBAAqBD,QAUlCjC,gDACoBmC,kBAAW,CACvB,YACA,oBACA,mBACA,gBACA,eACA,cACA,oBACA,iBACA,uBACA,eACA,QACA,2CAGc,CACdlD,KAAK0B,uBACL,oDAWWyB,MAAOC,eAChBC,eAAiB,IAAIC,iBAAQ,sBAC7BxD,YAAcyD,eAAWC,OAAO,CAClCL,MAAOA,MACPM,KAAML,QACNM,eAAe,WAGnB5D,MAAM6D,OACNN,eAAeO,UAER9D,MAQXiD,qBAAqBJ,aAEZhC,OAAOkD,UAAYlB,OAEpB3C,KAAKwB,uBAEAb,OAAOmD,OAAQ,OAEfnD,OAAOoD,aAGXpB,OAASA,YACTqB,yBACAtD,sBAAqB,GAM9BsD,oBACShE,KAAKW,OAAOkD,iBACRlD,OAAOkD,UAAY7D,KAAK2C,YAGxBhC,OAAOmD,OAAQ,OAEfnD,OAAOoD,QASpBrD,qBAAqBuD,cACZ3D,gBAAgB4D,UAAYD,QAQrCE,0BAA0BC,SACJpE,KAAKqE,mBAAmB,cAChCC,UAAUC,OAAO,QAASH,SAQxCI,yBAAyBJ,SACjBpE,KAAKS,wBACAA,kBAAkB6D,UAAUC,OAAO,UAAWH,SAS3DK,qBAAqBR,cACZzD,aAAa0D,UAAYD,QAQlCS,0BAA0BN,SACJpE,KAAKqE,mBAAmB,UAChCC,UAAUC,OAAO,QAASH,SAQxCO,eAAeC,sCAENjE,OAAOmD,OAASc,WAChBjE,OAAOkE,SAAWD,yCAElBP,mBAAmB,kEAAWC,UAAUC,OAAO,QAASK,OAQjE3B,qBAAqBD,WAEb8B,qBAAgB9B,MAAM9B,KAAKe,QAAQ,QAAS,IAAI8C,oBAC/CC,cACD,4BAAaF,kBAAiB5B,oBAC9B,kBAAU4B,QAAS5B,oBAO3B+B,aAGSnF,MAAMoF,OAMfrE,8BACST,UAAU+E,iBAAiB,QAASnF,KAAKoF,iBAAiBC,KAAKrF,YAC/DF,MAAMO,UAAUiF,GAAGC,YAAYC,aAAcxF,KAAKyF,oBAAoBJ,KAAKrF,YAC3EF,MAAMO,UAAUiF,GAAGC,YAAYG,QAAQ,UACnCC,qBACAC,oDASaC,UAClB7F,KAAK8F,eAAiB9F,KAAK+F,WAG3BF,MAAMG,sBACH,GAAIhG,KAAKiG,UAAW,CAIvBJ,MAAMG,2BAGI,yCACI,kBAAU,gBAAiB9C,yBAC3B,kBAAU,eAAgBA,yBAC1B,kBAAU,cAAeA,yBAE9BpD,MAAMoF,OACb,MAAOlC,UAWjBoC,iBAAiBS,aACPK,OAASL,MAAMM,OAAOC,QAAQ,aAChCF,QAAUA,OAAOG,QAAQC,OAAQ,OAC3BA,OAASJ,OAAOG,QAAQC,OACf,cAAXA,aACKC,oCAGM,WAAXD,aACKE,kBAGM,gBAAXF,aACKG,uCAQjBF,oCACQvG,KAAK8F,eAAiB9F,KAAK+F,gBACtBH,4BAEAc,iBAObD,sCACQzG,KAAK8F,mBAEAa,cAAcC,QACZ5G,KAAK+F,iBAEPY,cAAcE,qCASlBC,KAAO,IAAIC,KAAK/G,KAAKgH,KAAKC,OAAQ,CACnClF,KAAM/B,KAAK2G,cAAcnE,gBAExB7B,OAAOkD,UAAY,UACnBlD,OAAOuG,IAAMC,IAAIC,gBAAgBpH,KAAK8G,WAGtCO,8BAA8B,oBAG9B3C,2BAA0B,QAC1BC,gBAAe,QACfF,sBAAqB,QAGrBD,0BAAyB,GACG,aAA7BxE,KAAK2G,cAAc/B,YACd0C,6BAA6B,oCASN,IAA5BtH,KAAKgH,KAAKC,OAAO1E,wBACZyC,aAAa,0BAIhBuC,SAAWvH,KAAKqB,aAA6B,IAAhBmG,KAAKC,UAAiBC,WAAWzF,QAAQ,IAAK,cAKxEkC,2BAA0B,QAG1BM,sBAAqB,SAGpBkD,cAAgB,qBAAW3H,KAAKH,OAAQ,QAASG,KAAK8G,KAAMS,UAAWK,gBACpEC,4BAA4BD,kBAEhCE,YAAYH,cACZ1C,6BACU,kBAAU,oBAAqB/B,oBAChD,MAAOF,YAEAyB,sBAAqB,wBAEX,kBAAU,eAAgBvB,kBAAW,CAACF,MAAAA,QAAS,CAC1DjB,KAAM,WAYlBsC,mBAAmB0D,gBACR/H,KAAKI,UAAUG,uCAAgCwH,6DAS/C/H,KAAKgI,eAAiBhI,KAAKiI,oCAGjBpI,cACXqI,WAAalI,KAAKmI,gBAClBrI,YAAcoI,WAAW1E,OAAO,CAClC4E,gBAAiB,CACbC,kBAAkB,6BAAiBxI,SAEvCyI,OAAO,EACP5E,eAAe,WAIF,IAAI1D,KAAKH,OAAQC,OACrBkB,WACTlB,MAAM6D,OAEH7D,MAQXG,+CACSD,KAAKJ,YAAYoI,gBAOjBhI,KAAKJ,YAAYqI,mCACP,CAAC,iBAAkB,YAAYM,KAAKC,OAAUA,IAAAA,IAAKtF,UAAAA,uBACzDuF,MAAKC,YAAEvF,MAAOwF,sBAAa,cAASA,QAAS,CAACxF,MAAAA,MAAOpB,KAAM,aAC3D6G,SACE,wBAVI,CAAC,sBAAuB,iBAAiBL,KAAKC,OAAUA,IAAAA,IAAKtF,UAAAA,uBACnEuF,MAAKI,WAAE1F,MAAOwF,qBAAa,cAASA,QAAS,CAACxF,MAAAA,MAAOpB,KAAM,aAC3D6G,SACE,gCAmBHhG,UAAUC,cAAgBV,OAAOC,0CAelCD,OAAO2G,qDAORC,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,+BAAgClJ,KAAKmJ,oBACzFF,UAAUG,oBAAoBpJ,KAAKM,gBAAiByI,KAAMC,SACrDK,mBAMTC,+BACUC,UAACA,UAADC,QAAYA,QAAZC,QAAqBA,SAAWzJ,KAAKmJ,mBACvCI,UAAY,OACP3D,6BAEAtF,gBAAgBC,cAAc,yBAAyBmJ,YAAcF,aACrElJ,gBAAgBC,cAAc,yBAAyBmJ,YAAcD,6CAS9CE,aAC3BrJ,gBAAgBoJ,kBAAoB,kBAAUC,OAAQzG,sDAQ5ByG,QAC3B3J,KAAKS,yBACAA,kBAAkBiJ,kBAAoB,kBAAUC,OAAQzG,sDASnC0E,eACzBpH,aAAakJ,kBAAoB,kBAAU,YAAaxG,kBAAW,CACpE0E,SAAUJ,KAAKoC,MAAiB,IAAXhC,UAAkB,yCAKtCpH,aAAakJ,kBAAoB,kBAAU,SAAUxG,mBAM9D2G,mBACQ7J,KAAK8J,aACLC,cAAc/J,KAAK8J,kBAElBA,YAAc,UACdE,UAAY,UACZC,UAAY,KAMrBC,wBAESF,WAAY,IAAIG,MAAOC,UACxBpK,KAAK8J,aACLC,cAAc/J,KAAK8J,aAQ3BT,sBAC2B,OAAnBrJ,KAAKgK,UAAoB,OAEnBK,eAAgB,IAAIF,MAAOC,UAAYpK,KAAKgK,eAE7CC,WAAaI,mBACbL,UAAY,UAEhBF,YAAcQ,YAAYtK,KAAKsJ,uBAAuBjE,KAAKrF,MAAO,KAQ3EmJ,uBAEQoB,KAAM,IAAIJ,MAAOC,UACE,OAAnBpK,KAAKgK,YAELO,IAAMvK,KAAKgK,iBAETT,UAAY/B,KAAKgD,MAAMxK,KAAKyB,gBAAmB8I,IAAMvK,KAAKiK,WAAa,KAEvEQ,UAAY,IAAIC,KAAKC,aAAa/H,UAAUgI,SAAU,CAACC,qBAAsB,IAC7EpB,QAAUgB,UAAUK,OAAOvB,UAAY,UAEtC,CACHA,UAAAA,UACAC,QAHYiB,UAAUK,OAAOtD,KAAKgD,OAAOjB,UAAYE,SAAW,KAIhEA,QAAAA,SASRsB,0BACW/K,KAAKE,OAAO8K,WASvBpF,uBACQ5F,KAAK2G,eAA8C,aAA7B3G,KAAK2G,cAAc/B,YACpCqG,eAAgB,EACjBjL,KAAK+F,iBACAmF,qBAIJvF,gBAIbuF,eACQlL,KAAK+F,kBACAiE,UAAY,WAEhBrD,cAAcwE,YAGdxK,OAAOmD,OAAQ,EAQxB6B,gBACQ3F,KAAK2C,aACAA,OAAOyI,YACPlJ,QAAQmJ,OAA+B,UAArBA,MAAMC,aACxBC,SAASF,OAAUA,MAAMF,SAOtCK,qBAESC,sBAGA5B,mBAQT6B,qBACSzB,WAAY,IAAIE,MAAOC,WACxB,6BAAiBpK,KAAKH,UAAYG,KAAK+F,iBAClCvB,0BAAyB,QAE7BmH,yBAQTC,oBACS1B,wBACA5C,6BAA6B,UAQtCuE,oBACSxC,wBACA/B,6BAA6B,SAQtCwE,oBAAoBjG,UACZ7F,KAAK8F,eAAiB9F,KAAK+F,WAAY,OACjCgG,QAAU/L,KAAKgH,KAAKgF,SAAWnG,MAAMmB,KAAKiF,KAG5CF,SAAW/L,KAAK+K,yBACXG,oBACAgB,oCAGAlF,KAAKC,OAAOjF,KAAK6D,MAAMmB,WAGvBA,KAAKgF,SAAWD,QAEjB/L,KAAKiL,oBACAC,yEAOF,kBAAU,iBAAkBhI,mBAAY,CACnDC,YAAa,kBAAU,uBAAwBD,mBAC/CnB,KAAM,UASd+D,4CACyC,gDAAzBa,wEAAe/B,OAQ/BmB,0CACyC,8CAAzBY,0EAAe/B,OAQ/BqB,oDACajG,KAAKgH,6BAALmF,WAAWH,oCAOhBhM,KAAK2G,cAAe,KAEhB3G,KAAK8F,eAAiB9F,KAAK+F,kBACtBY,cAAcwE,OAGnBnL,KAAKiG,UAAW,WACajG,KAAKoM,sCAK7B1H,2BAA0B,QAC1BC,gBAAe,GACf3E,KAAK2C,OAAO0J,cACPrM,KAAKc,wBAId6F,cAAgB,UAIpBA,cAAgB,IAAIvE,cAAcpC,KAAK2C,OAAQ3C,KAAK2B,kCAEpDgF,cAAcxB,iBAAiB,gBAAiBnF,KAAK8L,oBAAoBzG,KAAKrF,YAC9E2G,cAAcxB,iBAAiB,OAAQnF,KAAKwL,cAAcnG,KAAKrF,YAC/D2G,cAAcxB,iBAAiB,QAASnF,KAAK0L,cAAcrG,KAAKrF,YAChE2G,cAAcxB,iBAAiB,QAASnF,KAAK4L,aAAavG,KAAKrF,YAC/D2G,cAAcxB,iBAAiB,SAAUnF,KAAK6L,aAAaxG,KAAKrF,YAEhEgH,KAAO,CACRC,OAAQ,GACR+E,SAAU,QAEThI,yBACAiH,eAAgB,OAGhBtE,cAAc2F,MAAM,qDAUf,yCACI,kBAAU,oBAAqBpJ,yBAC/B,kBAAU,mBAAoBA,yBAC9B,kBAAU,cAAeA,qBAE5B,EACT,aACS,qBASGqJ,cACRxD,KAACA,YAAcE,UAAUC,iBAC3BlJ,KAAK0B,uBACL1B,KAAKwM,wBAAwB,CACzBD,OAAAA,eAGH1M,OAAO4M,cAAc1D,MAS9ByD,wBAAwBpE,wBACbA"}
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js
index cdee95028bbc7..01505c3737aad 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js
@@ -1,4 +1,4 @@
-define("tiny_recordrtc/options",["exports","./common","editor_tiny/options"],(function(_exports,_common,_options){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.register=_exports.isVideoAllowed=_exports.isScreenAllowed=_exports.isAudioAllowed=_exports.getData=void 0;
+define("tiny_recordrtc/options",["exports","./common","editor_tiny/options"],(function(_exports,_common,_options){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.register=_exports.isVideoAllowed=_exports.isScreenAllowed=_exports.isPausingAllowed=_exports.isAudioAllowed=_exports.getData=void 0;
/**
* Options helper for Tiny Record RTC plugin.
*
@@ -6,6 +6,6 @@ define("tiny_recordrtc/options",["exports","./common","editor_tiny/options"],(fu
* @copyright 2022, Stevani Andolo
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-const dataName=(0,_options.getPluginOptionName)(_common.pluginName,"data"),videoAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"videoAllowed"),audioAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"audioAllowed"),screenAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"screenAllowed");_exports.register=editor=>{const registerOption=editor.options.register;registerOption(dataName,{processor:"object"}),registerOption(videoAllowedName,{processor:"boolean",default:!1}),registerOption(audioAllowedName,{processor:"boolean",default:!1}),registerOption(screenAllowedName,{processor:"boolean",default:!1})};_exports.getData=editor=>editor.options.get(dataName);_exports.isAudioAllowed=editor=>editor.options.get(audioAllowedName);_exports.isVideoAllowed=editor=>editor.options.get(videoAllowedName);_exports.isScreenAllowed=editor=>editor.options.get(screenAllowedName)}));
+const dataName=(0,_options.getPluginOptionName)(_common.pluginName,"data"),videoAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"videoAllowed"),audioAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"audioAllowed"),screenAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"screenAllowed"),pausingAllowedName=(0,_options.getPluginOptionName)(_common.pluginName,"pausingAllowed");_exports.register=editor=>{const registerOption=editor.options.register;registerOption(dataName,{processor:"object"}),registerOption(videoAllowedName,{processor:"boolean",default:!1}),registerOption(audioAllowedName,{processor:"boolean",default:!1}),registerOption(screenAllowedName,{processor:"boolean",default:!1}),registerOption(pausingAllowedName,{processor:"boolean",default:!1})};_exports.getData=editor=>editor.options.get(dataName);_exports.isAudioAllowed=editor=>editor.options.get(audioAllowedName);_exports.isVideoAllowed=editor=>editor.options.get(videoAllowedName);_exports.isScreenAllowed=editor=>editor.options.get(screenAllowedName);_exports.isPausingAllowed=editor=>editor.options.get(pausingAllowedName)}));
//# sourceMappingURL=options.min.js.map
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map
index 2ec39ef318450..b720b51ccbc2c 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/options.min.js.map
@@ -1 +1 @@
-{"version":3,"file":"options.min.js","sources":["../src/options.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {pluginName} from './common';\nimport {getPluginOptionName} from 'editor_tiny/options';\n\nconst dataName = getPluginOptionName(pluginName, 'data');\nconst videoAllowedName = getPluginOptionName(pluginName, 'videoAllowed');\nconst audioAllowedName = getPluginOptionName(pluginName, 'audioAllowed');\nconst screenAllowedName = getPluginOptionName(pluginName, 'screenAllowed');\n\nexport const register = (editor) => {\n const registerOption = editor.options.register;\n\n registerOption(dataName, {\n processor: 'object',\n });\n\n registerOption(videoAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(audioAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(screenAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n};\n\nexport const getData = (editor) => editor.options.get(dataName);\n\n/**\n * Whether video may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isAudioAllowed = (editor) => editor.options.get(audioAllowedName);\n\n/**\n * Whether audio may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isVideoAllowed = (editor) => editor.options.get(videoAllowedName);\n\n/**\n * Whether screen may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isScreenAllowed = (editor) => editor.options.get(screenAllowedName);\n"],"names":["dataName","pluginName","videoAllowedName","audioAllowedName","screenAllowedName","editor","registerOption","options","register","processor","get"],"mappings":";;;;;;;;MA0BMA,UAAW,gCAAoBC,mBAAY,QAC3CC,kBAAmB,gCAAoBD,mBAAY,gBACnDE,kBAAmB,gCAAoBF,mBAAY,gBACnDG,mBAAoB,gCAAoBH,mBAAY,mCAEjCI,eACfC,eAAiBD,OAAOE,QAAQC,SAEtCF,eAAeN,SAAU,CACrBS,UAAW,WAGfH,eAAeJ,iBAAkB,CAC7BO,UAAW,mBACA,IAGfH,eAAeH,iBAAkB,CAC7BM,UAAW,mBACA,IAGfH,eAAeF,kBAAmB,CAC9BK,UAAW,mBACA,sBAIKJ,QAAWA,OAAOE,QAAQG,IAAIV,kCAQvBK,QAAWA,OAAOE,QAAQG,IAAIP,0CAQ9BE,QAAWA,OAAOE,QAAQG,IAAIR,2CAQ7BG,QAAWA,OAAOE,QAAQG,IAAIN"}
\ No newline at end of file
+{"version":3,"file":"options.min.js","sources":["../src/options.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {pluginName} from './common';\nimport {getPluginOptionName} from 'editor_tiny/options';\n\nconst dataName = getPluginOptionName(pluginName, 'data');\nconst videoAllowedName = getPluginOptionName(pluginName, 'videoAllowed');\nconst audioAllowedName = getPluginOptionName(pluginName, 'audioAllowed');\nconst screenAllowedName = getPluginOptionName(pluginName, 'screenAllowed');\nconst pausingAllowedName = getPluginOptionName(pluginName, 'pausingAllowed');\n\nexport const register = (editor) => {\n const registerOption = editor.options.register;\n\n registerOption(dataName, {\n processor: 'object',\n });\n\n registerOption(videoAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(audioAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(screenAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n\n registerOption(pausingAllowedName, {\n processor: 'boolean',\n \"default\": false,\n });\n};\n\nexport const getData = (editor) => editor.options.get(dataName);\n\n/**\n * Whether video may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isAudioAllowed = (editor) => editor.options.get(audioAllowedName);\n\n/**\n * Whether audio may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isVideoAllowed = (editor) => editor.options.get(videoAllowedName);\n\n/**\n * Whether screen may be recorded in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isScreenAllowed = (editor) => editor.options.get(screenAllowedName);\n\n/**\n * Whether pausing is allowed in this instance.\n *\n * @param {TinyMCE} editor\n * @returns {boolean}\n */\nexport const isPausingAllowed = (editor) => editor.options.get(pausingAllowedName);\n"],"names":["dataName","pluginName","videoAllowedName","audioAllowedName","screenAllowedName","pausingAllowedName","editor","registerOption","options","register","processor","get"],"mappings":";;;;;;;;MA0BMA,UAAW,gCAAoBC,mBAAY,QAC3CC,kBAAmB,gCAAoBD,mBAAY,gBACnDE,kBAAmB,gCAAoBF,mBAAY,gBACnDG,mBAAoB,gCAAoBH,mBAAY,iBACpDI,oBAAqB,gCAAoBJ,mBAAY,oCAElCK,eACfC,eAAiBD,OAAOE,QAAQC,SAEtCF,eAAeP,SAAU,CACrBU,UAAW,WAGfH,eAAeL,iBAAkB,CAC7BQ,UAAW,mBACA,IAGfH,eAAeJ,iBAAkB,CAC7BO,UAAW,mBACA,IAGfH,eAAeH,kBAAmB,CAC9BM,UAAW,mBACA,IAGfH,eAAeF,mBAAoB,CAC/BK,UAAW,mBACA,sBAIKJ,QAAWA,OAAOE,QAAQG,IAAIX,kCAQvBM,QAAWA,OAAOE,QAAQG,IAAIR,0CAQ9BG,QAAWA,OAAOE,QAAQG,IAAIT,2CAQ7BI,QAAWA,OAAOE,QAAQG,IAAIP,6CAQ7BE,QAAWA,OAAOE,QAAQG,IAAIN"}
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js
index 216450ff110ff..d1f7dbf134bf6 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js
@@ -1,3 +1,3 @@
-define("tiny_recordrtc/screen_recorder",["exports","./base_recorder","tiny_recordrtc/modal","tiny_recordrtc/common","core/str"],(function(_exports,_base_recorder,_modal,_common,_str){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_base_recorder=_interopRequireDefault(_base_recorder),_modal=_interopRequireDefault(_modal);class Screen extends _base_recorder.default{configurePlayer(){return this.modalRoot.querySelector("video")}getSupportedTypes(){return["video/webm;codecs=vp9,opus","video/webm;codecs=vp8,opus","video/mp4;codecs=h264,opus","video/mp4;codecs=h264,wav","video/mp4;codecs=v9,opus"]}getRecordingOptions(){return{videoBitsPerSecond:parseInt(this.config.screenbitrate),videoWidth:parseInt(this.config.videoscreenwidth),videoHeight:parseInt(this.config.videoscreenheight)}}getMediaConstraints(){return{audio:!0,systemAudio:"exclude",video:{displaySurface:"monitor",frameRate:{ideal:24},width:{max:parseInt(this.config.videoscreenwidth)},height:{max:parseInt(this.config.videoscreenheight)}}}}playOnCapture(){return!0}getRecordingType(){return"screen"}getTimeLimit(){return this.config.screentimelimit}getEmbedTemplateName(){return"tiny_recordrtc/embed_screen"}getFileName(prefix){return"".concat(prefix,"-video.").concat(this.getFileExtension())}getFileExtension(){return window.MediaRecorder.isTypeSupported("audio/webm")?"webm":window.MediaRecorder.isTypeSupported("audio/mp4")?"mp4":(window.console.warn("Unknown file type for MediaRecorder API"),"")}async captureUserMedia(){const audioPromise=navigator.mediaDevices.getUserMedia({audio:!0}),screenPromise=navigator.mediaDevices.getDisplayMedia(this.getMediaConstraints());await Promise.allSettled([audioPromise,screenPromise]).then(this.combineAudioAndScreenRecording.bind(this))}combineAudioAndScreenRecording(results){const[audioData,screenData]=results;if("fulfilled"!==screenData.status)return void this.handleCaptureFailure(screenData.reason);const screenStream=screenData.value;if(screenStream.getVideoTracks()[0].addEventListener("ended",this.handleStopScreenSharing.bind(this)),"fulfilled"!==audioData.status)return void this.handleCaptureSuccess(screenStream);const audioStream=audioData.value,composedStream=new MediaStream;screenStream.getTracks().forEach((function(track){"video"===track.kind?composedStream.addTrack(track):track.stop()})),audioStream.getAudioTracks().forEach((function(micTrack){composedStream.addTrack(micTrack)})),this.handleCaptureSuccess(composedStream)}handleStopScreenSharing(){this.isRecording()?(this.requestRecordingStop(),this.cleanupStream()):(this.setRecordButtonState(!1),this.displayAlert((0,_str.getString)("screensharingstopped_title",_common.component),(0,_str.getString)("screensharingstopped",_common.component)))}handleRecordingStartStopRequested(){this.isRecording()?(this.requestRecordingStop(),this.cleanupStream()):this.startRecording()}static getModalClass(){var _class;return _defineProperty(_class=class extends _modal.default{},"TYPE","".concat(_common.component,"/screen_recorder")),_defineProperty(_class,"TEMPLATE","".concat(_common.component,"/screen_recorder")),_class}}return _exports.default=Screen,_exports.default}));
+define("tiny_recordrtc/screen_recorder",["exports","./base_recorder","tiny_recordrtc/modal","tiny_recordrtc/common","core/str"],(function(_exports,_base_recorder,_modal,_common,_str){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_base_recorder=_interopRequireDefault(_base_recorder),_modal=_interopRequireDefault(_modal);class Screen extends _base_recorder.default{configurePlayer(){return this.modalRoot.querySelector("video")}getSupportedTypes(){return["video/webm;codecs=vp9,opus","video/webm;codecs=vp8,opus","video/mp4;codecs=h264,opus","video/mp4;codecs=h264,wav","video/mp4;codecs=v9,opus"]}getRecordingOptions(){return{videoBitsPerSecond:parseInt(this.config.screenbitrate),videoWidth:parseInt(this.config.videoscreenwidth),videoHeight:parseInt(this.config.videoscreenheight)}}getMediaConstraints(){return{audio:!0,systemAudio:"exclude",video:{displaySurface:"monitor",frameRate:{ideal:24},width:{max:parseInt(this.config.videoscreenwidth)},height:{max:parseInt(this.config.videoscreenheight)}}}}playOnCapture(){return!0}getRecordingType(){return"screen"}getTimeLimit(){return this.config.screentimelimit}getEmbedTemplateName(){return"tiny_recordrtc/embed_screen"}getFileName(prefix){return"".concat(prefix,"-video.").concat(this.getFileExtension())}getFileExtension(){return window.MediaRecorder.isTypeSupported("audio/webm")?"webm":window.MediaRecorder.isTypeSupported("audio/mp4")?"mp4":(window.console.warn("Unknown file type for MediaRecorder API"),"")}async captureUserMedia(){const audioPromise=navigator.mediaDevices.getUserMedia({audio:!0}),screenPromise=navigator.mediaDevices.getDisplayMedia(this.getMediaConstraints());await Promise.allSettled([audioPromise,screenPromise]).then(this.combineAudioAndScreenRecording.bind(this))}combineAudioAndScreenRecording(results){const[audioData,screenData]=results;if("fulfilled"!==screenData.status)return void this.handleCaptureFailure(screenData.reason);const screenStream=screenData.value;if(screenStream.getVideoTracks()[0].addEventListener("ended",this.handleStopScreenSharing.bind(this)),"fulfilled"!==audioData.status)return void this.handleCaptureSuccess(screenStream);const audioStream=audioData.value,composedStream=new MediaStream;screenStream.getTracks().forEach((function(track){"video"===track.kind?composedStream.addTrack(track):track.stop()})),audioStream.getAudioTracks().forEach((function(micTrack){composedStream.addTrack(micTrack)})),this.handleCaptureSuccess(composedStream)}handleStopScreenSharing(){this.isRecording()||this.isPaused()?(this.requestRecordingStop(),this.cleanupStream()):(this.setRecordButtonState(!1),this.displayAlert((0,_str.getString)("screensharingstopped_title",_common.component),(0,_str.getString)("screensharingstopped",_common.component)))}handleRecordingStartStopRequested(){this.isRecording()||this.isPaused()?(this.requestRecordingStop(),this.cleanupStream()):this.startRecording()}static getModalClass(){var _class;return _defineProperty(_class=class extends _modal.default{},"TYPE","".concat(_common.component,"/screen_recorder")),_defineProperty(_class,"TEMPLATE","".concat(_common.component,"/screen_recorder")),_class}}return _exports.default=Screen,_exports.default}));
//# sourceMappingURL=screen_recorder.min.js.map
\ No newline at end of file
diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map
index 2f4db9eacb3d6..22804ddc6847e 100644
--- a/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map
+++ b/lib/editor/tiny/plugins/recordrtc/amd/build/screen_recorder.min.js.map
@@ -1 +1 @@
-{"version":3,"file":"screen_recorder.min.js","sources":["../src/screen_recorder.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see
-
';
+ return $html;
+ }
+
+ /**
+ * @deprecated since Moodle 3.2
+ */
+ public function update_module_button() {
+ throw new coding_exception('core_renderer::update_module_button() can not be used anymore. Activity ' .
+ 'modules should not add the edit module button, the link is already available in the Administration block. ' .
+ 'Themes can choose to display the link in the buttons row consistently for all module types.');
+ }
+
+ /**
+ * Returns HTML to display a "Turn editing on/off" button in a form.
+ *
+ * @param moodle_url $url The URL + params to send through when clicking the button
+ * @param string $method
+ * @return ?string HTML the button
+ */
+ public function edit_button(moodle_url $url, string $method = 'post') {
+
+ if ($this->page->theme->haseditswitch == true) {
+ return;
+ }
+ $url->param('sesskey', sesskey());
+ if ($this->page->user_is_editing()) {
+ $url->param('edit', 'off');
+ $editstring = get_string('turneditingoff');
+ } else {
+ $url->param('edit', 'on');
+ $editstring = get_string('turneditingon');
+ }
+
+ return $this->single_button($url, $editstring, $method);
+ }
+
+ /**
+ * Create a navbar switch for toggling editing mode.
+ *
+ * @return ?string Html containing the edit switch
+ */
+ public function edit_switch() {
+ if ($this->page->user_allowed_editing()) {
+ $temp = (object) [
+ 'legacyseturl' => (new moodle_url('/editmode.php'))->out(false),
+ 'pagecontextid' => $this->page->context->id,
+ 'pageurl' => $this->page->url,
+ 'sesskey' => sesskey(),
+ ];
+ if ($this->page->user_is_editing()) {
+ $temp->checked = true;
+ }
+ return $this->render_from_template('core/editswitch', $temp);
+ }
+ }
+
+ /**
+ * Returns HTML to display a simple button to close a window
+ *
+ * @param string $text The lang string for the button's label (already output from get_string())
+ * @return string html fragment
+ */
+ public function close_window_button($text = '') {
+ if (empty($text)) {
+ $text = get_string('closewindow');
+ }
+ $button = new single_button(new moodle_url('#'), $text, 'get');
+ $button->add_action(new component_action('click', 'close_window'));
+
+ return $this->container($this->render($button), 'closewindow');
+ }
+
+ /**
+ * Output an error message. By default wraps the error message in .
+ * If the error message is blank, nothing is output.
+ *
+ * @param string $message the error message.
+ * @return string the HTML to output.
+ */
+ public function error_text($message) {
+ if (empty($message)) {
+ return '';
+ }
+ $message = $this->pix_icon('i/warning', get_string('error'), '', ['class' => 'icon', 'title' => '']) . $message;
+ return html_writer::tag('span', $message, ['class' => 'error']);
+ }
+
+ /**
+ * Do not call this function directly.
+ *
+ * To terminate the current script with a fatal error, throw an exception.
+ * Doing this will then call this function to display the error, before terminating the execution.
+ *
+ * @param string $message The message to output
+ * @param string $moreinfourl URL where more info can be found about the error
+ * @param string $link Link for the Continue button
+ * @param array $backtrace The execution backtrace
+ * @param null|string $debuginfo Debugging information
+ * @param string $errorcode
+ * @return string the HTML to output.
+ */
+ public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
+ global $CFG;
+
+ $output = '';
+ $obbuffer = '';
+
+ if ($this->has_started()) {
+ // we can not always recover properly here, we have problems with output buffering,
+ // html tables, etc.
+ $output .= $this->opencontainers->pop_all_but_last();
+ } else {
+ // It is really bad if library code throws exception when output buffering is on,
+ // because the buffered text would be printed before our start of page.
+ // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
+ error_reporting(0); // disable notices from gzip compression, etc.
+ while (ob_get_level() > 0) {
+ $buff = ob_get_clean();
+ if ($buff === false) {
+ break;
+ }
+ $obbuffer .= $buff;
+ }
+ error_reporting($CFG->debug);
+
+ // Output not yet started.
+ $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
+ if (empty($_SERVER['HTTP_RANGE'])) {
+ @header($protocol . ' 404 Not Found');
+ } else if (core_useragent::check_safari_ios_version(602) && !empty($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) {
+ // Coax iOS 10 into sending the session cookie.
+ @header($protocol . ' 403 Forbidden');
+ } else {
+ // Must stop byteserving attempts somehow,
+ // this is weird but Chrome PDF viewer can be stopped only with 407!
+ @header($protocol . ' 407 Proxy Authentication Required');
+ }
+
+ $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
+ $this->page->set_url('/'); // no url
+ // $this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
+ $this->page->set_title(get_string('error'));
+ $this->page->set_heading($this->page->course->fullname);
+ // No need to display the activity header when encountering an error.
+ $this->page->activityheader->disable();
+ $output .= $this->header();
+ }
+
+ $message = '' .
+ '
+
diff --git a/calendar/templates/view_selector.mustache b/calendar/templates/view_selector.mustache
index 6a9de4cad1dd8..a0d5ce36edf2f 100644
--- a/calendar/templates/view_selector.mustache
+++ b/calendar/templates/view_selector.mustache
@@ -27,7 +27,7 @@
}
}}
diff --git a/course/tests/backup/restore_test.php b/course/tests/backup/restore_test.php
index bfd98f5752bc0..83dd5dfc5c6fc 100644
--- a/course/tests/backup/restore_test.php
+++ b/course/tests/backup/restore_test.php
@@ -575,7 +575,9 @@ public function test_restore_course_startdate_in_existing_course_without_permiss
* Tests course restore with editor in course format.
*
* @author Matthew Hilton
- * @covers \core_courseformat
+ * @covers \core_courseformat\base
+ * @covers \backup_course_structure_step
+ * @covers \restore_course_structure_step
*/
public function test_restore_editor_courseformat(): void {
$this->resetAfterTest();
diff --git a/course/tests/behat/activities_visibility_icons.feature b/course/tests/behat/activities_visibility_icons.feature
index 382110cc13e3e..557b378dabf64 100644
--- a/course/tests/behat/activities_visibility_icons.feature
+++ b/course/tests/behat/activities_visibility_icons.feature
@@ -6,16 +6,18 @@ Feature: Toggle activities visibility from the course page
Background:
Given the following "users" exist:
- | username | firstname | lastname | email |
- | teacher1 | Teacher | 1 | teacher1@example.com |
- | student1 | Student | 1 | student1@example.com |
+ | username | firstname | lastname | email |
+ | teacher1 | Teacher | 1 | teacher1@example.com |
+ | noneditingteacher1 | Non-Editing Teacher | 1 | noneditingteacher1@example.com |
+ | student1 | Student | 1 | student1@example.com |
And the following "courses" exist:
| fullname | shortname | format | numsections |
| Course 1 | C1 | topics | 2 |
And the following "course enrolments" exist:
- | user | course | role |
- | teacher1 | C1 | editingteacher |
- | student1 | C1 | student |
+ | user | course | role |
+ | teacher1 | C1 | editingteacher |
+ | noneditingteacher1 | C1 | teacher |
+ | student1 | C1 | student |
And the following "activities" exist:
| activity | course | section | idnumber | name | intro | id_visible |
| assign | C1 | 1 | 1 | Test assignment name | Test assignment description | 1 |
@@ -53,6 +55,9 @@ Feature: Toggle activities visibility from the course page
And the field "Availability" matches value "Hide on course page"
And I press "Save and return to course"
And "Test forum name" activity should be hidden
+ # Non-editing teacher should see this activity.
+ And I am on the "Course 1" course page logged in as noneditingteacher1
+ And I should see "Test forum name" in the "region-main" "region"
# Student should not see this activity.
And I am on the "Course 1" course page logged in as student1
And I should not see "Test forum name"
@@ -115,12 +120,12 @@ Feature: Toggle activities visibility from the course page
And "Test assignment name" activity should be available but hidden from course page
And I turn editing mode off
And "Test assignment name" activity should be available but hidden from course page
- And I log out
+ # Non-editing teacher will see the module on the course page:
+ And I am on the "Course 1" course page logged in as noneditingteacher1
+ And I should see "Test assignment name" in the "region-main" "region"
# Student will not see the module on the course page but can access it from other reports and blocks:
- And I log in as "student1"
- And I am on "Course 1" course homepage
+ And I am on the "Course 1" course page logged in as student1
And "Test assignment name" activity should be hidden
And I click on "Test assignment name" "link" in the "Recent activity" "block"
And I should see "Test assignment name"
And I should see "Submission status"
- And I log out
diff --git a/course/tests/behat/activity_chooser.feature b/course/tests/behat/activity_chooser.feature
index 1d099e6fde8ac..ad6b9115fb13c 100644
--- a/course/tests/behat/activity_chooser.feature
+++ b/course/tests/behat/activity_chooser.feature
@@ -302,7 +302,7 @@ Feature: Display and choose from the available activities in course
# Confirm more help link exists
Then "More help" "link" should exist
# Confirm that corresponding help icon exist
- And ".iconhelp" "css_element" should exist
+ And ".fa-info-circle" "css_element" should exist
# Confirm that link opens in new window
And "Opens in new window" "link" should be visible
# Confirm the same behaviour for weekly format course
@@ -313,6 +313,6 @@ Feature: Display and choose from the available activities in course
# Confirm more help link exists
And "More help" "link" should exist
# Confirm that corresponding help icon exist
- And ".iconhelp" "css_element" should exist
+ And ".fa-info-circle" "css_element" should exist
# Confirm that link opens in new window
And "Opens in new window" "link" should be visible
diff --git a/course/tests/behat/activity_tags_deletion.feature b/course/tests/behat/activity_tags_deletion.feature
index a969aae3e7ae8..f4a034cb6d9b4 100644
--- a/course/tests/behat/activity_tags_deletion.feature
+++ b/course/tests/behat/activity_tags_deletion.feature
@@ -22,7 +22,9 @@ Feature: Delete activity tags during course reset
# Perform course reset without checking anything.
And I log in as "admin"
And I am on the "Course 1" "reset" page
- And I press "Reset"
+ And I press "Deselect all"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I press "Continue"
# Confirm that book chapter tags are not deleted.
When I am on the "Test Book" "book activity" page
@@ -30,9 +32,10 @@ Feature: Delete activity tags during course reset
And I should see "ChapterTag"
# Delete book chapter tags using course reset.
And I am on the "Course 1" "reset" page
- And I expand all fieldsets
+ And I press "Deselect all"
And I click on "All book tags" "checkbox"
- And I press "Reset"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
# Confirm that book chapter tags are deleted.
And I should see "All book tags" in the "Books" "table_row"
And I press "Continue"
@@ -47,7 +50,9 @@ Feature: Delete activity tags during course reset
| admin | forum1 | Discussion 1 | Discussion 1 message | SampleTag, DiscussionTag |
# Perform course reset without checking anything.
And I am on the "Course 1" "reset" page logged in as admin
- And I press "Reset"
+ And I press "Deselect all"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I press "Continue"
# Confirm that forum discussion tags are not deleted.
When I am on the "Test Forum" "forum activity" page
@@ -55,12 +60,13 @@ Feature: Delete activity tags during course reset
Then I should see "SampleTag"
And I should see "DiscussionTag"
And I am on the "Course 1" "reset" page
- And I expand all fieldsets
+ And I press "Deselect all"
# Depending on value, either delete all discussion posts or remove all forum discussion tags only.
And I click on "" "checkbox"
# Confirm `Remove all forum tags` is disabled when `Delete all posts` on previous step is checked.
And the "All forum tags" "checkbox" should be
- And I press "Reset"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I should see "" in the "Forums" "table_row"
And I press "Continue"
And I am on the "Test Forum" "forum activity" page
@@ -82,19 +88,22 @@ Feature: Delete activity tags during course reset
| Test Glossary | Aubergine | Also eggpgplant | admin | SampleTag, GlossaryTag |
# Perform course reset without checking anything.
And I am on the "Course 1" "reset" page logged in as admin
- And I press "Reset"
+ And I press "Deselect all"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I press "Continue"
# Confirm that glossary entry tags are not deleted.
When I am on the "Test Glossary" "glossary activity" page
Then I should see "SampleTag"
And I should see "GlossaryTag"
And I am on the "Course 1" "reset" page
- And I expand all fieldsets
+ And I press "Deselect all"
# Depending on value, either delete all glossary entries or remove all glossary entry tags only.
And I click on "" "checkbox"
# Confirm `Remove all forum tags` is disabled when `Delete entries from all glossaries` on previous step is checked.
And the "All glossary tags" "checkbox" should be
- And I press "Reset"
+ And I press "Reset course"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
And I should see "" in the "Glossaries" "table_row"
And I press "Continue"
And I am on the "Test Glossary" "glossary activity" page
diff --git a/course/tests/behat/reset_course.feature b/course/tests/behat/reset_course.feature
new file mode 100644
index 0000000000000..e202c965e7c3f
--- /dev/null
+++ b/course/tests/behat/reset_course.feature
@@ -0,0 +1,75 @@
+@core @core_course
+Feature: Reset course
+ In order to reuse a course
+ As a teacher
+ I need to clear all user data and reset the course to its initial state
+
+ Background:
+ Given the following "users" exist:
+ | username | firstname | lastname | email |
+ | teacher1 | Teacher | 1 | teacher1@example.com |
+ | student1 | Student | 1 | student1@example.com |
+ And the following "courses" exist:
+ | fullname | shortname | format | numsections |
+ | Course 1 | C1 | topics | 2 |
+ And the following "course enrolments" exist:
+ | user | course | role |
+ | teacher1 | C1 | editingteacher |
+ | student1 | C1 | student |
+ And the following "activity" exists:
+ | activity | assign |
+ | course | C1 |
+ | name | Test assignment name |
+ | assignsubmission_onlinetext_enabled | 1 |
+ | assignsubmission_file_enabled | 0 |
+ | submissiondrafts | 0 |
+ And the following "mod_assign > submissions" exist:
+ | assign | user | onlinetext |
+ | Test assignment name | student1 | I'm the student1 submission |
+
+ Scenario: Reset course select and deselect buttons
+ When I am on the "Course 1" "reset" page logged in as "teacher1"
+ Then I should see "Collapse all"
+ And the field "Events" matches value "1"
+ And the field "All notes" matches value "1"
+ And the field "All comments" matches value "0"
+ And the field "Completion data" matches value "0"
+ And the field "All submissions" matches value "1"
+ And the field "All user overrides" matches value "1"
+ And the field "All group overrides" matches value "1"
+ # Check fields are unchecked when Deselect all is clicked
+ And I click on "Deselect all" "button"
+ And the field "Events" matches value "0"
+ And the field "All notes" matches value "0"
+ And the field "All comments" matches value "0"
+ And the field "Completion data" matches value "0"
+ And the field "All submissions" matches value "0"
+ And the field "All user overrides" matches value "0"
+ And the field "All group overrides" matches value "0"
+ # Check default fields are checked again when Select default is clicked
+ And I click on "Select default" "button"
+ And the field "Events" matches value "1"
+ And the field "All notes" matches value "1"
+ And the field "All comments" matches value "0"
+ And the field "Completion data" matches value "0"
+ And the field "All submissions" matches value "1"
+ And the field "All user overrides" matches value "1"
+ And the field "All group overrides" matches value "1"
+
+ @javascript
+ Scenario: Reset course with default settings
+ Given I am on the "Course 1" "reset" page logged in as "teacher1"
+ When I click on "Reset course" "button"
+ And I click on "Reset course" "button" in the "Reset course?" "dialogue"
+ Then I should see "Done" in the "All notes" "table_row"
+ And I should see "Done" in the "All local role assignments" "table_row"
+ And I should see "Done" in the "All submissions" "table_row"
+ And I click on "Continue" "button"
+ # Check that you're redirected to the course page.
+ And I should not see "Reset course"
+ # Check the course has been reset.
+ And I navigate to course participants
+ And I should see "Teacher 1"
+ And I should not see "Student 1"
+ And I am on the "Test assignment name" "assign activity" page
+ And I should see "0" in the "Submitted" "table_row"
diff --git a/course/tests/course_delete_modules_test.php b/course/tests/course_delete_modules_test.php
index 1164f0964fe59..d70d567d7fffa 100644
--- a/course/tests/course_delete_modules_test.php
+++ b/course/tests/course_delete_modules_test.php
@@ -21,6 +21,7 @@
* @subpackage course
* @copyright 2021 Tomo Tsuyuki
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \core_course\task\course_delete_modules
*/
namespace core_course;
@@ -68,8 +69,6 @@ public function test_delete_module_execution(): void {
/**
* Test with failed and successful cms
- *
- * @covers ::course_delete_modules
*/
public function test_delete_module_exception(): void {
global $DB;
diff --git a/customfield/templates/list.mustache b/customfield/templates/list.mustache
index 521b268c11611..9e4cf28a42552 100644
--- a/customfield/templates/list.mustache
+++ b/customfield/templates/list.mustache
@@ -78,10 +78,11 @@
diff --git a/enrol/cohort/tests/behat/enrolcohorts.feature b/enrol/cohort/tests/behat/enrolcohorts.feature
index 2571dc52cbebf..a59b8a48029c6 100644
--- a/enrol/cohort/tests/behat/enrolcohorts.feature
+++ b/enrol/cohort/tests/behat/enrolcohorts.feature
@@ -83,11 +83,11 @@ Feature: Cohort enrolment management
And I navigate to course participants
# Verifies students 1 and 4 are in the cohort and student 2 is not any more.
And the following should exist in the "participants" table:
- | First name / Last name | Email address | Roles | Groups |
+ | First name | Email address | Roles | Groups |
| Sandra Cole | s1@example.com | Student | Alpha1 cohort |
| Jane Doe | s4@example.com | Student | Alpha1 cohort |
And the following should not exist in the "participants" table:
- | First name / Last name | Email address | Roles | Groups |
+ | First name | Email address | Roles | Groups |
| John Smith | s2@example.com | Student | Alpha1 cohort |
@javascript
diff --git a/enrol/editinstance.php b/enrol/editinstance.php
index 2363340f918ee..047ab93e93304 100644
--- a/enrol/editinstance.php
+++ b/enrol/editinstance.php
@@ -38,7 +38,10 @@
}
require_login($course);
-require_capability('enrol/' . $type . ':config', $context);
+
+if (!has_any_capability(['enrol/' . $type . ':config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ throw new \moodle_exception('nopermissiontoaccesspage', 'error');
+}
$url = new moodle_url('/enrol/editinstance.php', ['courseid' => $course->id, 'id' => $instanceid, 'type' => $type]);
$PAGE->set_url($url);
diff --git a/enrol/manual/lib.php b/enrol/manual/lib.php
index c41d5d970d021..0ef478a228b98 100644
--- a/enrol/manual/lib.php
+++ b/enrol/manual/lib.php
@@ -114,8 +114,17 @@ public function get_action_icons(stdClass $instance) {
$managelink = new moodle_url("/enrol/manual/manage.php", array('enrolid'=>$instance->id));
$icons[] = $OUTPUT->action_icon($managelink, new pix_icon('t/enrolusers', get_string('enrolusers', 'enrol_manual'), 'core', array('class'=>'iconsmall')));
}
- $parenticons = parent::get_action_icons($instance);
- $icons = array_merge($icons, $parenticons);
+
+ if (has_any_capability(['enrol/manual:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $linkparams = [
+ 'courseid' => $instance->courseid,
+ 'id' => $instance->id,
+ 'type' => $instance->enrol,
+ ];
+ $editlink = new moodle_url('/enrol/editinstance.php', $linkparams);
+ $icon = new pix_icon('t/edit', get_string('edit'), 'core', ['class' => 'iconsmall']);
+ $icons[] = $OUTPUT->action_icon($editlink, $icon);
+ }
return $icons;
}
@@ -175,7 +184,11 @@ public function update_instance($instance, $data) {
}
}
- $data->notifyall = $data->expirynotify == 2 ? 1 : 0;
+ // This method is used when configuring the enrolment method, and when only updating the welcome message.
+ // The 'expirynotify' property won't be set when updating the welcome message.
+ if (isset($data->expirynotify)) {
+ $data->notifyall = $data->expirynotify == 2 ? 1 : 0;
+ }
return parent::update_instance($instance, $data);
}
@@ -582,86 +595,92 @@ protected function get_expirynotify_options() {
*/
public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
- $options = $this->get_status_options();
- $mform->addElement('select', 'status', get_string('status', 'enrol_manual'), $options);
- $mform->addHelpButton('status', 'status', 'enrol_manual');
- $mform->setDefault('status', $this->get_config('status'));
-
- $roles = $this->get_roleid_options($instance, $context);
- $mform->addElement('select', 'roleid', get_string('defaultrole', 'role'), $roles);
- $mform->setDefault('roleid', $this->get_config('roleid'));
-
- $options = array('optional' => true, 'defaultunit' => 86400);
- $mform->addElement('duration', 'enrolperiod', get_string('defaultperiod', 'enrol_manual'), $options);
- $mform->setDefault('enrolperiod', $this->get_config('enrolperiod'));
- $mform->addHelpButton('enrolperiod', 'defaultperiod', 'enrol_manual');
-
- $options = $this->get_expirynotify_options();
- $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
- $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
-
- $options = array('optional' => false, 'defaultunit' => 86400);
- $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
- $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
- $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
+ // Main fields.
+ if (has_capability('enrol/manual:config', $context)) {
+ $options = $this->get_status_options();
+ $mform->addElement('select', 'status', get_string('status', 'enrol_manual'), $options);
+ $mform->addHelpButton('status', 'status', 'enrol_manual');
+ $mform->setDefault('status', $this->get_config('status'));
+
+ $roles = $this->get_roleid_options($instance, $context);
+ $mform->addElement('select', 'roleid', get_string('defaultrole', 'role'), $roles);
+ $mform->setDefault('roleid', $this->get_config('roleid'));
+
+ $options = ['optional' => true, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'enrolperiod', get_string('defaultperiod', 'enrol_manual'), $options);
+ $mform->setDefault('enrolperiod', $this->get_config('enrolperiod'));
+ $mform->addHelpButton('enrolperiod', 'defaultperiod', 'enrol_manual');
+
+ $options = $this->get_expirynotify_options();
+ $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
+ $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
+
+ $options = ['optional' => false, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
+ $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
+ $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
+ }
// Course welcome message.
- $mform->addElement(
- 'select',
- 'customint1',
- get_string(
+ if (has_any_capability(['enrol/manual:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $mform->addElement(
+ 'select',
+ 'customint1',
+ get_string(
+ identifier: 'sendcoursewelcomemessage',
+ component: 'core_enrol',
+ ),
+ enrol_send_welcome_email_options(),
+ );
+ $mform->addHelpButton(
+ elementname: 'customint1',
identifier: 'sendcoursewelcomemessage',
component: 'core_enrol',
- ),
- enrol_send_welcome_email_options(),
- );
- $mform->addHelpButton(
- elementname: 'customint1',
- identifier: 'sendcoursewelcomemessage',
- component: 'core_enrol',
- );
-
- $options = [
- 'cols' => '60',
- 'rows' => '8',
- ];
- $mform->addElement(
- 'textarea',
- 'customtext1',
- get_string(
- identifier: 'customwelcomemessage',
- component: 'core_enrol',
- ),
- $options,
- );
- $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
- $mform->hideIf(
- elementname: 'customtext1',
- dependenton: 'customint1',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
-
- // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
- // See: https://tracker.moodle.org/browse/MDL-66251.
- $group[] = $mform->createElement(
- 'static',
- 'customwelcomemessage_extra_help',
- null,
- get_string(
- identifier: 'customwelcomemessage_help',
- component: 'core_enrol',
- ),
- );
- $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
- $mform->hideIf(
- elementname: 'group_customwelcomemessage_extra_help',
- dependenton: 'customint1',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
+ );
+
+ $options = [
+ 'cols' => '60',
+ 'rows' => '8',
+ ];
+ $mform->addElement(
+ 'textarea',
+ 'customtext1',
+ get_string(
+ identifier: 'customwelcomemessage',
+ component: 'core_enrol',
+ ),
+ $options,
+ );
+ $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
+ $mform->hideIf(
+ elementname: 'customtext1',
+ dependenton: 'customint1',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
+
+ // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
+ // See: https://tracker.moodle.org/browse/MDL-66251.
+ $group[] = $mform->createElement(
+ 'static',
+ 'customwelcomemessage_extra_help',
+ null,
+ get_string(
+ identifier: 'customwelcomemessage_help',
+ component: 'core_enrol',
+ ),
+ );
+ $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
+ $mform->hideIf(
+ elementname: 'group_customwelcomemessage_extra_help',
+ dependenton: 'customint1',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
+ }
- if (enrol_accessing_via_instance($instance)) {
+ // Enrolment changes warning.
+ if (has_capability('enrol/manual:config', $context) && enrol_accessing_via_instance($instance)) {
$warntext = get_string('instanceeditselfwarningtext', 'core_enrol');
$mform->addElement('static', 'selfwarn', get_string('instanceeditselfwarning', 'core_enrol'), $warntext);
}
@@ -681,7 +700,9 @@ public function edit_instance_form($instance, MoodleQuickForm $mform, $context)
public function edit_instance_validation($data, $files, $instance, $context) {
$errors = array();
- if ($data['expirynotify'] > 0 and $data['expirythreshold'] < 86400) {
+ // This method is used when configuring the enrolment method, and when only updating the welcome message.
+ // The 'expirynotify' key won't be set when updating the welcome message.
+ if (isset($data['expirynotify']) && $data['expirynotify'] > 0 && $data['expirythreshold'] < 86400) {
$errors['expirythreshold'] = get_string('errorthresholdlow', 'core_enrol');
}
diff --git a/enrol/manual/tests/behat/welcomemessage.feature b/enrol/manual/tests/behat/welcomemessage.feature
index 17d5377d5c634..6beda6759060d 100644
--- a/enrol/manual/tests/behat/welcomemessage.feature
+++ b/enrol/manual/tests/behat/welcomemessage.feature
@@ -35,6 +35,22 @@ Feature: A course welcome message will be sent to the user when they are enrolle
And I should not see "Custom welcome message"
And I should not see "Accepted formats: Plain text or Moodle-auto format. HTML tags and multi-lang tags are also accepted, as well as the following placeholders:"
+ @javascript
+ Scenario: Teacher can edit the course welcome message
+ Given I am on the "C1" "Enrolled users" page logged in as teacher
+ And I set the field "Participants tertiary navigation" to "Enrolment methods"
+ When I click on "Edit" "link" in the "Manual enrolments" "table_row"
+ Then I should see "Send course welcome message"
+ And I should not see "Enable manual enrolments"
+ And I should not see "Default role"
+ And I should not see "Default enrolment duration"
+ And I should not see "Notify before enrolment expires"
+ And I should not see "Notification threshold"
+ And I set the field "Custom welcome message" to "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+ And I press "Save changes"
+ And I click on "Edit" "link" in the "Manual enrolments" "table_row"
+ And I should see "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+
@javascript
Scenario: Student should not receive a welcome message if the setting is disabled
Given I am on the "C1" "Enrolled users" page logged in as manager
diff --git a/enrol/self/lib.php b/enrol/self/lib.php
index 80ad7d48e2844..3c987aec9a2ab 100644
--- a/enrol/self/lib.php
+++ b/enrol/self/lib.php
@@ -133,6 +133,32 @@ public function can_add_instance($courseid) {
return true;
}
+ /**
+ * Returns edit icons for the page with list of instances.
+ *
+ * @param stdClass $instance
+ * @return array
+ */
+ public function get_action_icons(stdClass $instance): array {
+ global $OUTPUT;
+
+ $context = context_course::instance($instance->courseid);
+
+ $icons = [];
+ if (has_any_capability(['enrol/self:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $linkparams = [
+ 'courseid' => $instance->courseid,
+ 'id' => $instance->id,
+ 'type' => $instance->enrol,
+ ];
+ $editlink = new moodle_url('/enrol/editinstance.php', $linkparams);
+ $icon = new pix_icon('t/edit', get_string('edit'), 'core', ['class' => 'iconsmall']);
+ $icons[] = $OUTPUT->action_icon($editlink, $icon);
+ }
+
+ return $icons;
+ }
+
/**
* Self enrol user to course
*
@@ -828,139 +854,149 @@ public function get_bulk_operations(course_enrolment_manager $manager) {
public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
global $CFG, $DB;
- // Merge these two settings to one value for the single selection element.
- if ($instance->notifyall and $instance->expirynotify) {
- $instance->expirynotify = 2;
- }
- unset($instance->notifyall);
-
- $nameattribs = array('size' => '20', 'maxlength' => '255');
- $mform->addElement('text', 'name', get_string('custominstancename', 'enrol'), $nameattribs);
- $mform->setType('name', PARAM_TEXT);
- $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'server');
-
- $options = $this->get_status_options();
- $mform->addElement('select', 'status', get_string('status', 'enrol_self'), $options);
- $mform->addHelpButton('status', 'status', 'enrol_self');
-
- $options = $this->get_newenrols_options();
- $mform->addElement('select', 'customint6', get_string('newenrols', 'enrol_self'), $options);
- $mform->addHelpButton('customint6', 'newenrols', 'enrol_self');
- $mform->disabledIf('customint6', 'status', 'eq', ENROL_INSTANCE_DISABLED);
-
- $passattribs = array('size' => '20', 'maxlength' => '50');
- $mform->addElement('passwordunmask', 'password', get_string('password', 'enrol_self'), $passattribs);
- $mform->addHelpButton('password', 'password', 'enrol_self');
- if (empty($instance->id) and $this->get_config('requirepassword')) {
- $mform->addRule('password', get_string('required'), 'required', null, 'client');
- }
- $mform->addRule('password', get_string('maximumchars', '', 50), 'maxlength', 50, 'server');
-
- $options = $this->get_groupkey_options();
- $mform->addElement('select', 'customint1', get_string('groupkey', 'enrol_self'), $options);
- $mform->addHelpButton('customint1', 'groupkey', 'enrol_self');
-
- $roles = $this->extend_assignable_roles($context, $instance->roleid);
- $mform->addElement('select', 'roleid', get_string('role', 'enrol_self'), $roles);
-
- $options = array('optional' => true, 'defaultunit' => 86400);
- $mform->addElement('duration', 'enrolperiod', get_string('enrolperiod', 'enrol_self'), $options);
- $mform->addHelpButton('enrolperiod', 'enrolperiod', 'enrol_self');
-
- $options = $this->get_expirynotify_options();
- $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
- $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
-
- $options = array('optional' => false, 'defaultunit' => 86400);
- $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
- $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
- $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
-
- $options = array('optional' => true);
- $mform->addElement('date_time_selector', 'enrolstartdate', get_string('enrolstartdate', 'enrol_self'), $options);
- $mform->setDefault('enrolstartdate', 0);
- $mform->addHelpButton('enrolstartdate', 'enrolstartdate', 'enrol_self');
-
- $options = array('optional' => true);
- $mform->addElement('date_time_selector', 'enrolenddate', get_string('enrolenddate', 'enrol_self'), $options);
- $mform->setDefault('enrolenddate', 0);
- $mform->addHelpButton('enrolenddate', 'enrolenddate', 'enrol_self');
-
- $options = $this->get_longtimenosee_options();
- $mform->addElement('select', 'customint2', get_string('longtimenosee', 'enrol_self'), $options);
- $mform->addHelpButton('customint2', 'longtimenosee', 'enrol_self');
-
- $mform->addElement('text', 'customint3', get_string('maxenrolled', 'enrol_self'));
- $mform->addHelpButton('customint3', 'maxenrolled', 'enrol_self');
- $mform->setType('customint3', PARAM_INT);
-
- require_once($CFG->dirroot.'/cohort/lib.php');
-
- $cohorts = array(0 => get_string('no'));
- $allcohorts = cohort_get_available_cohorts($context, 0, 0, 0);
- if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
- $c = $DB->get_record('cohort',
- array('id' => $instance->customint5),
- 'id, name, idnumber, contextid, visible',
- IGNORE_MISSING);
- if ($c) {
- // Current cohort was not found because current user can not see it. Still keep it.
- $allcohorts[$instance->customint5] = $c;
+ // Main fields.
+ if (has_capability('enrol/self:config', $context)) {
+ // Merge these two settings to one value for the single selection element.
+ if ($instance->notifyall && $instance->expirynotify) {
+ $instance->expirynotify = 2;
}
- }
- foreach ($allcohorts as $c) {
- $cohorts[$c->id] = format_string($c->name, true, array('context' => context::instance_by_id($c->contextid)));
- if ($c->idnumber) {
- $cohorts[$c->id] .= ' ['.s($c->idnumber).']';
+ unset($instance->notifyall);
+
+ $nameattribs = ['size' => '20', 'maxlength' => '255'];
+ $mform->addElement('text', 'name', get_string('custominstancename', 'enrol'), $nameattribs);
+ $mform->setType('name', PARAM_TEXT);
+ $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'server');
+
+ $options = $this->get_status_options();
+ $mform->addElement('select', 'status', get_string('status', 'enrol_self'), $options);
+ $mform->addHelpButton('status', 'status', 'enrol_self');
+
+ $options = $this->get_newenrols_options();
+ $mform->addElement('select', 'customint6', get_string('newenrols', 'enrol_self'), $options);
+ $mform->addHelpButton('customint6', 'newenrols', 'enrol_self');
+ $mform->disabledIf('customint6', 'status', 'eq', ENROL_INSTANCE_DISABLED);
+
+ $passattribs = ['size' => '20', 'maxlength' => '50'];
+ $mform->addElement('passwordunmask', 'password', get_string('password', 'enrol_self'), $passattribs);
+ $mform->addHelpButton('password', 'password', 'enrol_self');
+ if (empty($instance->id) && $this->get_config('requirepassword')) {
+ $mform->addRule('password', get_string('required'), 'required', null, 'client');
+ }
+ $mform->addRule('password', get_string('maximumchars', '', 50), 'maxlength', 50, 'server');
+
+ $options = $this->get_groupkey_options();
+ $mform->addElement('select', 'customint1', get_string('groupkey', 'enrol_self'), $options);
+ $mform->addHelpButton('customint1', 'groupkey', 'enrol_self');
+
+ $roles = $this->extend_assignable_roles($context, $instance->roleid);
+ $mform->addElement('select', 'roleid', get_string('role', 'enrol_self'), $roles);
+
+ $options = ['optional' => true, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'enrolperiod', get_string('enrolperiod', 'enrol_self'), $options);
+ $mform->addHelpButton('enrolperiod', 'enrolperiod', 'enrol_self');
+
+ $options = $this->get_expirynotify_options();
+ $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
+ $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
+
+ $options = ['optional' => false, 'defaultunit' => 86400];
+ $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
+ $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
+ $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
+
+ $options = ['optional' => true];
+ $mform->addElement('date_time_selector', 'enrolstartdate', get_string('enrolstartdate', 'enrol_self'), $options);
+ $mform->setDefault('enrolstartdate', 0);
+ $mform->addHelpButton('enrolstartdate', 'enrolstartdate', 'enrol_self');
+
+ $options = ['optional' => true];
+ $mform->addElement('date_time_selector', 'enrolenddate', get_string('enrolenddate', 'enrol_self'), $options);
+ $mform->setDefault('enrolenddate', 0);
+ $mform->addHelpButton('enrolenddate', 'enrolenddate', 'enrol_self');
+
+ $options = $this->get_longtimenosee_options();
+ $mform->addElement('select', 'customint2', get_string('longtimenosee', 'enrol_self'), $options);
+ $mform->addHelpButton('customint2', 'longtimenosee', 'enrol_self');
+
+ $mform->addElement('text', 'customint3', get_string('maxenrolled', 'enrol_self'));
+ $mform->addHelpButton('customint3', 'maxenrolled', 'enrol_self');
+ $mform->setType('customint3', PARAM_INT);
+
+ require_once($CFG->dirroot.'/cohort/lib.php');
+
+ $cohorts = [0 => get_string('no')];
+ $allcohorts = cohort_get_available_cohorts($context, 0, 0, 0);
+ if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
+ $c = $DB->get_record('cohort',
+ ['id' => $instance->customint5],
+ 'id, name, idnumber, contextid, visible',
+ IGNORE_MISSING);
+ if ($c) {
+ // Current cohort was not found because current user can not see it. Still keep it.
+ $allcohorts[$instance->customint5] = $c;
+ }
+ }
+ foreach ($allcohorts as $c) {
+ $cohorts[$c->id] = format_string($c->name, true, ['context' => context::instance_by_id($c->contextid)]);
+ if ($c->idnumber) {
+ $cohorts[$c->id] .= ' ['.s($c->idnumber).']';
+ }
+ }
+ if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
+ // Somebody deleted a cohort, better keep the wrong value so that random ppl can not enrol.
+ $cohorts[$instance->customint5] = get_string('unknowncohort', 'cohort', $instance->customint5);
+ }
+ if (count($cohorts) > 1) {
+ $mform->addElement('select', 'customint5', get_string('cohortonly', 'enrol_self'), $cohorts);
+ $mform->addHelpButton('customint5', 'cohortonly', 'enrol_self');
+ } else {
+ $mform->addElement('hidden', 'customint5');
+ $mform->setType('customint5', PARAM_INT);
+ $mform->setConstant('customint5', 0);
}
- }
- if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
- // Somebody deleted a cohort, better keep the wrong value so that random ppl can not enrol.
- $cohorts[$instance->customint5] = get_string('unknowncohort', 'cohort', $instance->customint5);
- }
- if (count($cohorts) > 1) {
- $mform->addElement('select', 'customint5', get_string('cohortonly', 'enrol_self'), $cohorts);
- $mform->addHelpButton('customint5', 'cohortonly', 'enrol_self');
- } else {
- $mform->addElement('hidden', 'customint5');
- $mform->setType('customint5', PARAM_INT);
- $mform->setConstant('customint5', 0);
}
- $mform->addElement('select', 'customint4', get_string('sendcoursewelcomemessage', 'enrol_self'),
- enrol_send_welcome_email_options());
- $mform->addHelpButton('customint4', 'sendcoursewelcomemessage', 'enrol_self');
-
- $options = array('cols' => '60', 'rows' => '8');
- $mform->addElement('textarea', 'customtext1', get_string('customwelcomemessage', 'core_enrol'), $options);
- $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
- $mform->hideIf(
- elementname: 'customtext1',
- dependenton: 'customint4',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
+ // Course welcome message.
+ if (has_any_capability(['enrol/self:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+ $mform->addElement('select', 'customint4', get_string('sendcoursewelcomemessage', 'enrol_self'),
+ enrol_send_welcome_email_options());
+ $mform->addHelpButton('customint4', 'sendcoursewelcomemessage', 'enrol_self');
+
+ $options = [
+ 'cols' => '60',
+ 'rows' => '8',
+ ];
+ $mform->addElement('textarea', 'customtext1', get_string('customwelcomemessage', 'core_enrol'), $options);
+ $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
+ $mform->hideIf(
+ elementname: 'customtext1',
+ dependenton: 'customint4',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
- // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
- // See: https://tracker.moodle.org/browse/MDL-66251.
- $group[] = $mform->createElement(
- 'static',
- 'customwelcomemessage_extra_help',
- null,
- get_string(
- identifier: 'customwelcomemessage_help',
- component: 'core_enrol',
- ),
- );
- $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
- $mform->hideIf(
- elementname: 'group_customwelcomemessage_extra_help',
- dependenton: 'customint4',
- condition: 'eq',
- value: ENROL_DO_NOT_SEND_EMAIL,
- );
+ // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
+ // See: https://tracker.moodle.org/browse/MDL-66251.
+ $group[] = $mform->createElement(
+ 'static',
+ 'customwelcomemessage_extra_help',
+ null,
+ get_string(
+ identifier: 'customwelcomemessage_help',
+ component: 'core_enrol',
+ ),
+ );
+ $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
+ $mform->hideIf(
+ elementname: 'group_customwelcomemessage_extra_help',
+ dependenton: 'customint4',
+ condition: 'eq',
+ value: ENROL_DO_NOT_SEND_EMAIL,
+ );
+ }
- if (enrol_accessing_via_instance($instance)) {
+ // Enrolment changes warning.
+ if (has_capability('enrol/self:config', $context) && enrol_accessing_via_instance($instance)) {
$warntext = get_string('instanceeditselfwarningtext', 'core_enrol');
$mform->addElement('static', 'selfwarn', get_string('instanceeditselfwarning', 'core_enrol'), $warntext);
}
diff --git a/enrol/self/tests/behat/welcomemessage.feature b/enrol/self/tests/behat/welcomemessage.feature
index 3cc8e7df22fea..adf2e9f561239 100644
--- a/enrol/self/tests/behat/welcomemessage.feature
+++ b/enrol/self/tests/behat/welcomemessage.feature
@@ -40,6 +40,17 @@ Feature: A course welcome message will be sent to the user when they auto-enrol
And I should not see "Custom welcome message"
And I should not see "Accepted formats: Plain text or Moodle-auto format. HTML tags and multi-lang tags are also accepted, as well as the following placeholders:"
+ @javascript
+ Scenario: Teacher can edit the course welcome message
+ Given I am on the "C1" "Enrolled users" page logged in as teacher
+ And I set the field "Participants tertiary navigation" to "Enrolment methods"
+ When I click on "Edit" "link" in the "Self enrolment" "table_row"
+ Then I should see "Send course welcome message"
+ And I set the field "Custom welcome message" to "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+ And I press "Save changes"
+ And I click on "Edit" "link" in the "Self enrolment" "table_row"
+ And I should see "Hello {$a->fullname}, welcome to the course {$a->coursename}"
+
@javascript
Scenario: Student should not receive a welcome message if the setting is disabled
Given I am on the "C1" "Enrolled users" page logged in as manager
diff --git a/enrol/tests/enrollib_test.php b/enrol/tests/enrollib_test.php
index b19530f672626..654d4fe1e4be6 100644
--- a/enrol/tests/enrollib_test.php
+++ b/enrol/tests/enrollib_test.php
@@ -1739,7 +1739,7 @@ public function test_enrol_selfenrol_available(): void {
/**
* Test the behaviour of validate_enrol_plugin_data().
*
- * @covers ::validate_enrol_plugin_data
+ * @covers \enrol_plugin::validate_enrol_plugin_data
*/
public function test_validate_enrol_plugin_data(): void {
$this->resetAfterTest();
@@ -1761,7 +1761,7 @@ public function test_validate_enrol_plugin_data(): void {
/**
* Test the behaviour of update_enrol_plugin_data().
*
- * @covers ::update_enrol_plugin_data
+ * @covers \enrol_plugin::update_enrol_plugin_data
*/
public function test_update_enrol_plugin_data(): void {
global $DB;
diff --git a/files/classes/reportbuilder/local/entities/file.php b/files/classes/reportbuilder/local/entities/file.php
index 489fe73ef291e..ea6fd5a5eb72d 100644
--- a/files/classes/reportbuilder/local/entities/file.php
+++ b/files/classes/reportbuilder/local/entities/file.php
@@ -425,6 +425,26 @@ protected function get_all_filters(): array {
))
->add_joins($this->get_joins());
+ // Component.
+ $filters[] = (new filter(
+ text::class,
+ 'component',
+ new lang_string('plugin'),
+ $this->get_entity_name(),
+ "{$filesalias}.component"
+ ))
+ ->add_joins($this->get_joins());
+
+ // Area.
+ $filters[] = (new filter(
+ text::class,
+ 'area',
+ new lang_string('pluginarea'),
+ $this->get_entity_name(),
+ "{$filesalias}.filearea"
+ ))
+ ->add_joins($this->get_joins());
+
// Time created.
$filters[] = (new filter(
date::class,
diff --git a/files/tests/reportbuilder/datasource/files_test.php b/files/tests/reportbuilder/datasource/files_test.php
index 246817fff8509..8bc26ac8a3b8a 100644
--- a/files/tests/reportbuilder/datasource/files_test.php
+++ b/files/tests/reportbuilder/datasource/files_test.php
@@ -36,7 +36,7 @@
* @copyright 2022 Paul Holden
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class files_test extends core_reportbuilder_testcase {
+final class files_test extends core_reportbuilder_testcase {
/**
* Test default datasource
@@ -205,7 +205,7 @@ public function test_datasource_non_default_columns(): void {
*
* @return array[]
*/
- public function datasource_filters_provider(): array {
+ public static function datasource_filters_provider(): array {
return [
// File.
'Filter directory' => ['file:directory', [
@@ -247,6 +247,22 @@ public function datasource_filters_provider(): array {
'file:contenthash_operator' => text::IS_EQUAL_TO,
'file:contenthash_value' => 'f00f',
], 0],
+ 'Filter component' => ['file:component', [
+ 'file:component_operator' => text::IS_EQUAL_TO,
+ 'file:component_value' => 'course',
+ ], 2],
+ 'Filter component (no match)' => ['file:component', [
+ 'file:component_operator' => text::IS_EQUAL_TO,
+ 'file:component_value' => 'reportbuilder',
+ ], 0],
+ 'Filter area' => ['file:area', [
+ 'file:area_operator' => text::IS_EQUAL_TO,
+ 'file:area_value' => 'summary',
+ ], 2],
+ 'Filter area (no match)' => ['file:area', [
+ 'file:area_operator' => text::IS_EQUAL_TO,
+ 'file:area_value' => 'report',
+ ], 0],
'Filter time created' => ['file:timecreated', [
'file:timecreated_operator' => date::DATE_RANGE,
'file:timecreated_from' => 1622502000,
diff --git a/grade/grading/form/guide/tests/behat/assign_marking_guide.feature b/grade/grading/form/guide/tests/behat/assign_marking_guide.feature
index 9336cd303b878..ef8ffce9789d8 100644
--- a/grade/grading/form/guide/tests/behat/assign_marking_guide.feature
+++ b/grade/grading/form/guide/tests/behat/assign_marking_guide.feature
@@ -88,7 +88,7 @@ Feature: Display marking guide information to students
And I should not see "Grade Critera 2"
And I am on the "Course 1" "grades > Grader report > View" page
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | 90 |
And I am on the "Assign 1" "assign activity editing" page
And I set the following fields to these values:
diff --git a/grade/grading/form/guide/tests/behat/delete_marking_guide.feature b/grade/grading/form/guide/tests/behat/delete_marking_guide.feature
index 06abc20e352fb..4bbc83d886ab1 100644
--- a/grade/grading/form/guide/tests/behat/delete_marking_guide.feature
+++ b/grade/grading/form/guide/tests/behat/delete_marking_guide.feature
@@ -49,5 +49,5 @@ Feature: Teacher can delete marking guide
And I should not see "Criterion 1"
And I am on the "Course 1" "grades > Grader report > View" page
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student One | student1@example.com | 70 |
diff --git a/grade/grading/form/rubric/tests/behat/edit_rubric.feature b/grade/grading/form/rubric/tests/behat/edit_rubric.feature
index 2c5dc28981824..612bfd534b12d 100644
--- a/grade/grading/form/rubric/tests/behat/edit_rubric.feature
+++ b/grade/grading/form/rubric/tests/behat/edit_rubric.feature
@@ -50,7 +50,9 @@ Feature: Rubrics can be created and edited
Then I should see "Ready for use"
# Grading two students.
And I navigate to "Assignment" in current page administration
+ And I change window size to "large"
And I go to "Student 1" "Test assignment 1 name" activity advanced grading page
+ And I change window size to "medium"
And I grade by filling the rubric with:
| Criterion 1 | 50 | Very good |
And I press "Save changes"
@@ -66,7 +68,9 @@ Feature: Rubrics can be created and edited
And I should see "65" in the "Student 1" "table_row"
# Updating the user grade.
And I am on the "Test assignment 1 name" "assign activity" page
+ And I change window size to "large"
And I go to "Student 1" "Test assignment 1 name" activity advanced grading page
+ And I change window size to "medium"
And I grade by filling the rubric with:
| Criterion 1 | 20 | Bad, I changed my mind |
| Criterion 2 | 10 | Mmmm, you can do it better |
@@ -118,7 +122,9 @@ Feature: Rubrics can be created and edited
And I log out
# Regrade student.
And I am on the "Test assignment 1 name" "assign activity" page logged in as teacher1
+ And I change window size to "large"
And I go to "Student 1" "Test assignment 1 name" activity advanced grading page
+ And I change window size to "medium"
And I should see "The rubric definition was changed after this student had been graded. The student can not see this rubric until you check the rubric and update the grade."
And I save the advanced grading form
And I log out
diff --git a/grade/report/grader/UPGRADING.md b/grade/report/grader/UPGRADING.md
index dd347b7501d5e..e3ff2487d963d 100644
--- a/grade/report/grader/UPGRADING.md
+++ b/grade/report/grader/UPGRADING.md
@@ -7,4 +7,3 @@
- The `gradereport_grader/group` ESM has been deprecated. Please use `core_course/actionbar/group` instead.
For more information see [MDL-80745](https://tracker.moodle.org/browse/MDL-80745)
-
diff --git a/grade/report/grader/tests/behat/switch_views.feature b/grade/report/grader/tests/behat/switch_views.feature
index 8560e94ac0f2d..d493e43a746d5 100644
--- a/grade/report/grader/tests/behat/switch_views.feature
+++ b/grade/report/grader/tests/behat/switch_views.feature
@@ -48,7 +48,7 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- | -6- |
+ | -1- | -2- | -3- | -4- | -5- | -6- |
| Student 1 | student1@example.com | 80 | 90 | 30 | 170 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
And I choose "Show totals only" in the open action menu
@@ -57,7 +57,7 @@ Feature: We can change what we are viewing on the grader report
And I should not see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | 170 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
And I click on "Show grades only" "link"
@@ -66,7 +66,7 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should not see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | 80 | 90 | 30 |
@javascript @skip_chrome_zerosize
@@ -83,7 +83,7 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- | -6- |
+ | -1- | -2- | -3- | -4- | -5- | -6- |
| Student 1 | student1@example.com | 80 | - | 30 | 105.71 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
And I choose "Show totals only" in the open action menu
@@ -92,7 +92,7 @@ Feature: We can change what we are viewing on the grader report
And I should not see "Manual grade"
And I should see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | 105.71 |
And I click on grade item menu "Course 1" of type "course" on "grader" page
When I click on "Show grades only" "link"
@@ -101,5 +101,5 @@ Feature: We can change what we are viewing on the grader report
And I should see "Manual grade"
And I should not see "Course total"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | 80 | - | 30 |
diff --git a/grade/report/grader/tests/behat/tertiary_name_filter.feature b/grade/report/grader/tests/behat/tertiary_name_filter.feature
index ae82f47d565b6..f962bf861eb3b 100644
--- a/grade/report/grader/tests/behat/tertiary_name_filter.feature
+++ b/grade/report/grader/tests/behat/tertiary_name_filter.feature
@@ -156,10 +156,10 @@ Feature: Within the grader report, test that we can open our generic filter drop
When I press "Apply"
And the field "Search users" matches value "Student 1"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Teacher 1 | teacher1@example.com | - |
| Dummy User | student2@example.com | - |
| User Example | student3@example.com | - |
@@ -169,7 +169,7 @@ Feature: Within the grader report, test that we can open our generic filter drop
And I select "M" in the "First name" "core_grades > initials bar"
And I press "Apply"
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
| Teacher 1 | teacher1@example.com | - |
| Dummy User | student2@example.com | - |
@@ -181,12 +181,12 @@ Feature: Within the grader report, test that we can open our generic filter drop
Given I set the field "Search users" to "User"
And I click on "View all results (3)" "option_role"
And the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| User Example | student3@example.com | - |
| User Test | student4@example.com | - |
| Dummy User | student2@example.com | - |
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
| Teacher 1 | teacher1@example.com | - |
| Turtle Manatee | student5@example.com | - |
@@ -194,10 +194,10 @@ Feature: Within the grader report, test that we can open our generic filter drop
And I select "E" in the "Last name" "core_grades > initials bar"
And I press "Apply"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| User Example | student3@example.com | - |
And the following should not exist in the "user-grades" table:
- | -1- | -1- | -3- |
+ | -1- | -2- | -3- |
| Student 1 | student1@example.com | - |
| Teacher 1 | teacher1@example.com | - |
| Dummy User | student2@example.com | - |
diff --git a/grade/report/grader/tests/behat/tertiary_navigation_searching.feature b/grade/report/grader/tests/behat/tertiary_navigation_searching.feature
index b9319b3f7dea9..3f787e7a89c2b 100644
--- a/grade/report/grader/tests/behat/tertiary_navigation_searching.feature
+++ b/grade/report/grader/tests/behat/tertiary_navigation_searching.feature
@@ -274,6 +274,8 @@ Feature: Within the grader report, test that we can search for users
And I press the up key
And I press the enter key
And I wait to be redirected
+ # Sometimes with behat we get unattached nodes causing spurious failures.
+ And I wait "1" seconds
And the following should exist in the "user-grades" table:
| -1- |
| Dummy User |
@@ -284,6 +286,13 @@ Feature: Within the grader report, test that we can search for users
| Teacher 1 |
| Student 1 |
| Turtle Manatee |
+ And I set the field "Search users" to "ABC"
+ And I wait until "Turtle Manatee" "option_role" exists
+ And I press the tab key
+ And the focused element is "Clear search input" "button"
+ And I press the enter key
+ And I wait until the page is ready
+ And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist
Scenario: Once a teacher searches, it'll apply the currently set filters and inform the teacher as such
# Set up a basic filtering case.
diff --git a/grade/report/history/tests/behat/basic_functionality.feature b/grade/report/history/tests/behat/basic_functionality.feature
index 0889b4e176b43..8e2ca357014fa 100644
--- a/grade/report/history/tests/behat/basic_functionality.feature
+++ b/grade/report/history/tests/behat/basic_functionality.feature
@@ -51,7 +51,7 @@ Feature: A teacher checks the grade history report in a course
And I navigate to "View > Grade history" in the course gradebook
When I press "Submit"
Then the following should exist in the "gradereport_history" table:
- | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
+ | First name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
| Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 |
| Student 1 | student1@example.com | apple | Rewarding assignment | | 60.00 | Teacher 1 |
| Student 2 | student2@example.com | orange | The greatest assignment ever | | 50.00 | Teacher 1 |
@@ -79,7 +79,7 @@ Feature: A teacher checks the grade history report in a course
And I press "Finish selecting users"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Grade item | Original grade | Revised grade | Grader |
+ | First name | Grade item | Original grade | Revised grade | Grader |
| Student 1 | The greatest assignment ever | | 50.00 | Teacher 1 |
| Student 1 | Rewarding assignment | | 60.00 | Teacher 1 |
| Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 |
@@ -96,7 +96,7 @@ Feature: A teacher checks the grade history report in a course
And I set the field "Grade item" to "The greatest assignment ever"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Grade item | Original grade | Revised grade | Grader |
+ | First name | Grade item | Original grade | Revised grade | Grader |
| Student 1 | The greatest assignment ever | | 50.00 | Teacher 1 |
| Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 |
And the following should not exist in the "gradereport_history" table:
@@ -106,7 +106,7 @@ Feature: A teacher checks the grade history report in a course
And I set the field "Grader" to "Teacher 1"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
+ | First name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
| Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 |
And the following should not exist in the "gradereport_history" table:
| Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 |
@@ -114,5 +114,5 @@ Feature: A teacher checks the grade history report in a course
And I click on "id_revisedonly" "checkbox"
And I press "Submit"
And the following should exist in the "gradereport_history" table:
- | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
+ | First name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader |
| Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 |
diff --git a/grade/report/singleview/UPGRADING.md b/grade/report/singleview/UPGRADING.md
index 6a803b14c835e..81a92440a906a 100644
--- a/grade/report/singleview/UPGRADING.md
+++ b/grade/report/singleview/UPGRADING.md
@@ -7,4 +7,3 @@
- The `gradereport_singleview/group` ESM has been deprecated. Please use `core_course/actionbar/group` instead.
For more information see [MDL-80745](https://tracker.moodle.org/browse/MDL-80745)
-
diff --git a/grade/report/singleview/tests/behat/singleview.feature b/grade/report/singleview/tests/behat/singleview.feature
index 1cb9f29b24c01..5475a4204fb5c 100644
--- a/grade/report/singleview/tests/behat/singleview.feature
+++ b/grade/report/singleview/tests/behat/singleview.feature
@@ -93,7 +93,7 @@ Feature: We can use Single view
And I press "Save"
Then I should see "Grades were set for 1 items"
And the following should exist in the "generaltable" table:
- | First name (Alternate name) Last name | Grade |
+ | User full name | Grade |
| Ann, Jill, Grainne, Beauchamp | Very good |
And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher2"
And I click on "Users" "link" in the ".page-toggler" "css_element"
diff --git a/grade/report/user/UPGRADING.md b/grade/report/user/UPGRADING.md
index f51b1c6f5807a..8b6be52ad1456 100644
--- a/grade/report/user/UPGRADING.md
+++ b/grade/report/user/UPGRADING.md
@@ -7,4 +7,3 @@
- The `gradereport_user/group` ESM has been deprecated. Please use `core_course/actionbar/group` instead.
For more information see [MDL-80745](https://tracker.moodle.org/browse/MDL-80745)
-
diff --git a/grade/tests/behat/grade_import.feature b/grade/tests/behat/grade_import.feature
index 2aa019a20781d..3025e85b5078d 100644
--- a/grade/tests/behat/grade_import.feature
+++ b/grade/tests/behat/grade_import.feature
@@ -61,7 +61,7 @@ Feature: An admin can import grades into gradebook using a CSV file
And I should see "Grade import success"
And I click on "Continue" "button"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- |
+ | -1- | -2- | -3- | -4- |
| Student 1 | student1@example.com | 400.00 | 400.00 |
| Student 2 | student2@example.com | 50.00 | 50.00 |
| Student 3 | student3@example.com | 50.00 | 50.00 |
@@ -82,7 +82,7 @@ Feature: An admin can import grades into gradebook using a CSV file
And I should see "Grade import success"
And I click on "Continue" "button"
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- | -6- | -7- | -8- |
+ | -1- | -2- | -3- | -4- | -5- | -6- | -7- | -8- |
| Student 1 | student1@example.com | 50.00 | 11.00 | 12.00 | 13.00 | 14.00 | 100.00 |
| Student 2 | student2@example.com | 50.00 | 21.00 | 22.00 | 23.00 | 24.00 | 140.00 |
| Student 3 | student3@example.com | 50.00 | 31.00 | 32.00 | 33.00 | 34.00 | 180.00 |
diff --git a/grade/tests/behat/grade_letter_boundary.feature b/grade/tests/behat/grade_letter_boundary.feature
index 2cf197229302a..7265ffbbe49c8 100644
--- a/grade/tests/behat/grade_letter_boundary.feature
+++ b/grade/tests/behat/grade_letter_boundary.feature
@@ -37,5 +37,5 @@ Feature: We can customise the letter boundary of a course.
And I am on "Course 1" course homepage with editing mode off
And I navigate to "View > Grader report" in the course gradebook
Then the following should exist in the "user-grades" table:
- | -1- | -1- |-3- | -4- |
+ | -1- | -2- |-3- | -4- |
| Student 1 | student1@example.com | D | D |
diff --git a/grade/tests/behat/grade_letter_boundary_20160518.feature b/grade/tests/behat/grade_letter_boundary_20160518.feature
index 9c6636e983733..a984da8d62b4d 100644
--- a/grade/tests/behat/grade_letter_boundary_20160518.feature
+++ b/grade/tests/behat/grade_letter_boundary_20160518.feature
@@ -38,5 +38,5 @@ Feature: We can customise the letter boundary of a course in gradebook version 2
And I am on "Course 1" course homepage with editing mode off
And I navigate to "View > Grader report" in the course gradebook
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- |
+ | -1- | -2- | -3- | -4- |
| Student 1 | student1@example.com | F | F |
diff --git a/grade/tests/behat/grade_regrade_do_not_override.feature b/grade/tests/behat/grade_regrade_do_not_override.feature
index d20e68ed24c96..0dd89994422b9 100644
--- a/grade/tests/behat/grade_regrade_do_not_override.feature
+++ b/grade/tests/behat/grade_regrade_do_not_override.feature
@@ -32,8 +32,8 @@ Feature: Regrading grades does not unnecessarily mark some as overriden
And I press "Save changes"
And I am on the "Course 1" "grades > Grader report > View" page
And the following should exist in the "gradereport-grader-table" table:
- | | | |
- | First name / Last name | Assignment 1 | Course total |
+ | -1- | -3- | -4- |
+ | First name | Assignment 1 | Course total |
| Student 1 | 80.00 | 80.00 |
| Student 2 | 60.00 | 60.00 |
And I turn editing mode on
@@ -64,7 +64,7 @@ Feature: Regrading grades does not unnecessarily mark some as overriden
When I am on the "Course 1" "grades > Grader report > View" page
And I turn editing mode off
Then the following should exist in the "gradereport-grader-table" table:
- | | | |
- | First name / Last name | Assignment 1 | Course total |
+ | -1- | -3- | -4- |
+ | First name | Assignment 1 | Course total |
| Student 1 | 90.00 | 180.00 |
| Student 2 | 70.00 | 160.00 |
diff --git a/grade/tests/behat/grade_scales.feature b/grade/tests/behat/grade_scales.feature
index 64d126751981b..fee7dd54f357a 100644
--- a/grade/tests/behat/grade_scales.feature
+++ b/grade/tests/behat/grade_scales.feature
@@ -73,7 +73,7 @@ Feature: View gradebook when scales are used
Scenario: Test displaying scales in gradebook in aggregation method Natural
When I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | A | 5.00 | 5.00 |
| Student 2 | student2@example.com | B | 4.00 | 4.00 |
| Student 3 | student3@example.com | C | 3.00 | 3.00 |
@@ -116,7 +116,7 @@ Feature: View gradebook when scales are used
| Minimum grade | 1 |
And I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | A | 5.00 | |
| Student 2 | student2@example.com | B | 4.00 | |
| Student 3 | student3@example.com | C | 3.00 | |
diff --git a/grade/tests/behat/grade_single_item_scales.feature b/grade/tests/behat/grade_single_item_scales.feature
index 18889649ce487..16024ed456d80 100644
--- a/grade/tests/behat/grade_single_item_scales.feature
+++ b/grade/tests/behat/grade_single_item_scales.feature
@@ -58,7 +58,7 @@ Feature: View gradebook when single item scales are used
Scenario: Test displaying single item scales in gradebook in aggregation method Natural
When I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | Ace! | 1.00 | 1.00 |
And the following should exist in the "user-grades" table:
| -1- | -2- | -3- | -4- |
@@ -92,7 +92,7 @@ Feature: View gradebook when single item scales are used
| Category name | Sub category () |
And I turn editing mode off
Then the following should exist in the "user-grades" table:
- | -1- | -1- | -3- | -4- | -5- |
+ | -1- | -2- | -3- | -4- | -5- |
| Student 1 | student1@example.com | Ace! | | |
| Student 2 | student2@example.com | - | - | - |
And the following should exist in the "user-grades" table:
diff --git a/grade/tests/behat/toggle_grade_categories.feature b/grade/tests/behat/toggle_grade_categories.feature
index 3eed4f6f0f3df..0e2e47445f0f1 100644
--- a/grade/tests/behat/toggle_grade_categories.feature
+++ b/grade/tests/behat/toggle_grade_categories.feature
@@ -78,14 +78,12 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course |
And I should see "Course" in the "setup-grades" "table"
And "Expand" "link" should exist in the "Course" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment one |
- | Category 1 |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
- | Course total |
+ And I should not see "Test assignment one" in the "setup-grades" "table"
+ And I should not see "Category 1" in the "setup-grades" "table"
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
+ And I should not see "Course total" in the "setup-grades" "table"
# Expand the grade category 'Course'. 'Category 1' should be still collapsed.
And I click on "Expand" "link" in the "Course" "table_row"
And the following should exist in the "setup-grades" table:
@@ -96,11 +94,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course total |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: A teacher can see the aggregated max grade for a grade category even when the category is collapsed
Given the following should exist in the "setup-grades" table:
@@ -150,11 +146,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Category 1 |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
# Expand the grade category 'Category 1'.
And I click on "Expand" "link" in the "Category 1" "table_row"
And the following should exist in the "setup-grades" table:
@@ -172,12 +166,10 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
And I click on "Collapse" "link" in the "Course" "table_row"
And I should see "Course" in the "setup-grades" "table"
And "Expand" "link" should exist in the "Course" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment one |
- | Category 1 |
- | Test assignment two |
- | Manual grade |
+ And I should not see "Test assignment one" in the "setup-grades" "table"
+ And I should not see "Category 1" in the "setup-grades" "table"
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
# Expand the grade category 'Course'. 'Category 1' should be still collapsed.
And I click on "Expand" "link" in the "Course" "table_row"
And the following should exist in the "setup-grades" table:
@@ -187,11 +179,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Category 1 |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: Previously collapsed categories are still shown as collapsed when a teacher navigates back to Gradebook setup
# Collapse the grade category 'Category 1' and navigate to the course homepage.
@@ -206,11 +196,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course total |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: Previously collapsed categories are still shown as collapsed when a teacher is moving grade items in Gradebook setup
# Collapse the grade category 'Category 1'.
@@ -224,11 +212,9 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Category 1 |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
Scenario: Grade categories are shown as collapsed only to the teacher that collapsed them
# Collapse the grade category 'Category 1'.
@@ -256,8 +242,6 @@ Feature: Teachers can toggle the visibility of the grade categories in the Grade
| Course total |
And "Collapse" "link" should exist in the "Course" "table_row"
And "Expand" "link" should exist in the "Category 1" "table_row"
- And the following should not exist in the "setup-grades" table:
- | Name |
- | Test assignment two |
- | Manual grade |
- | Category 1 total |
+ And I should not see "Test assignment two" in the "setup-grades" "table"
+ And I should not see "Manual grade" in the "setup-grades" "table"
+ And I should not see "Category 1 total" in the "setup-grades" "table"
diff --git a/grade/tests/external/get_feedback_test.php b/grade/tests/external/get_feedback_test.php
index 9c90734ab686f..66c0fb064ce95 100644
--- a/grade/tests/external/get_feedback_test.php
+++ b/grade/tests/external/get_feedback_test.php
@@ -30,13 +30,13 @@
* @copyright 2023 Kevin Percy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 4.2
+ * @covers \core_grades\external\get_feedback
*/
class get_feedback_test extends \externallib_advanced_testcase {
/**
* Test get_feedback.
*
- * @covers ::get_feedback
* @dataProvider get_feedback_provider
* @param string|null $feedback The feedback text added for the grade item.
* @param array $expected The expected feedback data.
@@ -103,7 +103,6 @@ public function get_feedback_provider(): array {
/**
* Test get_feedback with invalid requests.
*
- * @covers ::get_feedback
* @dataProvider get_feedback_invalid_request_provider
* @param string $loggeduserrole The role of the logged user.
* @param bool $feedbacknotincourse Whether to request a feedback for a grade item which is not a part of the course.
diff --git a/grade/tests/external/get_grade_tree_test.php b/grade/tests/external/get_grade_tree_test.php
index 8f6c4df747310..50501a928e03a 100644
--- a/grade/tests/external/get_grade_tree_test.php
+++ b/grade/tests/external/get_grade_tree_test.php
@@ -37,7 +37,6 @@ class get_grade_tree_test extends \externallib_advanced_testcase {
/**
* Test the return value of the external function.
*
- * @covers ::execute
* @return void
*/
public function test_execute(): void {
diff --git a/group/tests/behat/private_groups.feature b/group/tests/behat/private_groups.feature
index 87f9db427f1ac..3d8b665523946 100644
--- a/group/tests/behat/private_groups.feature
+++ b/group/tests/behat/private_groups.feature
@@ -56,7 +56,7 @@ Feature: Private groups
Scenario: Participants in "Visible" groups see their membership and other members:
Given I am on the "C1" "enrolled users" page logged in as "student1"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 3 | No groups |
@@ -69,7 +69,7 @@ Feature: Private groups
Scenario: Participants in "Only visible to members" groups see their membership and other members, plus "Visible"
Given I am on the "C1" "enrolled users" page logged in as "student2"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | Only visible to members/Non-Participation, Only visible to members/Participation |
| Student 3 | No groups |
@@ -82,7 +82,7 @@ Feature: Private groups
Scenario: Participants in "Only see own membership" groups see their membership but not other members, plus "Visible"
Given I am on the "C1" "enrolled users" page logged in as "student3"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 3 | Only see own membership |
@@ -95,7 +95,7 @@ Feature: Private groups
Scenario: Participants in "Not visible" groups do not see that group, do see "Visible"
Given I am on the "C1" "enrolled users" page logged in as "student4"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 3 | No groups |
@@ -108,7 +108,7 @@ Feature: Private groups
Scenario: View participants list as a teacher:
Given I am on the "C1" "enrolled users" page logged in as "teacher1"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | Only visible to members/Non-Participation, Only visible to members/Participation |
| Student 3 | Only see own membership |
@@ -125,10 +125,10 @@ Feature: Private groups
And I set the field "Type or select..." to "Only see own membership"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 3 | Only see own membership |
And the following should not exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 7 | No groups |
@javascript
@@ -138,7 +138,7 @@ Feature: Private groups
And I set the field "Type or select..." to "No group"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 2 | No groups |
| Student 4 | No groups |
| Student 6 | No groups |
@@ -153,7 +153,7 @@ Feature: Private groups
And I set the field "Type or select..." to "Only see own membership"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 2 | No groups |
| Student 4 | No groups |
@@ -170,7 +170,7 @@ Feature: Private groups
And I set the field "Type or select..." to "No group"
And I click on "Apply filters" "button"
Then the following should exist in the "participants" table:
- | First name / Surname | Groups |
+ | First name | Groups |
| Student 1 | Visible/Non-Participation, Visible/Participation |
| Student 3 | Only see own membership |
| Student 5 | Visible/Non-Participation, Visible/Participation |
diff --git a/group/tests/lib_test.php b/group/tests/lib_test.php
index 0fc33bae68825..ad6ad471a8cb4 100644
--- a/group/tests/lib_test.php
+++ b/group/tests/lib_test.php
@@ -883,7 +883,7 @@ public function test_groups_get_members_by_role(): void {
/**
* Tests set_groups_messaging
*
- * @covers \core_group::set_groups_messaging
+ * @covers ::set_groups_messaging
*/
public function test_set_groups_messaging(): void {
$this->resetAfterTest();
@@ -923,7 +923,7 @@ public function test_set_groups_messaging(): void {
/**
* Tests set group messaging where it doesn't exist
*
- * @covers \core_group::set_groups_messaging
+ * @covers ::set_groups_messaging
*/
public function test_set_groups_messaging_doesnt_exist(): void {
$this->resetAfterTest();
diff --git a/h5p/tests/file_storage_test.php b/h5p/tests/file_storage_test.php
index 065f0e516c220..23605719cd91b 100644
--- a/h5p/tests/file_storage_test.php
+++ b/h5p/tests/file_storage_test.php
@@ -33,6 +33,7 @@
* @copyright 2019 Victor Deniz
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @runTestsInSeparateProcesses
+ * @covers \core_h5p\file_storage
*/
class file_storage_test extends \advanced_testcase {
@@ -847,8 +848,6 @@ public function test_removeContentFile(): void {
/**
* Test H5P custom styles generation.
- *
- * @covers ::generate_custom_styles
*/
public function test_generate_custom_styles(): void {
\set_config('h5pcustomcss', '.debug { color: #fab; }', 'core_h5p');
@@ -895,8 +894,6 @@ public function test_generate_custom_styles(): void {
/**
* Test H5P custom styles retrieval.
- *
- * @covers ::get_custom_styles
*/
public function test_get_custom_styles(): void {
global $CFG;
diff --git a/h5p/tests/framework_test.php b/h5p/tests/framework_test.php
index b0b7aaaebfcaa..3200f8c985ea7 100644
--- a/h5p/tests/framework_test.php
+++ b/h5p/tests/framework_test.php
@@ -1099,8 +1099,6 @@ public function test_updateContent(): void {
/**
* Test the behaviour of updateContent() with metadata.
- *
- * @covers ::updateContent
*/
public function test_updateContent_withmetadata(): void {
global $DB;
diff --git a/h5p/tests/helper_test.php b/h5p/tests/helper_test.php
index d1aef73a0d399..afc2bf3cd9606 100644
--- a/h5p/tests/helper_test.php
+++ b/h5p/tests/helper_test.php
@@ -205,7 +205,6 @@ public function test_save_h5p_existing_libraries(): void {
* Test the behaviour of save_h5p() when the H5P file contains metadata.
*
* @runInSeparateProcess
- * @covers ::save_h5p
*/
public function test_save_h5p_metadata(): void {
global $DB;
diff --git a/install/lang/de_kids/langconfig.php b/install/lang/de_kids/langconfig.php
index 32a2d5992ec34..7b5842a1696f0 100644
--- a/install/lang/de_kids/langconfig.php
+++ b/install/lang/de_kids/langconfig.php
@@ -31,4 +31,4 @@
$string['parentlanguage'] = 'de_du';
$string['thisdirection'] = 'ltr';
-$string['thislanguage'] = 'Deutsch (kids)';
+$string['thislanguage'] = 'Deutsch';
diff --git a/install/lang/el_kids/langconfig.php b/install/lang/el_kids/langconfig.php
index 00def5ad34895..644ca01059a55 100644
--- a/install/lang/el_kids/langconfig.php
+++ b/install/lang/el_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'el';
-$string['thislanguage'] = 'Ελληνικά για παιδιά';
+$string['thislanguage'] = 'Ελληνικά';
diff --git a/install/lang/en_kids/langconfig.php b/install/lang/en_kids/langconfig.php
index 64bfc834f0fc5..5016ecaeff711 100644
--- a/install/lang/en_kids/langconfig.php
+++ b/install/lang/en_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'en';
-$string['thislanguage'] = 'English (kids)';
+$string['thislanguage'] = 'English';
diff --git a/install/lang/es_mx_kids/langconfig.php b/install/lang/es_mx_kids/langconfig.php
index 662a0b2075e3f..77f53f4229e24 100644
--- a/install/lang/es_mx_kids/langconfig.php
+++ b/install/lang/es_mx_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'es_mx';
-$string['thislanguage'] = 'Español - México para niños';
+$string['thislanguage'] = 'Español - México';
diff --git a/install/lang/ja_kids/langconfig.php b/install/lang/ja_kids/langconfig.php
index 6cc9bce34805b..13d08143fd076 100644
--- a/install/lang/ja_kids/langconfig.php
+++ b/install/lang/ja_kids/langconfig.php
@@ -31,4 +31,4 @@
$string['parentlanguage'] = 'ja';
$string['thisdirection'] = 'ltr';
-$string['thislanguage'] = 'Japanese (kids)';
+$string['thislanguage'] = 'Japanese';
diff --git a/install/lang/pt_br_kids/langconfig.php b/install/lang/pt_br_kids/langconfig.php
index 5151effc71e86..cc172aea0ca5d 100644
--- a/install/lang/pt_br_kids/langconfig.php
+++ b/install/lang/pt_br_kids/langconfig.php
@@ -30,4 +30,4 @@
defined('MOODLE_INTERNAL') || die();
$string['parentlanguage'] = 'pt_br';
-$string['thislanguage'] = 'Português Brasil para Crianças';
+$string['thislanguage'] = 'Português Brasil';
diff --git a/lang/en/admin.php b/lang/en/admin.php
index 664b9790dc73b..be392c748380c 100644
--- a/lang/en/admin.php
+++ b/lang/en/admin.php
@@ -286,7 +286,7 @@
$string['configfullnamedisplay'] = 'This defines how names are shown when they are displayed in full. The default value, "language", leaves it to the string "fullnamedisplay" in the current language pack to decide. Some languages have different name display conventions.
For most mono-lingual sites the most efficient setting is "firstname lastname", but you may choose to hide last names altogether. Placeholders that can be used are: firstname, lastname, firstnamephonetic, lastnamephonetic, middlename, and alternatename.';
-$string['configgeoipfile'] = 'Location of GeoLite2 City binary data file. This file is not part of Moodle distribution and must be obtained separately from MaxMind. You can either buy a commercial version or use the free version. You\'ll need to register to download the City database file, which you can do at https://dev.maxmind.com/geoip/geoip2/geolite2/. Once you\'ve registered and downloaded the file, extract it into "{$a}" directory on your server.';
+$string['configgeoipfile'] = 'Location of GeoIP City binary data file. This file is not part of Moodle distribution and must be obtained separately from MaxMind. You can either buy a commercial version or use the free version. You\'ll need to register to download the City database file, which you can do at https://dev.maxmind.com/geoip/geoip2/geolite2/. Once you\'ve registered and downloaded the file, extract it into "{$a}" directory on your server.';
$string['configgetremoteaddrconf'] = 'If your server is behind a reverse proxy, you can use this setting to specify which HTTP headers can be trusted to contain the remote IP address. The headers are read in order, using the first one that is available.';
$string['configgradebookroles'] = 'This setting allows you to control who appears on the gradebook. Users need to have at least one of these roles in a course to be shown in the gradebook for that course.';
$string['configgradeexport'] = 'Choose which gradebook export formats are your primary methods for exporting grades. Chosen plugins will then set and use a "last exported" field for every grade. For example, this might result in exported records being identified as being "new" or "updated". If you are not sure about this then leave everything unchecked.';
@@ -690,7 +690,13 @@
$string['fullnamedisplayprivate'] = 'Full name format - private';
$string['gdrequired'] = 'The GD extension is now required by Moodle for image conversion.';
$string['generalsettings'] = 'General settings';
-$string['geoipfile'] = 'GeoLite2 City MaxMind DB';
+$string['geoipdbedition'] = 'GeoIP Database Edition';
+$string['geoipdbedition_desc'] = 'Select the edition of the GeoIP database to download. Please be aware that using the GeoIP2-City database requires a valid paid license.';
+$string['geoipfile'] = 'GeoIP City DB';
+$string['geoipmaxmindaccid'] = 'MaxMind account ID';
+$string['geoipmaxmindaccid_desc'] = 'The account ID of the account created on the MaxMind API service.';
+$string['geoipmaxmindlicensekey'] = 'MaxMind license key';
+$string['geoipmaxmindlicensekey_desc'] = 'The license key of the account created on the MaxMind API service.';
$string['getremoteaddrconf'] = 'Logged IP address source';
$string['globalsearch'] = 'Global search';
$string['globalsearchmanage'] = 'Manage global search';
@@ -775,10 +781,10 @@
$string['ipblocker'] = 'IP blocker';
$string['ipblockersyntax'] = 'Put every entry on one line. Valid entries are either full IP address (such as 192.168.10.1) which matches a single host; or partial address (such as 192.168) which matches any address starting with those numbers; or CIDR notation (such as 231.54.211.0/20); or a range of IP addresses (such as 231.3.56.10-20) where the range applies to the last part of the address. Text domain names (like \'example.com\') are not supported. Blank lines, and text following a "#" character are ignored.';
$string['iplookup'] = 'IP address lookup';
-$string['iplookupgeoplugin'] = 'The geoPlugin service is currently being used to look up geographical information. For more accurate results we recommend installing a local copy of the MaxMind GeoLite database.';
-$string['iplookupinfo'] = 'The free online NetGeo server is used to look up IP address locations. The database is not maintained any more though, and may return incorrect data. Installing a local copy of the free GeoLite2 City database from MaxMind is recommended.
+$string['iplookupgeoplugin'] = 'The geoPlugin service is currently being used to look up geographical information. For more accurate results we recommend installing a local copy of the MaxMind GeoIP City database.'; +$string['iplookupinfo'] = 'The free online NetGeo server is used to look up IP address locations. The database is not maintained any more though, and may return incorrect data. Installing a local copy of a GeoIP database from MaxMind is recommended.
If a Google Maps API V3 key is provided, IP address location is displayed using Google Maps. You need a Google account and to apply for a Google Maps API key. If no Google Maps API V3 key is provided, IP address location is displayed using OpenStreetMap.'; -$string['iplookupmaxmindnote'] = 'This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.'; +$string['iplookupmaxmindnote'] = 'This product includes GeoIP City data created by MaxMind, available from https://www.maxmind.com.'; $string['iscustomadminwarnings'] = 'It has been detected that your site is using a custom admin directory. This feature is no longer supported and will be removed after Moodle 4.2.'; $string['ishttpswarning'] = 'It has been detected that your site is not secured using HTTPS. It is strongly recommended to migrate your site to HTTPS for increased security and improved integration with other systems.'; $string['keeptagnamecase'] = 'Keep tag name casing'; @@ -1436,6 +1442,7 @@ $string['taskstatscron'] = 'Background processing for statistics'; $string['tasktagcron'] = 'Background processing for tags'; $string['tasktempfilecleanup'] = 'Delete stale temp files'; +$string['taskupdategeoip2file'] = 'Update GeoIP file'; $string['tempdatafoldercleanup'] = 'Clean up temporary data files older than'; $string['templates'] = 'Templates'; $string['testoutgoingmailconf'] = 'Test outgoing mail configuration'; diff --git a/lang/en/backup.php b/lang/en/backup.php index 9fa54d69ea646..8a9002a0488af 100644 --- a/lang/en/backup.php +++ b/lang/en/backup.php @@ -198,6 +198,7 @@ $string['enterasearch'] = 'Enter a search'; $string['error_block_for_module_not_found'] = 'Orphan block instance (id: {$a->bid}) for course module (id: {$a->mid}) found. This block will not be backed up'; $string['error_course_module_not_found'] = 'Orphan course module (id: {$a}) found. This module will not be backed up.'; +$string['error_delegate_section_not_found'] = 'Missing delegate section form course module (id: {$a}. The section will not be backed up.'; $string['errorcopyingbackupfile'] = "Failed to copy the backup file to the temporary folder before restoring."; $string['errorfilenamerequired'] = 'You must enter a valid filename for this backup'; $string['errorfilenametoolong'] = 'The filename must be less than 255 characters in length.'; @@ -416,6 +417,7 @@ $string['skipmodifprev'] = 'Skip courses not modified since previous backup'; $string['skipmodifprevhelp'] = 'Choose whether to skip courses that have not been modified since the last automatic backup. This requires logging to be enabled.'; $string['status'] = 'Status'; +$string['subsectioncontent'] = 'Subsection content'; $string['successful'] = 'Backup successful'; $string['successfulcopy'] = 'Copy successful'; $string['successfulrestore'] = 'Restore successful'; diff --git a/lang/en/calendar.php b/lang/en/calendar.php index f922d5d46d90d..694efe548bf09 100644 --- a/lang/en/calendar.php +++ b/lang/en/calendar.php @@ -168,7 +168,6 @@ $string['hideeventtype'] = 'Hide {$a} events'; $string['showeventtype'] = 'Show {$a} events'; $string['hourly'] = 'Hourly'; -$string['importcalendarexternal'] = 'Import an external calendar?'; $string['importcalendar'] = 'Import calendar'; $string['importcalendarheading'] = 'Import calendar...'; $string['importcalendarfrom'] = 'Import from'; @@ -193,9 +192,9 @@ $string['never'] = 'Never'; $string['newevent'] = 'New event'; $string['newmonthannouncement'] = 'Calendar is now set to {$a}.'; +$string['nocalendarsubscriptionsimportexternal'] = 'No calendar subscriptions yet. Import an external calendar'; $string['notitle'] = 'no title'; $string['noupcomingevents'] = 'There are no upcoming events'; -$string['nocalendarsubscriptions'] = 'No calendar subscriptions yet. Do you want to {$a}'; $string['oneevent'] = '1 event'; $string['pollinterval'] = 'Update interval'; $string['pollinterval_help'] = 'How often you would like the calendar to update with new events.'; @@ -287,3 +286,7 @@ // Deprecated since Moodle 4.4. $string['coursecalendar'] = '{$a} calendar'; + +// Deprecated since Moodle 4.5. +$string['importcalendarexternal'] = 'Import an external calendar?'; +$string['nocalendarsubscriptions'] = 'No calendar subscriptions yet. Do you want to {$a}'; diff --git a/lang/en/cohort.php b/lang/en/cohort.php index b913521a1c03a..93c94e0f20536 100644 --- a/lang/en/cohort.php +++ b/lang/en/cohort.php @@ -47,6 +47,7 @@ $string['currentusersmatching'] = 'Current users matching'; $string['defaultcontext'] = 'Default context'; $string['delcohort'] = 'Delete cohort'; +$string['delcohortsconfirm'] = 'Do you really want to delete the selected cohorts?'; $string['delconfirm'] = 'Do you really want to delete cohort \'{$a}\'?'; $string['description'] = 'Description'; $string['displayedrows'] = '{$a->displayed} rows displayed out of {$a->total}.'; diff --git a/lang/en/deprecated.txt b/lang/en/deprecated.txt index 31c9828e288d2..b934616128dbf 100644 --- a/lang/en/deprecated.txt +++ b/lang/en/deprecated.txt @@ -113,4 +113,6 @@ coursesearch_help,core blocknotexist,core_debug modulenotexist,core_debug coursecalendar,core_calendar +importcalendarexternal,core_calendar +nocalendarsubscriptions,core_calendar datechanged,core diff --git a/lang/en/error.php b/lang/en/error.php index 09764f33a61d3..9de16f6fe16f9 100644 --- a/lang/en/error.php +++ b/lang/en/error.php @@ -96,7 +96,7 @@ $string['cannotfindlang'] = 'Cannot find "{$a}" language pack!'; $string['cannotfindteacher'] = 'Cannot find teacher'; $string['cannotfinduser'] = 'Cannot find user named "{$a}"'; -$string['cannotgeoplugin'] = 'Cannot connect to the geoPlugin server at https://www.geoplugin.com. Please check your proxy settings or install the MaxMind GeoLite City data file.'; +$string['cannotgeoplugin'] = 'Cannot connect to the geoPlugin server at https://www.geoplugin.com. Please check your proxy settings or install the MaxMind GeoIP City data file.'; $string['cannotgetblock'] = 'Could not retrieve blocks from the database'; $string['cannotgetcats'] = 'Cannot get category record'; $string['cannotgetdata'] = 'Cannot get data'; diff --git a/lang/en/moodle.php b/lang/en/moodle.php index 13d916783acee..9a27682c6c309 100644 --- a/lang/en/moodle.php +++ b/lang/en/moodle.php @@ -1863,7 +1863,12 @@ $string['reset'] = 'Reset'; $string['resetcomponent'] = 'Component'; $string['resetcourse'] = 'Reset course'; -$string['resetinfo'] = 'Delete all user data and reset this course to its original state, keeping activities and settings intact.'; +$string['resetcourseconfirm'] = 'Reset course?'; +$string['resetcoursewarning'] = 'Are you sure you want to reset the course \'{$a}\'? +
+This will delete the selected data and reset the course back to its original state. You can\'t undo this action.'; +$string['resetinfo'] = 'This feature allows you to clear all user data and reset the course to its original state. Course activities and settings will remain untouched.'; +$string['resetinfoselect'] = 'Select the data you want to delete or reset from the categories below:'; $string['resetnotimplemented'] = 'Reset not supported'; $string['resetnotimplementedinfo'] = 'These activities can\'t be reset:'; $string['resetrecordexpired'] = 'The password reset link you used is more than {$a} minutes old and has expired. Please initiate a new password reset.'; diff --git a/lang/en/report.php b/lang/en/report.php new file mode 100644 index 0000000000000..a2f9672ab1f3c --- /dev/null +++ b/lang/en/report.php @@ -0,0 +1,26 @@ +. + +/** + * Strings for component 'report', language 'en' + * + * @package core_report + * @copyright 2024 Amaia Anabitarte
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['privacy:metadata'] = 'The Report system does not store any personal data.';
+
diff --git a/lang/en/role.php b/lang/en/role.php
index 97fa84054228c..915f240d8c371 100644
--- a/lang/en/role.php
+++ b/lang/en/role.php
@@ -180,6 +180,7 @@
$string['course:configurecustomfields'] = 'Configure course custom fields';
$string['course:configuredownloadcontent'] = 'Configure download course content';
$string['course:downloadcoursecontent'] = 'Download course content';
+$string['course:editcoursewelcomemessage'] = 'Edit course welcome message';
$string['course:enrolconfig'] = 'Configure enrol instances in courses';
$string['course:enrolreview'] = 'Review course enrolments';
$string['course:setforcedlanguage'] = 'Force course or activity language';
diff --git a/lib/UPGRADING.md b/lib/UPGRADING.md
index 457c1804d8958..60793c39bdd3b 100644
--- a/lib/UPGRADING.md
+++ b/lib/UPGRADING.md
@@ -17,6 +17,9 @@
- Final deprecation of print_error(). Use moodle_exception instead.
For more information see [MDL-74484](https://tracker.moodle.org/browse/MDL-74484)
+- Final deprecation of \core\task\manager::ensure_adhoc_task_qos()
+
+ For more information see [MDL-74843](https://tracker.moodle.org/browse/MDL-74843)
### Changed
@@ -54,6 +57,89 @@
- `\webservice_parameter_exception`
For more information see [MDL-81919](https://tracker.moodle.org/browse/MDL-81919)
+- The following classes have been moved into the `\core` namespace and now support autoloading:
+ - `emoticon_manager`
+ - `lang_string`
+
+ For more information see [MDL-81920](https://tracker.moodle.org/browse/MDL-81920)
+- The following classes have been renamed and now support autoloading. Existing classes are currently unaffected.
+ | Old class name | New class name |
+ | --- | --- |
+ | `\moodle_url` | `\core\url` |
+ | `\progress_trace` | `\core\output\progress_trace` |
+ | `\combined_progress_trace` | `\core\output\progress_trace\combined_progress_trace` |
+ | `\error_log_progress_trace` | `\core\output\progress_trace\error_log_progress_trace` |
+ | `\html_list_progress_trace` | `\core\output\progress_trace\html_list_progress_trace` |
+ | `\html_progress_trace` | `\core\output\progress_trace\html_progress_trace` |
+ | `\null_progress_trace` | `\core\output\progress_trace\null_progress_trace` |
+ | `\progress_trace_buffer` | `\core\output\progress_trace\progress_trace_buffer` |
+ | `\text_progress_trace` | `\core\output\progress_trace\text_progress_trace` |
+
+ For more information see [MDL-81960](https://tracker.moodle.org/browse/MDL-81960)
+- The following classes are now also available in the following new locations. They will continue to work in their old locations:
+ | Old classname | New classname |
+ | --- | --- |
+ | `\action_link` | `\core\output\action_link` |
+ | `\action_menu_filler` | `\core\output\action_menu\filler` |
+ | `\action_menu_link_primary` | `\core\output\action_menu\link_primary` |
+ | `\action_menu_link_secondary` | `\core\output\action_menu\link_secondary` |
+ | `\action_menu_link` | `\core\output\action_menu\link` |
+ | `\action_menu` | `\core\output\action_menu` |
+ | `\block_contents` | `\core_block\output\block_contents` |
+ | `\block_move_target` | `\core_block\output\block_move_target` |
+ | `\component_action` | `\core\output\actions\component_action` |
+ | `\confirm_action` | `\core\output\actions\confirm_action` |
+ | `\context_header` | `\core\output\context_header` |
+ | `\core\output\local\action_menu\subpanel` | `\core\output\action_menu\subpanel` |
+ | `\core_renderer_ajax` | `\core\output\core_renderer_ajax` |
+ | `\core_renderer_cli` | `\core\output\core_renderer_cli` |
+ | `\core_renderer_maintenance` | `\core\output\core_renderer_maintenance` |
+ | `\core_renderer` | `\core\output\core_renderer` |
+ | `\custom_menu_item` | `\core\output\custom_menu_item` |
+ | `\custom_menu` | `\core\output\custom_menu` |
+ | `\file_picker` | `\core\output\file_picker` |
+ | `\flexible_table` | `\core_table\flexible_table` |
+ | `\fragment_requirements_manager` | `\core\output\requirements\fragment_requirements_manager` |
+ | `\help_icon` | `\core\output\help_icon` |
+ | `\html_table_cell` | `\core_table\output\html_table_cell` |
+ | `\html_table_row` | `\core_table\output\html_table_row` |
+ | `\html_table` | `\core_table\output\html_table` |
+ | `\html_writer` | `\core\output\html_writer` |
+ | `\image_icon` | `\core\output\image_icon` |
+ | `\initials_bar` | `\core\output\initials_bar` |
+ | `\js_writer` | `\core\output\js_writer` |
+ | `\page_requirements_manager` | `\core\output\requirements\page_requirements_manager` |
+ | `\paging_bar` | `\core\output\paging_bar` |
+ | `\pix_emoticon` | `\core\output\pix_emoticon` |
+ | `\pix_icon_font` | `\core\output\pix_icon_font` |
+ | `\pix_icon_fontawesome` | `\core\output\pix_icon_fontawesome` |
+ | `\pix_icon` | `\core\output\pix_icon` |
+ | `\plugin_renderer_base` | `\core\output\plugin_renderer_base` |
+ | `\popup_action` | `\core\output\actions\popup_action` |
+ | `\preferences_group` | `\core\output\preferences_group` |
+ | `\preferences_groups` | `\core\output\preferences_groups` |
+ | `\progress_bar` | `\core\output\progress_bar` |
+ | `\renderable` | `\core\output\renderable` |
+ | `\renderer_base` | `\core\output\renderer_base` |
+ | `\renderer_factory_base` | `\core\output\renderer_factory\renderer_factory_base` |
+ | `\renderer_factory` | `\core\output\renderer_factory\renderer_factory_interface` |
+ | `\single_button` | `\core\output\single_button` |
+ | `\single_select` | `\core\output\single_select` |
+ | `\standard_renderer_factory` | `\core\output\renderer_factory\standard_renderer_factory` |
+ | `\table_dataformat_export_format` | `\core_table\dataformat_export_format` |
+ | `\table_default_export_format_parent` | `\core_table\base_export_format` |
+ | `\table_sql` | `\core_table\sql_table` |
+ | `\tabobject` | `\core\output\tabobject` |
+ | `\tabtree` | `\core\output\tabtree` |
+ | `\templatable` | `\core\output\templatable` |
+ | `\theme_config` | `\core\output\theme_config` |
+ | `\theme_overridden_renderer_factory` | `\core\output\renderer_factory\theme_overridden_renderer_factory` |
+ | `\url_select` | `\core\output\url_select` |
+ | `\user_picture` | `\core\output\user_picture` |
+ | `\xhtml_container_stack` | `\core\output\xhtml_container_stack` |
+ | `\YUI_config` | `\core\output\requirements\yui` |
+
+ For more information see [MDL-82183](https://tracker.moodle.org/browse/MDL-82183)
### Fixed
diff --git a/lib/amd/build/local/reactive/debugpanel.min.js b/lib/amd/build/local/reactive/debugpanel.min.js
index 82de966570bc1..d6f23b882a6b2 100644
--- a/lib/amd/build/local/reactive/debugpanel.min.js
+++ b/lib/amd/build/local/reactive/debugpanel.min.js
@@ -9,6 +9,6 @@ define("core/local/reactive/debugpanel",["exports","core/reactive","core/log","c
* @module core/local/reactive/debugpanel
* @copyright 2021 Ferran Recio
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.initsubpanel=_exports.init=void 0,_log=(obj=_log)&&obj.__esModule?obj:{default:obj};_exports.init=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new GlobalDebugPanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};_exports.initsubpanel=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new DebugInstanceSubpanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};class GlobalDebugPanel extends _reactive.BaseComponent{create(){this.name="GlobalDebugPanel",this.selectors={LOADERS:"[data-for='loaders']",SUBPANEL:"[data-for='subpanel']",NOINSTANCES:"[data-for='noinstances']",LOG:"[data-for='log']"},this.classes={HIDE:"d-none"},this.subPanels=new Set}stateReady(state){this._updateReactivesPanels({state:state}),this.getElement(this.selectors.SUBPANEL).innerHTML=""}getWatchers(){return[{watch:"reactives:created",handler:this._updateReactivesPanels}]}_updateReactivesPanels(_ref){var _this$getElement,_this$getElement$clas;let{state:state}=_ref;null===(_this$getElement=this.getElement(this.selectors.NOINSTANCES))||void 0===_this$getElement||null===(_this$getElement$clas=_this$getElement.classList)||void 0===_this$getElement$clas||_this$getElement$clas.toggle(this.classes.HIDE,state.reactives.size>0),state.reactives.forEach((instance=>{this._createLoader(instance)}))}_createLoader(instance){if(this.subPanels.has(instance.id))return;this.subPanels.add(instance.id);const loaders=this.getElement(this.selectors.LOADERS),btn=document.createElement("button");btn.innerHTML=instance.id,btn.dataset.id=instance.id,loaders.appendChild(btn),this.addEventListener(btn,"click",(()=>this._openPanel(btn,instance)))}async _openPanel(btn,instance){try{const target=this.getElement(this.selectors.SUBPANEL),data={...instance};await this.renderComponent(target,"core/local/reactive/debuginstancepanel",data)}catch(error){throw _log.default.error("Cannot load reactive debug subpanel"),error}}}class DebugInstanceSubpanel extends _reactive.BaseComponent{create(){this.name="DebugInstanceSubpanel",this.selectors={NAME:"[data-for='name']",CLOSE:"[data-for='close']",READMODE:"[data-for='readmode']",HIGHLIGHT:"[data-for='highlight']",LOG:"[data-for='log']",STATE:"[data-for='state']",CLEAN:"[data-for='clean']",PIN:"[data-for='pin']",SAVE:"[data-for='save']",INVALID:"[data-for='invalid']"},this.id=this.element.dataset.id,this.controller=M.reactive[this.id],this.draggable=!1,this.relativeDrag=!0,this.strings={savewarning:""}}stateReady(){var _this$getElement$inne,_this$getElement2;this.dragdrop=new _reactive.DragDrop(this),this.addEventListener(this.getElement(this.selectors.CLOSE),"click",this.remove),this.controller.highlight&&this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT)),this.addEventListener(this.getElement(this.selectors.HIGHLIGHT),"click",(()=>{this.controller.highlight=!this.controller.highlight,this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT))})),this.addEventListener(this.getElement(this.selectors.READMODE),"click",this._toggleEditMode),this.addEventListener(this.getElement(this.selectors.CLEAN),"click",this._cleanAreas),this.addEventListener(this.getElement(this.selectors.PIN),"click",this._togglePin),this.getElement(this.selectors.SAVE).disabled=!0,this.addEventListener(this.getElement(this.selectors.STATE),"keyup",(0,_utils.debounce)(this._checkJSON,500)),this.addEventListener(this.getElement(this.selectors.SAVE),"click",this._saveState),this.strings.savewarning=null!==(_this$getElement$inne=null===(_this$getElement2=this.getElement(this.selectors.INVALID))||void 0===_this$getElement2?void 0:_this$getElement2.innerHTML)&&void 0!==_this$getElement$inne?_this$getElement$inne:"",this._refreshState()}destroy(){void 0!==this.dragdrop&&this.dragdrop.unregister()}getWatchers(){return[{watch:"reactives[".concat(this.id,"].lastChanges:updated"),handler:this._refreshLog},{watch:"reactives[".concat(this.id,"].modified:updated"),handler:this._refreshState},{watch:"reactives[".concat(this.id,"].readOnly:updated"),handler:this._refreshReadOnly}]}_refreshLog(_ref2){var _element$lastChanges;let{element:element}=_ref2;const logContent=(null!==(_element$lastChanges=null==element?void 0:element.lastChanges)&&void 0!==_element$lastChanges?_element$lastChanges:[]).join("\n"),target=this.getElement(this.selectors.LOG);target.value+="\n\n= Transaction =\n ".concat(logContent),target.scrollTop=target.scrollHeight}_cleanAreas(){this.getElement(this.selectors.LOG).value="",this._refreshState()}_refreshState(){this.getElement(this.selectors.STATE).value=JSON.stringify(this.controller.state,null,4)}_refreshReadOnly(){const target=this.getElement(this.selectors.READMODE);void 0===target.dataset.readonly&&(target.dataset.readonly=target.innerHTML),this.controller.readOnly?target.innerHTML=target.dataset.readonly:target.innerHTML=target.dataset.alt}_toggleEditMode(){this.controller.readOnly=!this.controller.readOnly}_checkJSON(){const invalid=this.getElement(this.selectors.INVALID),save=this.getElement(this.selectors.SAVE),edited=this.getElement(this.selectors.STATE).value,currentStateData=this.controller.stateData;if(edited==JSON.stringify(this.controller.state,null,4))return invalid.style.color="",invalid.innerHTML="",void(save.disabled=!0);try{const newState=JSON.parse(edited),result=this._generateStateUpdates(currentStateData,newState);return invalid.style.color="",invalid.innerHTML=this.strings.savewarning,save.disabled=!1,result}catch(error){var _error$message;return invalid.style.color="red",invalid.innerHTML=null!==(_error$message=error.message)&&void 0!==_error$message?_error$message:"Invalid JSON sctructure",void(save.disabled=!0)}}_saveState(){const updates=this._checkJSON();updates&&this.controller.processUpdates(updates)}_generateStateUpdates(currentStateData,newStateData){const updates=[],ids={};for(const[key,newValue]of Object.entries(newStateData))Array.isArray(newValue)?(ids[key]={},newValue.forEach((element=>{if(void 0===element.id)throw Error("Array ".concat(key," element without id attribute"));updates.push({name:key,action:"override",fields:element});const index=String(element.id).valueOf();ids[key][index]=!0}))):updates.push({name:key,action:"override",fields:newValue});for(const[key,oldValue]of Object.entries(currentStateData)){let deleteField=!1;if(void 0===newStateData[key]&&(deleteField=!0),Array.isArray(oldValue)){if(!deleteField&&void 0===ids[key])throw Error("Array ".concat(key," cannot change to object."));oldValue.forEach((element=>{const index=String(element.id).valueOf();let deleteEntry=deleteField;deleteEntry||void 0!==ids[key][index]||(deleteEntry=!0),deleteEntry&&updates.push({name:key,action:"delete",fields:element})}))}else{if(!deleteField&&void 0!==ids[key])throw Error("Object ".concat(key," cannot change to array."));deleteField&&updates.push({name:key,action:"delete",fields:oldValue})}}return updates}getDraggableData(){return this.draggable}dragEnd(dropdata,event){this.element.style.top="".concat(event.newFixedTop,"px"),this.element.style.left="".concat(event.newFixedLeft,"px")}_togglePin(){this.draggable=!this.draggable,this.dragdrop.setDraggable(this.draggable),this.draggable?this._unpin():this._pin()}_unpin(){const pageCenterY=window.innerHeight/2,pageCenterX=window.innerWidth/2,style={position:"fixed",resize:"both",overflow:"auto",height:"400px",width:"400px",top:"".concat(pageCenterY-200,"px"),left:"".concat(pageCenterX-200,"px")};Object.assign(this.element.style,style),this.getElement(this.selectors.STATE).style.height="50px",this.getElement(this.selectors.LOG).style.height="50px",this._toggleButtonText(this.getElement(this.selectors.PIN))}_pin(){["position","resize","overflow","top","left","height","width"].forEach((prop=>this.element.style.removeProperty(prop))),this._toggleButtonText(this.getElement(this.selectors.PIN))}_toggleButtonText(element){[element.innerHTML,element.dataset.alt]=[element.dataset.alt,element.innerHTML]}}}));
+ */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.initsubpanel=_exports.init=void 0,_log=(obj=_log)&&obj.__esModule?obj:{default:obj};_exports.init=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new GlobalDebugPanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};_exports.initsubpanel=(target,selectors)=>{const element=document.getElementById(target);void 0!==_reactive.debug?new DebugInstanceSubpanel({element:element,reactive:_reactive.debug,selectors:selectors}):element.remove()};class GlobalDebugPanel extends _reactive.BaseComponent{create(){this.name="GlobalDebugPanel",this.selectors={LOADERS:"[data-for='loaders']",SUBPANEL:"[data-for='subpanel']",NOINSTANCES:"[data-for='noinstances']",LOG:"[data-for='log']"},this.classes={HIDE:"d-none"},this.subPanels=new Set}stateReady(state){this._updateReactivesPanels({state:state}),this.getElement(this.selectors.SUBPANEL).innerHTML=""}getWatchers(){return[{watch:"reactives:created",handler:this._updateReactivesPanels}]}_updateReactivesPanels(_ref){var _this$getElement,_this$getElement$clas;let{state:state}=_ref;null===(_this$getElement=this.getElement(this.selectors.NOINSTANCES))||void 0===_this$getElement||null===(_this$getElement$clas=_this$getElement.classList)||void 0===_this$getElement$clas||_this$getElement$clas.toggle(this.classes.HIDE,state.reactives.size>0),state.reactives.forEach((instance=>{this._createLoader(instance)}))}_createLoader(instance){if(this.subPanels.has(instance.id))return;this.subPanels.add(instance.id);const loaders=this.getElement(this.selectors.LOADERS),btn=document.createElement("button");btn.innerHTML=instance.id,btn.dataset.id=instance.id,loaders.appendChild(btn),this.addEventListener(btn,"click",(()=>this._openPanel(btn,instance)))}async _openPanel(btn,instance){try{const target=this.getElement(this.selectors.SUBPANEL),data={...instance};await this.renderComponent(target,"core/local/reactive/debuginstancepanel",data)}catch(error){throw _log.default.error("Cannot load reactive debug subpanel"),error}}}class DebugInstanceSubpanel extends _reactive.BaseComponent{create(){this.name="DebugInstanceSubpanel",this.selectors={NAME:"[data-for='name']",CLOSE:"[data-for='close']",READMODE:"[data-for='readmode']",HIGHLIGHT:"[data-for='highlight']",LOG:"[data-for='log']",STATE:"[data-for='state']",CLEAN:"[data-for='clean']",PIN:"[data-for='pin']",SAVE:"[data-for='save']",INVALID:"[data-for='invalid']"},this.id=this.element.dataset.id,this.controller=M.reactive[this.id],this.draggable=!1,this.relativeDrag=!0,this.strings={savewarning:""}}stateReady(){var _this$getElement$inne,_this$getElement2;this.dragdrop=new _reactive.DragDrop(this),this.addEventListener(this.getElement(this.selectors.CLOSE),"click",this.remove),this.controller.highlight&&this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT)),this.addEventListener(this.getElement(this.selectors.HIGHLIGHT),"click",(()=>{this.controller.highlight=!this.controller.highlight,this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT))})),this.addEventListener(this.getElement(this.selectors.READMODE),"click",this._toggleEditMode),this.addEventListener(this.getElement(this.selectors.CLEAN),"click",this._cleanAreas),this.addEventListener(this.getElement(this.selectors.PIN),"click",this._togglePin),this.getElement(this.selectors.SAVE).disabled=!0,this.addEventListener(this.getElement(this.selectors.STATE),"keyup",(0,_utils.debounce)(this._checkJSON.bind(this),500)),this.addEventListener(this.getElement(this.selectors.SAVE),"click",this._saveState),this.strings.savewarning=null!==(_this$getElement$inne=null===(_this$getElement2=this.getElement(this.selectors.INVALID))||void 0===_this$getElement2?void 0:_this$getElement2.innerHTML)&&void 0!==_this$getElement$inne?_this$getElement$inne:"",this._refreshState()}destroy(){void 0!==this.dragdrop&&this.dragdrop.unregister()}getWatchers(){return[{watch:"reactives[".concat(this.id,"].lastChanges:updated"),handler:this._refreshLog},{watch:"reactives[".concat(this.id,"].modified:updated"),handler:this._refreshState},{watch:"reactives[".concat(this.id,"].readOnly:updated"),handler:this._refreshReadOnly}]}_refreshLog(_ref2){var _element$lastChanges;let{element:element}=_ref2;const logContent=(null!==(_element$lastChanges=null==element?void 0:element.lastChanges)&&void 0!==_element$lastChanges?_element$lastChanges:[]).join("\n"),target=this.getElement(this.selectors.LOG);target.value+="\n\n= Transaction =\n ".concat(logContent),target.scrollTop=target.scrollHeight}_cleanAreas(){this.getElement(this.selectors.LOG).value="",this._refreshState()}_refreshState(){this.getElement(this.selectors.STATE).value=JSON.stringify(this.controller.state,null,4)}_refreshReadOnly(){const target=this.getElement(this.selectors.READMODE);void 0===target.dataset.readonly&&(target.dataset.readonly=target.innerHTML),this.controller.readOnly?target.innerHTML=target.dataset.readonly:target.innerHTML=target.dataset.alt}_toggleEditMode(){this.controller.readOnly=!this.controller.readOnly}_checkJSON(){const invalid=this.getElement(this.selectors.INVALID),save=this.getElement(this.selectors.SAVE),edited=this.getElement(this.selectors.STATE).value,currentStateData=this.controller.stateData;if(edited==JSON.stringify(this.controller.state,null,4))return invalid.style.color="",invalid.innerHTML="",void(save.disabled=!0);try{const newState=JSON.parse(edited),result=this._generateStateUpdates(currentStateData,newState);return invalid.style.color="",invalid.innerHTML=this.strings.savewarning,save.disabled=!1,result}catch(error){var _error$message;return invalid.style.color="red",invalid.innerHTML=null!==(_error$message=error.message)&&void 0!==_error$message?_error$message:"Invalid JSON sctructure",void(save.disabled=!0)}}_saveState(){const updates=this._checkJSON();updates&&this.controller.processUpdates(updates)}_generateStateUpdates(currentStateData,newStateData){const updates=[],ids={};for(const[key,newValue]of Object.entries(newStateData))Array.isArray(newValue)?(ids[key]={},newValue.forEach((element=>{if(void 0===element.id)throw Error("Array ".concat(key," element without id attribute"));updates.push({name:key,action:"override",fields:element});const index=String(element.id).valueOf();ids[key][index]=!0}))):updates.push({name:key,action:"override",fields:newValue});for(const[key,oldValue]of Object.entries(currentStateData)){let deleteField=!1;if(void 0===newStateData[key]&&(deleteField=!0),Array.isArray(oldValue)){if(!deleteField&&void 0===ids[key])throw Error("Array ".concat(key," cannot change to object."));oldValue.forEach((element=>{const index=String(element.id).valueOf();let deleteEntry=deleteField;deleteEntry||void 0!==ids[key][index]||(deleteEntry=!0),deleteEntry&&updates.push({name:key,action:"delete",fields:element})}))}else{if(!deleteField&&void 0!==ids[key])throw Error("Object ".concat(key," cannot change to array."));deleteField&&updates.push({name:key,action:"delete",fields:oldValue})}}return updates}getDraggableData(){return this.draggable}dragEnd(dropdata,event){this.element.style.top="".concat(event.newFixedTop,"px"),this.element.style.left="".concat(event.newFixedLeft,"px")}_togglePin(){this.draggable=!this.draggable,this.dragdrop.setDraggable(this.draggable),this.draggable?this._unpin():this._pin()}_unpin(){const pageCenterY=window.innerHeight/2,pageCenterX=window.innerWidth/2,style={position:"fixed",resize:"both",overflow:"auto",height:"400px",width:"400px",top:"".concat(pageCenterY-200,"px"),left:"".concat(pageCenterX-200,"px")};Object.assign(this.element.style,style),this.getElement(this.selectors.STATE).style.height="50px",this.getElement(this.selectors.LOG).style.height="50px",this._toggleButtonText(this.getElement(this.selectors.PIN))}_pin(){["position","resize","overflow","top","left","height","width"].forEach((prop=>this.element.style.removeProperty(prop))),this._toggleButtonText(this.getElement(this.selectors.PIN))}_toggleButtonText(element){[element.innerHTML,element.dataset.alt]=[element.dataset.alt,element.innerHTML]}}}));
//# sourceMappingURL=debugpanel.min.js.map
\ No newline at end of file
diff --git a/lib/amd/build/local/reactive/debugpanel.min.js.map b/lib/amd/build/local/reactive/debugpanel.min.js.map
index b69f3f6544023..b6841c9f46a63 100644
--- a/lib/amd/build/local/reactive/debugpanel.min.js.map
+++ b/lib/amd/build/local/reactive/debugpanel.min.js.map
@@ -1 +1 @@
-{"version":3,"file":"debugpanel.min.js","sources":["../../../src/local/reactive/debugpanel.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {BaseComponent, DragDrop, debug} from 'core/reactive';\nimport log from 'core/log';\nimport {debounce} from 'core/utils';\n\n/**\n * Init the main reactive panel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const init = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new GlobalDebugPanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Init an instance reactive subpanel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const initsubpanel = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new DebugInstanceSubpanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass GlobalDebugPanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'GlobalDebugPanel';\n // Default query selectors.\n this.selectors = {\n LOADERS: `[data-for='loaders']`,\n SUBPANEL: `[data-for='subpanel']`,\n NOINSTANCES: `[data-for='noinstances']`,\n LOG: `[data-for='log']`,\n };\n this.classes = {\n HIDE: `d-none`,\n };\n // The list of loaded debuggers.\n this.subPanels = new Set();\n }\n\n /**\n * Initial state ready method.\n *\n * @param {object} state the initial state\n */\n stateReady(state) {\n this._updateReactivesPanels({state});\n // Remove loading wheel.\n this.getElement(this.selectors.SUBPANEL).innerHTML = '';\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives:created`, handler: this._updateReactivesPanels},\n ];\n }\n\n /**\n * Update the list of reactive instances.\n * @param {Object} args\n * @param {Object} args.state the current state\n */\n _updateReactivesPanels({state}) {\n this.getElement(this.selectors.NOINSTANCES)?.classList?.toggle(\n this.classes.HIDE,\n state.reactives.size > 0\n );\n // Generate loading buttons.\n state.reactives.forEach(\n instance => {\n this._createLoader(instance);\n }\n );\n }\n\n /**\n * Create a debug panel button for a specific reactive instance.\n *\n * @param {object} instance hte instance data\n */\n _createLoader(instance) {\n if (this.subPanels.has(instance.id)) {\n return;\n }\n this.subPanels.add(instance.id);\n const loaders = this.getElement(this.selectors.LOADERS);\n const btn = document.createElement(\"button\");\n btn.innerHTML = instance.id;\n btn.dataset.id = instance.id;\n loaders.appendChild(btn);\n // Add click event.\n this.addEventListener(btn, 'click', () => this._openPanel(btn, instance));\n }\n\n /**\n * Open a debug panel.\n *\n * @param {Element} btn the button element\n * @param {object} instance the instance data\n */\n async _openPanel(btn, instance) {\n try {\n const target = this.getElement(this.selectors.SUBPANEL);\n const data = {...instance};\n await this.renderComponent(target, 'core/local/reactive/debuginstancepanel', data);\n } catch (error) {\n log.error('Cannot load reactive debug subpanel');\n throw error;\n }\n }\n}\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass DebugInstanceSubpanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'DebugInstanceSubpanel';\n // Default query selectors.\n this.selectors = {\n NAME: `[data-for='name']`,\n CLOSE: `[data-for='close']`,\n READMODE: `[data-for='readmode']`,\n HIGHLIGHT: `[data-for='highlight']`,\n LOG: `[data-for='log']`,\n STATE: `[data-for='state']`,\n CLEAN: `[data-for='clean']`,\n PIN: `[data-for='pin']`,\n SAVE: `[data-for='save']`,\n INVALID: `[data-for='invalid']`,\n };\n this.id = this.element.dataset.id;\n this.controller = M.reactive[this.id];\n\n // The component is created always pinned.\n this.draggable = false;\n // We want the element to be dragged like modal.\n this.relativeDrag = true;\n // Save warning (will be loaded when state is ready.\n this.strings = {\n savewarning: '',\n };\n }\n\n /**\n * Initial state ready method.\n *\n */\n stateReady() {\n // Enable drag and drop.\n this.dragdrop = new DragDrop(this);\n\n // Close button.\n this.addEventListener(\n this.getElement(this.selectors.CLOSE),\n 'click',\n this.remove\n );\n // Highlight button.\n if (this.controller.highlight) {\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n this.addEventListener(\n this.getElement(this.selectors.HIGHLIGHT),\n 'click',\n () => {\n this.controller.highlight = !this.controller.highlight;\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n );\n // Edit mode button.\n this.addEventListener(\n this.getElement(this.selectors.READMODE),\n 'click',\n this._toggleEditMode\n );\n // Clean log and state.\n this.addEventListener(\n this.getElement(this.selectors.CLEAN),\n 'click',\n this._cleanAreas\n );\n // Unpin panel butotn.\n this.addEventListener(\n this.getElement(this.selectors.PIN),\n 'click',\n this._togglePin\n );\n // Save button, state format error message and state textarea.\n this.getElement(this.selectors.SAVE).disabled = true;\n\n this.addEventListener(\n this.getElement(this.selectors.STATE),\n 'keyup',\n debounce(this._checkJSON, 500)\n );\n\n this.addEventListener(\n this.getElement(this.selectors.SAVE),\n 'click',\n this._saveState\n );\n // Save the default save warning message.\n this.strings.savewarning = this.getElement(this.selectors.INVALID)?.innerHTML ?? '';\n // Add current state.\n this._refreshState();\n }\n\n /**\n * Remove all subcomponents dependencies.\n */\n destroy() {\n if (this.dragdrop !== undefined) {\n this.dragdrop.unregister();\n }\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives[${this.id}].lastChanges:updated`, handler: this._refreshLog},\n {watch: `reactives[${this.id}].modified:updated`, handler: this._refreshState},\n {watch: `reactives[${this.id}].readOnly:updated`, handler: this._refreshReadOnly},\n ];\n }\n\n /**\n * Wtacher method to refresh the log panel.\n *\n * @param {object} args\n * @param {HTMLElement} args.element\n */\n _refreshLog({element}) {\n const list = element?.lastChanges ?? [];\n\n const logContent = list.join(\"\\n\");\n // Append last log.\n const target = this.getElement(this.selectors.LOG);\n target.value += `\\n\\n= Transaction =\\n ${logContent}`;\n target.scrollTop = target.scrollHeight;\n }\n\n /**\n * Listener method to clean the log area.\n */\n _cleanAreas() {\n let target = this.getElement(this.selectors.LOG);\n target.value = '';\n\n this._refreshState();\n }\n\n /**\n * Watcher to refresh the state information.\n */\n _refreshState() {\n const target = this.getElement(this.selectors.STATE);\n target.value = JSON.stringify(this.controller.state, null, 4);\n }\n\n /**\n * Watcher to update the read only information.\n */\n _refreshReadOnly() {\n // Toggle the read mode button.\n const target = this.getElement(this.selectors.READMODE);\n if (target.dataset.readonly === undefined) {\n target.dataset.readonly = target.innerHTML;\n }\n if (this.controller.readOnly) {\n target.innerHTML = target.dataset.readonly;\n } else {\n target.innerHTML = target.dataset.alt;\n }\n }\n\n /**\n * Listener to toggle the edit mode of the component.\n */\n _toggleEditMode() {\n this.controller.readOnly = !this.controller.readOnly;\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type.\n *\n * @return {undefined|array} Array of state updates.\n */\n _checkJSON() {\n const invalid = this.getElement(this.selectors.INVALID);\n const save = this.getElement(this.selectors.SAVE);\n\n const edited = this.getElement(this.selectors.STATE).value;\n\n const currentStateData = this.controller.stateData;\n\n // Check if the json is tha same as state.\n if (edited == JSON.stringify(this.controller.state, null, 4)) {\n invalid.style.color = '';\n invalid.innerHTML = '';\n save.disabled = true;\n return undefined;\n }\n\n // Check if the json format is valid.\n try {\n const newState = JSON.parse(edited);\n // Check the first level did not change types.\n const result = this._generateStateUpdates(currentStateData, newState);\n // Enable save button.\n invalid.style.color = '';\n invalid.innerHTML = this.strings.savewarning;\n save.disabled = false;\n return result;\n } catch (error) {\n invalid.style.color = 'red';\n invalid.innerHTML = error.message ?? 'Invalid JSON sctructure';\n save.disabled = true;\n return undefined;\n }\n }\n\n /**\n * Listener to save the current edited state into the real state.\n */\n _saveState() {\n const updates = this._checkJSON();\n if (!updates) {\n return;\n }\n // Sent the updates to the state manager.\n this.controller.processUpdates(updates);\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type. This method do a two\n * steps comparison between the current state data and the new state data.\n *\n * A reactive state cannot be overridden like any other variable. To keep\n * the watchers updated is necessary to transform the current state into\n * the new one. As a result, this method generates all the necessary state\n * updates to convert the state into the new state.\n *\n * @param {object} currentStateData\n * @param {object} newStateData\n * @return {array} Array of state updates.\n * @throws {Error} is the structure is not compatible\n */\n _generateStateUpdates(currentStateData, newStateData) {\n\n const updates = [];\n\n const ids = {};\n\n // Step 1: Add all overrides newStateData.\n for (const [key, newValue] of Object.entries(newStateData)) {\n // Check is it is new.\n if (Array.isArray(newValue)) {\n ids[key] = {};\n newValue.forEach(element => {\n if (element.id === undefined) {\n throw Error(`Array ${key} element without id attribute`);\n }\n updates.push({\n name: key,\n action: 'override',\n fields: element,\n });\n const index = String(element.id).valueOf();\n ids[key][index] = true;\n });\n } else {\n updates.push({\n name: key,\n action: 'override',\n fields: newValue,\n });\n }\n }\n // Step 2: delete unnecesary data from currentStateData.\n for (const [key, oldValue] of Object.entries(currentStateData)) {\n let deleteField = false;\n // Check if the attribute is still there.\n if (newStateData[key] === undefined) {\n deleteField = true;\n }\n if (Array.isArray(oldValue)) {\n if (!deleteField && ids[key] === undefined) {\n throw Error(`Array ${key} cannot change to object.`);\n }\n oldValue.forEach(element => {\n const index = String(element.id).valueOf();\n let deleteEntry = deleteField;\n // Check if the id is there.\n if (!deleteEntry && ids[key][index] === undefined) {\n deleteEntry = true;\n }\n if (deleteEntry) {\n updates.push({\n name: key,\n action: 'delete',\n fields: element,\n });\n }\n });\n } else {\n if (!deleteField && ids[key] !== undefined) {\n throw Error(`Object ${key} cannot change to array.`);\n }\n if (deleteField) {\n updates.push({\n name: key,\n action: 'delete',\n fields: oldValue,\n });\n }\n }\n }\n // Delete all elements without action.\n return updates;\n }\n\n // Drag and drop methods.\n\n /**\n * Get the draggable data of this component.\n *\n * @returns {Object} exported course module drop data\n */\n getDraggableData() {\n return this.draggable;\n }\n\n /**\n * The element drop end hook.\n *\n * @param {Object} dropdata the dropdata\n * @param {Event} event the dropdata\n */\n dragEnd(dropdata, event) {\n this.element.style.top = `${event.newFixedTop}px`;\n this.element.style.left = `${event.newFixedLeft}px`;\n }\n\n /**\n * Pin and unpin the panel.\n */\n _togglePin() {\n this.draggable = !this.draggable;\n this.dragdrop.setDraggable(this.draggable);\n if (this.draggable) {\n this._unpin();\n } else {\n this._pin();\n }\n }\n\n /**\n * Unpin the panel form the footer.\n */\n _unpin() {\n // Find the initial spot.\n const pageCenterY = window.innerHeight / 2;\n const pageCenterX = window.innerWidth / 2;\n // Put the element in the middle of the screen\n const style = {\n position: 'fixed',\n resize: 'both',\n overflow: 'auto',\n height: '400px',\n width: '400px',\n top: `${pageCenterY - 200}px`,\n left: `${pageCenterX - 200}px`,\n };\n Object.assign(this.element.style, style);\n // Small also the text areas.\n this.getElement(this.selectors.STATE).style.height = '50px';\n this.getElement(this.selectors.LOG).style.height = '50px';\n\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Pin the panel into the footer.\n */\n _pin() {\n const props = [\n 'position',\n 'resize',\n 'overflow',\n 'top',\n 'left',\n 'height',\n 'width',\n ];\n props.forEach(\n prop => this.element.style.removeProperty(prop)\n );\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Toogle the button text with the data-alt value.\n *\n * @param {Element} element the button element\n */\n _toggleButtonText(element) {\n [element.innerHTML, element.dataset.alt] = [element.dataset.alt, element.innerHTML];\n }\n\n}\n"],"names":["target","selectors","element","document","getElementById","undefined","debug","GlobalDebugPanel","reactive","remove","DebugInstanceSubpanel","BaseComponent","create","name","LOADERS","SUBPANEL","NOINSTANCES","LOG","classes","HIDE","subPanels","Set","stateReady","state","_updateReactivesPanels","getElement","this","innerHTML","getWatchers","watch","handler","classList","toggle","reactives","size","forEach","instance","_createLoader","has","id","add","loaders","btn","createElement","dataset","appendChild","addEventListener","_openPanel","data","renderComponent","error","NAME","CLOSE","READMODE","HIGHLIGHT","STATE","CLEAN","PIN","SAVE","INVALID","controller","M","draggable","relativeDrag","strings","savewarning","dragdrop","DragDrop","highlight","_toggleButtonText","_toggleEditMode","_cleanAreas","_togglePin","disabled","_checkJSON","_saveState","_this$getElement2","_refreshState","destroy","unregister","_refreshLog","_refreshReadOnly","logContent","lastChanges","join","value","scrollTop","scrollHeight","JSON","stringify","readonly","readOnly","alt","invalid","save","edited","currentStateData","stateData","style","color","newState","parse","result","_generateStateUpdates","message","updates","processUpdates","newStateData","ids","key","newValue","Object","entries","Array","isArray","Error","push","action","fields","index","String","valueOf","oldValue","deleteField","deleteEntry","getDraggableData","dragEnd","dropdata","event","top","newFixedTop","left","newFixedLeft","setDraggable","_unpin","_pin","pageCenterY","window","innerHeight","pageCenterX","innerWidth","position","resize","overflow","height","width","assign","prop","removeProperty"],"mappings":";;;;;;;;;;;wKAqCoB,CAACA,OAAQC,mBACnBC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAC,iBAAiB,CACjBL,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gCAiBY,CAACT,OAAQC,mBAC3BC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAI,sBAAsB,CACtBR,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gBAiBVF,yBAAyBI,wBAK3BC,cAESC,KAAO,wBAEPZ,UAAY,CACba,+BACAC,iCACAC,uCACAC,6BAECC,QAAU,CACXC,oBAGCC,UAAY,IAAIC,IAQzBC,WAAWC,YACFC,uBAAuB,CAACD,MAAAA,aAExBE,WAAWC,KAAKzB,UAAUc,UAAUY,UAAY,GAQzDC,oBACW,CACH,CAACC,0BAA4BC,QAASJ,KAAKF,yBASnDA,4EAAuBD,MAACA,0CACfE,WAAWC,KAAKzB,UAAUe,yFAAce,kEAAWC,OACpDN,KAAKR,QAAQC,KACbI,MAAMU,UAAUC,KAAO,GAG3BX,MAAMU,UAAUE,SACZC,gBACSC,cAAcD,aAU/BC,cAAcD,aACNV,KAAKN,UAAUkB,IAAIF,SAASG,gBAG3BnB,UAAUoB,IAAIJ,SAASG,UACtBE,QAAUf,KAAKD,WAAWC,KAAKzB,UAAUa,SACzC4B,IAAMvC,SAASwC,cAAc,UACnCD,IAAIf,UAAYS,SAASG,GACzBG,IAAIE,QAAQL,GAAKH,SAASG,GAC1BE,QAAQI,YAAYH,UAEfI,iBAAiBJ,IAAK,SAAS,IAAMhB,KAAKqB,WAAWL,IAAKN,6BASlDM,IAAKN,oBAERpC,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUc,UACxCiC,KAAO,IAAIZ,gBACXV,KAAKuB,gBAAgBjD,OAAQ,yCAA0CgD,MAC/E,MAAOE,0BACDA,MAAM,uCACJA,cAWZxC,8BAA8BC,wBAKhCC,cAESC,KAAO,6BAEPZ,UAAY,CACbkD,yBACAC,2BACAC,iCACAC,mCACArC,uBACAsC,2BACAC,2BACAC,uBACAC,yBACAC,qCAECpB,GAAKb,KAAKxB,QAAQ0C,QAAQL,QAC1BqB,WAAaC,EAAErD,SAASkB,KAAKa,SAG7BuB,WAAY,OAEZC,cAAe,OAEfC,QAAU,CACXC,YAAa,IAQrB3C,8DAES4C,SAAW,IAAIC,mBAASzC,WAGxBoB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUmD,OAC/B,QACA1B,KAAKjB,QAGLiB,KAAKkC,WAAWQ,gBACXC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,iBAErDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUqD,WAC/B,SACA,UACSM,WAAWQ,WAAa1C,KAAKkC,WAAWQ,eACxCC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,oBAIzDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUoD,UAC/B,QACA3B,KAAK4C,sBAGJxB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUuD,OAC/B,QACA9B,KAAK6C,kBAGJzB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUwD,KAC/B,QACA/B,KAAK8C,iBAGJ/C,WAAWC,KAAKzB,UAAUyD,MAAMe,UAAW,OAE3C3B,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUsD,OAC/B,SACA,mBAAS7B,KAAKgD,WAAY,WAGzB5B,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUyD,MAC/B,QACAhC,KAAKiD,iBAGJX,QAAQC,oEAAcvC,KAAKD,WAAWC,KAAKzB,UAAU0D,6CAA/BiB,kBAAyCjD,iEAAa,QAE5EkD,gBAMTC,eAC0BzE,IAAlBqB,KAAKwC,eACAA,SAASa,aAStBnD,oBACW,CACH,CAACC,0BAAoBH,KAAKa,4BAA2BT,QAASJ,KAAKsD,aACnE,CAACnD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKmD,eAChE,CAAChD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKuD,mBAUxED,gDAAY9E,QAACA,qBAGHgF,yCAFOhF,MAAAA,eAAAA,QAASiF,iEAAe,IAEbC,KAAK,MAEvBpF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUgB,KAC9CjB,OAAOqF,uCAAkCH,YACzClF,OAAOsF,UAAYtF,OAAOuF,aAM9BhB,cACiB7C,KAAKD,WAAWC,KAAKzB,UAAUgB,KACrCoE,MAAQ,QAEVR,gBAMTA,gBACmBnD,KAAKD,WAAWC,KAAKzB,UAAUsD,OACvC8B,MAAQG,KAAKC,UAAU/D,KAAKkC,WAAWrC,MAAO,KAAM,GAM/D0D,yBAEUjF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUoD,eACdhD,IAA5BL,OAAO4C,QAAQ8C,WACf1F,OAAO4C,QAAQ8C,SAAW1F,OAAO2B,WAEjCD,KAAKkC,WAAW+B,SAChB3F,OAAO2B,UAAY3B,OAAO4C,QAAQ8C,SAElC1F,OAAO2B,UAAY3B,OAAO4C,QAAQgD,IAO1CtB,uBACSV,WAAW+B,UAAYjE,KAAKkC,WAAW+B,SAWhDjB,mBACUmB,QAAUnE,KAAKD,WAAWC,KAAKzB,UAAU0D,SACzCmC,KAAOpE,KAAKD,WAAWC,KAAKzB,UAAUyD,MAEtCqC,OAASrE,KAAKD,WAAWC,KAAKzB,UAAUsD,OAAO8B,MAE/CW,iBAAmBtE,KAAKkC,WAAWqC,aAGrCF,QAAUP,KAAKC,UAAU/D,KAAKkC,WAAWrC,MAAO,KAAM,UACtDsE,QAAQK,MAAMC,MAAQ,GACtBN,QAAQlE,UAAY,QACpBmE,KAAKrB,UAAW,aAMV2B,SAAWZ,KAAKa,MAAMN,QAEtBO,OAAS5E,KAAK6E,sBAAsBP,iBAAkBI,iBAE5DP,QAAQK,MAAMC,MAAQ,GACtBN,QAAQlE,UAAYD,KAAKsC,QAAQC,YACjC6B,KAAKrB,UAAW,EACT6B,OACT,MAAOpD,iCACL2C,QAAQK,MAAMC,MAAQ,MACtBN,QAAQlE,iCAAYuB,MAAMsD,iDAAW,+BACrCV,KAAKrB,UAAW,IAQxBE,mBACU8B,QAAU/E,KAAKgD,aAChB+B,cAIA7C,WAAW8C,eAAeD,SAoBnCF,sBAAsBP,iBAAkBW,oBAE9BF,QAAU,GAEVG,IAAM,OAGP,MAAOC,IAAKC,YAAaC,OAAOC,QAAQL,cAErCM,MAAMC,QAAQJ,WACdF,IAAIC,KAAO,GACXC,SAAS3E,SAAQjC,kBACMG,IAAfH,QAAQqC,SACF4E,sBAAeN,sCAEzBJ,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,WACRC,OAAQpH,gBAENqH,MAAQC,OAAOtH,QAAQqC,IAAIkF,UACjCb,IAAIC,KAAKU,QAAS,MAGtBd,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,WACRC,OAAQR,eAKf,MAAOD,IAAKa,YAAaX,OAAOC,QAAQhB,kBAAmB,KACxD2B,aAAc,UAEQtH,IAAtBsG,aAAaE,OACbc,aAAc,GAEdV,MAAMC,QAAQQ,UAAW,KACpBC,kBAA4BtH,IAAbuG,IAAIC,WACdM,sBAAeN,kCAEzBa,SAASvF,SAAQjC,gBACPqH,MAAQC,OAAOtH,QAAQqC,IAAIkF,cAC7BG,YAAcD,YAEbC,kBAAmCvH,IAApBuG,IAAIC,KAAKU,SACzBK,aAAc,GAEdA,aACAnB,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,SACRC,OAAQpH,iBAIjB,KACEyH,kBAA4BtH,IAAbuG,IAAIC,WACdM,uBAAgBN,iCAEtBc,aACAlB,QAAQW,KAAK,CACTvG,KAAMgG,IACNQ,OAAQ,SACRC,OAAQI,mBAMjBjB,QAUXoB,0BACWnG,KAAKoC,UAShBgE,QAAQC,SAAUC,YACT9H,QAAQgG,MAAM+B,cAASD,MAAME,uBAC7BhI,QAAQgG,MAAMiC,eAAUH,MAAMI,mBAMvC5D,kBACSV,WAAapC,KAAKoC,eAClBI,SAASmE,aAAa3G,KAAKoC,WAC5BpC,KAAKoC,eACAwE,cAEAC,OAObD,eAEUE,YAAcC,OAAOC,YAAc,EACnCC,YAAcF,OAAOG,WAAa,EAElC1C,MAAQ,CACV2C,SAAU,QACVC,OAAQ,OACRC,SAAU,OACVC,OAAQ,QACRC,MAAO,QACPhB,cAAQO,YAAc,UACtBL,eAASQ,YAAc,WAE3B5B,OAAOmC,OAAOxH,KAAKxB,QAAQgG,MAAOA,YAE7BzE,WAAWC,KAAKzB,UAAUsD,OAAO2C,MAAM8C,OAAS,YAChDvH,WAAWC,KAAKzB,UAAUgB,KAAKiF,MAAM8C,OAAS,YAE9C3E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAM1D8E,OACkB,CACV,WACA,SACA,WACA,MACA,OACA,SACA,SAEEpG,SACFgH,MAAQzH,KAAKxB,QAAQgG,MAAMkD,eAAeD,aAEzC9E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAQ1DY,kBAAkBnE,UACbA,QAAQyB,UAAWzB,QAAQ0C,QAAQgD,KAAO,CAAC1F,QAAQ0C,QAAQgD,IAAK1F,QAAQyB"}
\ No newline at end of file
+{"version":3,"file":"debugpanel.min.js","sources":["../../../src/local/reactive/debugpanel.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {BaseComponent, DragDrop, debug} from 'core/reactive';\nimport log from 'core/log';\nimport {debounce} from 'core/utils';\n\n/**\n * Init the main reactive panel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const init = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new GlobalDebugPanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Init an instance reactive subpanel.\n *\n * @param {element|string} target the DOM main element or its ID\n * @param {object} selectors optional css selector overrides\n */\nexport const initsubpanel = (target, selectors) => {\n const element = document.getElementById(target);\n // Check if the debug reactive module is available.\n if (debug === undefined) {\n element.remove();\n return;\n }\n // Create the main component.\n new DebugInstanceSubpanel({\n element,\n reactive: debug,\n selectors,\n });\n};\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass GlobalDebugPanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'GlobalDebugPanel';\n // Default query selectors.\n this.selectors = {\n LOADERS: `[data-for='loaders']`,\n SUBPANEL: `[data-for='subpanel']`,\n NOINSTANCES: `[data-for='noinstances']`,\n LOG: `[data-for='log']`,\n };\n this.classes = {\n HIDE: `d-none`,\n };\n // The list of loaded debuggers.\n this.subPanels = new Set();\n }\n\n /**\n * Initial state ready method.\n *\n * @param {object} state the initial state\n */\n stateReady(state) {\n this._updateReactivesPanels({state});\n // Remove loading wheel.\n this.getElement(this.selectors.SUBPANEL).innerHTML = '';\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives:created`, handler: this._updateReactivesPanels},\n ];\n }\n\n /**\n * Update the list of reactive instances.\n * @param {Object} args\n * @param {Object} args.state the current state\n */\n _updateReactivesPanels({state}) {\n this.getElement(this.selectors.NOINSTANCES)?.classList?.toggle(\n this.classes.HIDE,\n state.reactives.size > 0\n );\n // Generate loading buttons.\n state.reactives.forEach(\n instance => {\n this._createLoader(instance);\n }\n );\n }\n\n /**\n * Create a debug panel button for a specific reactive instance.\n *\n * @param {object} instance hte instance data\n */\n _createLoader(instance) {\n if (this.subPanels.has(instance.id)) {\n return;\n }\n this.subPanels.add(instance.id);\n const loaders = this.getElement(this.selectors.LOADERS);\n const btn = document.createElement(\"button\");\n btn.innerHTML = instance.id;\n btn.dataset.id = instance.id;\n loaders.appendChild(btn);\n // Add click event.\n this.addEventListener(btn, 'click', () => this._openPanel(btn, instance));\n }\n\n /**\n * Open a debug panel.\n *\n * @param {Element} btn the button element\n * @param {object} instance the instance data\n */\n async _openPanel(btn, instance) {\n try {\n const target = this.getElement(this.selectors.SUBPANEL);\n const data = {...instance};\n await this.renderComponent(target, 'core/local/reactive/debuginstancepanel', data);\n } catch (error) {\n log.error('Cannot load reactive debug subpanel');\n throw error;\n }\n }\n}\n\n/**\n * Component for the main reactive dev panel.\n *\n * This component shows the list of reactive instances and handle the buttons\n * to open a specific instance panel.\n */\nclass DebugInstanceSubpanel extends BaseComponent {\n\n /**\n * Constructor hook.\n */\n create() {\n // Optional component name for debugging.\n this.name = 'DebugInstanceSubpanel';\n // Default query selectors.\n this.selectors = {\n NAME: `[data-for='name']`,\n CLOSE: `[data-for='close']`,\n READMODE: `[data-for='readmode']`,\n HIGHLIGHT: `[data-for='highlight']`,\n LOG: `[data-for='log']`,\n STATE: `[data-for='state']`,\n CLEAN: `[data-for='clean']`,\n PIN: `[data-for='pin']`,\n SAVE: `[data-for='save']`,\n INVALID: `[data-for='invalid']`,\n };\n this.id = this.element.dataset.id;\n this.controller = M.reactive[this.id];\n\n // The component is created always pinned.\n this.draggable = false;\n // We want the element to be dragged like modal.\n this.relativeDrag = true;\n // Save warning (will be loaded when state is ready.\n this.strings = {\n savewarning: '',\n };\n }\n\n /**\n * Initial state ready method.\n *\n */\n stateReady() {\n // Enable drag and drop.\n this.dragdrop = new DragDrop(this);\n\n // Close button.\n this.addEventListener(\n this.getElement(this.selectors.CLOSE),\n 'click',\n this.remove\n );\n // Highlight button.\n if (this.controller.highlight) {\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n this.addEventListener(\n this.getElement(this.selectors.HIGHLIGHT),\n 'click',\n () => {\n this.controller.highlight = !this.controller.highlight;\n this._toggleButtonText(this.getElement(this.selectors.HIGHLIGHT));\n }\n );\n // Edit mode button.\n this.addEventListener(\n this.getElement(this.selectors.READMODE),\n 'click',\n this._toggleEditMode\n );\n // Clean log and state.\n this.addEventListener(\n this.getElement(this.selectors.CLEAN),\n 'click',\n this._cleanAreas\n );\n // Unpin panel butotn.\n this.addEventListener(\n this.getElement(this.selectors.PIN),\n 'click',\n this._togglePin\n );\n // Save button, state format error message and state textarea.\n this.getElement(this.selectors.SAVE).disabled = true;\n\n this.addEventListener(\n this.getElement(this.selectors.STATE),\n 'keyup',\n debounce(this._checkJSON.bind(this), 500)\n );\n\n this.addEventListener(\n this.getElement(this.selectors.SAVE),\n 'click',\n this._saveState\n );\n // Save the default save warning message.\n this.strings.savewarning = this.getElement(this.selectors.INVALID)?.innerHTML ?? '';\n // Add current state.\n this._refreshState();\n }\n\n /**\n * Remove all subcomponents dependencies.\n */\n destroy() {\n if (this.dragdrop !== undefined) {\n this.dragdrop.unregister();\n }\n }\n\n /**\n * Component watchers.\n *\n * @returns {Array} of watchers\n */\n getWatchers() {\n return [\n {watch: `reactives[${this.id}].lastChanges:updated`, handler: this._refreshLog},\n {watch: `reactives[${this.id}].modified:updated`, handler: this._refreshState},\n {watch: `reactives[${this.id}].readOnly:updated`, handler: this._refreshReadOnly},\n ];\n }\n\n /**\n * Wtacher method to refresh the log panel.\n *\n * @param {object} args\n * @param {HTMLElement} args.element\n */\n _refreshLog({element}) {\n const list = element?.lastChanges ?? [];\n\n const logContent = list.join(\"\\n\");\n // Append last log.\n const target = this.getElement(this.selectors.LOG);\n target.value += `\\n\\n= Transaction =\\n ${logContent}`;\n target.scrollTop = target.scrollHeight;\n }\n\n /**\n * Listener method to clean the log area.\n */\n _cleanAreas() {\n let target = this.getElement(this.selectors.LOG);\n target.value = '';\n\n this._refreshState();\n }\n\n /**\n * Watcher to refresh the state information.\n */\n _refreshState() {\n const target = this.getElement(this.selectors.STATE);\n target.value = JSON.stringify(this.controller.state, null, 4);\n }\n\n /**\n * Watcher to update the read only information.\n */\n _refreshReadOnly() {\n // Toggle the read mode button.\n const target = this.getElement(this.selectors.READMODE);\n if (target.dataset.readonly === undefined) {\n target.dataset.readonly = target.innerHTML;\n }\n if (this.controller.readOnly) {\n target.innerHTML = target.dataset.readonly;\n } else {\n target.innerHTML = target.dataset.alt;\n }\n }\n\n /**\n * Listener to toggle the edit mode of the component.\n */\n _toggleEditMode() {\n this.controller.readOnly = !this.controller.readOnly;\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type.\n *\n * @return {undefined|array} Array of state updates.\n */\n _checkJSON() {\n const invalid = this.getElement(this.selectors.INVALID);\n const save = this.getElement(this.selectors.SAVE);\n\n const edited = this.getElement(this.selectors.STATE).value;\n\n const currentStateData = this.controller.stateData;\n\n // Check if the json is tha same as state.\n if (edited == JSON.stringify(this.controller.state, null, 4)) {\n invalid.style.color = '';\n invalid.innerHTML = '';\n save.disabled = true;\n return undefined;\n }\n\n // Check if the json format is valid.\n try {\n const newState = JSON.parse(edited);\n // Check the first level did not change types.\n const result = this._generateStateUpdates(currentStateData, newState);\n // Enable save button.\n invalid.style.color = '';\n invalid.innerHTML = this.strings.savewarning;\n save.disabled = false;\n return result;\n } catch (error) {\n invalid.style.color = 'red';\n invalid.innerHTML = error.message ?? 'Invalid JSON sctructure';\n save.disabled = true;\n return undefined;\n }\n }\n\n /**\n * Listener to save the current edited state into the real state.\n */\n _saveState() {\n const updates = this._checkJSON();\n if (!updates) {\n return;\n }\n // Sent the updates to the state manager.\n this.controller.processUpdates(updates);\n }\n\n /**\n * Check that the edited state JSON is valid.\n *\n * Not all valid JSON are suitable for transforming the state. For example,\n * the first level attributes cannot change the type. This method do a two\n * steps comparison between the current state data and the new state data.\n *\n * A reactive state cannot be overridden like any other variable. To keep\n * the watchers updated is necessary to transform the current state into\n * the new one. As a result, this method generates all the necessary state\n * updates to convert the state into the new state.\n *\n * @param {object} currentStateData\n * @param {object} newStateData\n * @return {array} Array of state updates.\n * @throws {Error} is the structure is not compatible\n */\n _generateStateUpdates(currentStateData, newStateData) {\n\n const updates = [];\n\n const ids = {};\n\n // Step 1: Add all overrides newStateData.\n for (const [key, newValue] of Object.entries(newStateData)) {\n // Check is it is new.\n if (Array.isArray(newValue)) {\n ids[key] = {};\n newValue.forEach(element => {\n if (element.id === undefined) {\n throw Error(`Array ${key} element without id attribute`);\n }\n updates.push({\n name: key,\n action: 'override',\n fields: element,\n });\n const index = String(element.id).valueOf();\n ids[key][index] = true;\n });\n } else {\n updates.push({\n name: key,\n action: 'override',\n fields: newValue,\n });\n }\n }\n // Step 2: delete unnecesary data from currentStateData.\n for (const [key, oldValue] of Object.entries(currentStateData)) {\n let deleteField = false;\n // Check if the attribute is still there.\n if (newStateData[key] === undefined) {\n deleteField = true;\n }\n if (Array.isArray(oldValue)) {\n if (!deleteField && ids[key] === undefined) {\n throw Error(`Array ${key} cannot change to object.`);\n }\n oldValue.forEach(element => {\n const index = String(element.id).valueOf();\n let deleteEntry = deleteField;\n // Check if the id is there.\n if (!deleteEntry && ids[key][index] === undefined) {\n deleteEntry = true;\n }\n if (deleteEntry) {\n updates.push({\n name: key,\n action: 'delete',\n fields: element,\n });\n }\n });\n } else {\n if (!deleteField && ids[key] !== undefined) {\n throw Error(`Object ${key} cannot change to array.`);\n }\n if (deleteField) {\n updates.push({\n name: key,\n action: 'delete',\n fields: oldValue,\n });\n }\n }\n }\n // Delete all elements without action.\n return updates;\n }\n\n // Drag and drop methods.\n\n /**\n * Get the draggable data of this component.\n *\n * @returns {Object} exported course module drop data\n */\n getDraggableData() {\n return this.draggable;\n }\n\n /**\n * The element drop end hook.\n *\n * @param {Object} dropdata the dropdata\n * @param {Event} event the dropdata\n */\n dragEnd(dropdata, event) {\n this.element.style.top = `${event.newFixedTop}px`;\n this.element.style.left = `${event.newFixedLeft}px`;\n }\n\n /**\n * Pin and unpin the panel.\n */\n _togglePin() {\n this.draggable = !this.draggable;\n this.dragdrop.setDraggable(this.draggable);\n if (this.draggable) {\n this._unpin();\n } else {\n this._pin();\n }\n }\n\n /**\n * Unpin the panel form the footer.\n */\n _unpin() {\n // Find the initial spot.\n const pageCenterY = window.innerHeight / 2;\n const pageCenterX = window.innerWidth / 2;\n // Put the element in the middle of the screen\n const style = {\n position: 'fixed',\n resize: 'both',\n overflow: 'auto',\n height: '400px',\n width: '400px',\n top: `${pageCenterY - 200}px`,\n left: `${pageCenterX - 200}px`,\n };\n Object.assign(this.element.style, style);\n // Small also the text areas.\n this.getElement(this.selectors.STATE).style.height = '50px';\n this.getElement(this.selectors.LOG).style.height = '50px';\n\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Pin the panel into the footer.\n */\n _pin() {\n const props = [\n 'position',\n 'resize',\n 'overflow',\n 'top',\n 'left',\n 'height',\n 'width',\n ];\n props.forEach(\n prop => this.element.style.removeProperty(prop)\n );\n this._toggleButtonText(this.getElement(this.selectors.PIN));\n }\n\n /**\n * Toogle the button text with the data-alt value.\n *\n * @param {Element} element the button element\n */\n _toggleButtonText(element) {\n [element.innerHTML, element.dataset.alt] = [element.dataset.alt, element.innerHTML];\n }\n\n}\n"],"names":["target","selectors","element","document","getElementById","undefined","debug","GlobalDebugPanel","reactive","remove","DebugInstanceSubpanel","BaseComponent","create","name","LOADERS","SUBPANEL","NOINSTANCES","LOG","classes","HIDE","subPanels","Set","stateReady","state","_updateReactivesPanels","getElement","this","innerHTML","getWatchers","watch","handler","classList","toggle","reactives","size","forEach","instance","_createLoader","has","id","add","loaders","btn","createElement","dataset","appendChild","addEventListener","_openPanel","data","renderComponent","error","NAME","CLOSE","READMODE","HIGHLIGHT","STATE","CLEAN","PIN","SAVE","INVALID","controller","M","draggable","relativeDrag","strings","savewarning","dragdrop","DragDrop","highlight","_toggleButtonText","_toggleEditMode","_cleanAreas","_togglePin","disabled","_checkJSON","bind","_saveState","_this$getElement2","_refreshState","destroy","unregister","_refreshLog","_refreshReadOnly","logContent","lastChanges","join","value","scrollTop","scrollHeight","JSON","stringify","readonly","readOnly","alt","invalid","save","edited","currentStateData","stateData","style","color","newState","parse","result","_generateStateUpdates","message","updates","processUpdates","newStateData","ids","key","newValue","Object","entries","Array","isArray","Error","push","action","fields","index","String","valueOf","oldValue","deleteField","deleteEntry","getDraggableData","dragEnd","dropdata","event","top","newFixedTop","left","newFixedLeft","setDraggable","_unpin","_pin","pageCenterY","window","innerHeight","pageCenterX","innerWidth","position","resize","overflow","height","width","assign","prop","removeProperty"],"mappings":";;;;;;;;;;;wKAqCoB,CAACA,OAAQC,mBACnBC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAC,iBAAiB,CACjBL,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gCAiBY,CAACT,OAAQC,mBAC3BC,QAAUC,SAASC,eAAeJ,aAE1BK,IAAVC,oBAKAI,sBAAsB,CACtBR,QAAAA,QACAM,SAAUF,gBACVL,UAAAA,YAPAC,QAAQO,gBAiBVF,yBAAyBI,wBAK3BC,cAESC,KAAO,wBAEPZ,UAAY,CACba,+BACAC,iCACAC,uCACAC,6BAECC,QAAU,CACXC,oBAGCC,UAAY,IAAIC,IAQzBC,WAAWC,YACFC,uBAAuB,CAACD,MAAAA,aAExBE,WAAWC,KAAKzB,UAAUc,UAAUY,UAAY,GAQzDC,oBACW,CACH,CAACC,0BAA4BC,QAASJ,KAAKF,yBASnDA,4EAAuBD,MAACA,0CACfE,WAAWC,KAAKzB,UAAUe,yFAAce,kEAAWC,OACpDN,KAAKR,QAAQC,KACbI,MAAMU,UAAUC,KAAO,GAG3BX,MAAMU,UAAUE,SACZC,gBACSC,cAAcD,aAU/BC,cAAcD,aACNV,KAAKN,UAAUkB,IAAIF,SAASG,gBAG3BnB,UAAUoB,IAAIJ,SAASG,UACtBE,QAAUf,KAAKD,WAAWC,KAAKzB,UAAUa,SACzC4B,IAAMvC,SAASwC,cAAc,UACnCD,IAAIf,UAAYS,SAASG,GACzBG,IAAIE,QAAQL,GAAKH,SAASG,GAC1BE,QAAQI,YAAYH,UAEfI,iBAAiBJ,IAAK,SAAS,IAAMhB,KAAKqB,WAAWL,IAAKN,6BASlDM,IAAKN,oBAERpC,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUc,UACxCiC,KAAO,IAAIZ,gBACXV,KAAKuB,gBAAgBjD,OAAQ,yCAA0CgD,MAC/E,MAAOE,0BACDA,MAAM,uCACJA,cAWZxC,8BAA8BC,wBAKhCC,cAESC,KAAO,6BAEPZ,UAAY,CACbkD,yBACAC,2BACAC,iCACAC,mCACArC,uBACAsC,2BACAC,2BACAC,uBACAC,yBACAC,qCAECpB,GAAKb,KAAKxB,QAAQ0C,QAAQL,QAC1BqB,WAAaC,EAAErD,SAASkB,KAAKa,SAG7BuB,WAAY,OAEZC,cAAe,OAEfC,QAAU,CACXC,YAAa,IAQrB3C,8DAES4C,SAAW,IAAIC,mBAASzC,WAGxBoB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUmD,OAC/B,QACA1B,KAAKjB,QAGLiB,KAAKkC,WAAWQ,gBACXC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,iBAErDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUqD,WAC/B,SACA,UACSM,WAAWQ,WAAa1C,KAAKkC,WAAWQ,eACxCC,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUqD,oBAIzDR,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUoD,UAC/B,QACA3B,KAAK4C,sBAGJxB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUuD,OAC/B,QACA9B,KAAK6C,kBAGJzB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUwD,KAC/B,QACA/B,KAAK8C,iBAGJ/C,WAAWC,KAAKzB,UAAUyD,MAAMe,UAAW,OAE3C3B,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUsD,OAC/B,SACA,mBAAS7B,KAAKgD,WAAWC,KAAKjD,MAAO,WAGpCoB,iBACDpB,KAAKD,WAAWC,KAAKzB,UAAUyD,MAC/B,QACAhC,KAAKkD,iBAGJZ,QAAQC,oEAAcvC,KAAKD,WAAWC,KAAKzB,UAAU0D,6CAA/BkB,kBAAyClD,iEAAa,QAE5EmD,gBAMTC,eAC0B1E,IAAlBqB,KAAKwC,eACAA,SAASc,aAStBpD,oBACW,CACH,CAACC,0BAAoBH,KAAKa,4BAA2BT,QAASJ,KAAKuD,aACnE,CAACpD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKoD,eAChE,CAACjD,0BAAoBH,KAAKa,yBAAwBT,QAASJ,KAAKwD,mBAUxED,gDAAY/E,QAACA,qBAGHiF,yCAFOjF,MAAAA,eAAAA,QAASkF,iEAAe,IAEbC,KAAK,MAEvBrF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUgB,KAC9CjB,OAAOsF,uCAAkCH,YACzCnF,OAAOuF,UAAYvF,OAAOwF,aAM9BjB,cACiB7C,KAAKD,WAAWC,KAAKzB,UAAUgB,KACrCqE,MAAQ,QAEVR,gBAMTA,gBACmBpD,KAAKD,WAAWC,KAAKzB,UAAUsD,OACvC+B,MAAQG,KAAKC,UAAUhE,KAAKkC,WAAWrC,MAAO,KAAM,GAM/D2D,yBAEUlF,OAAS0B,KAAKD,WAAWC,KAAKzB,UAAUoD,eACdhD,IAA5BL,OAAO4C,QAAQ+C,WACf3F,OAAO4C,QAAQ+C,SAAW3F,OAAO2B,WAEjCD,KAAKkC,WAAWgC,SAChB5F,OAAO2B,UAAY3B,OAAO4C,QAAQ+C,SAElC3F,OAAO2B,UAAY3B,OAAO4C,QAAQiD,IAO1CvB,uBACSV,WAAWgC,UAAYlE,KAAKkC,WAAWgC,SAWhDlB,mBACUoB,QAAUpE,KAAKD,WAAWC,KAAKzB,UAAU0D,SACzCoC,KAAOrE,KAAKD,WAAWC,KAAKzB,UAAUyD,MAEtCsC,OAAStE,KAAKD,WAAWC,KAAKzB,UAAUsD,OAAO+B,MAE/CW,iBAAmBvE,KAAKkC,WAAWsC,aAGrCF,QAAUP,KAAKC,UAAUhE,KAAKkC,WAAWrC,MAAO,KAAM,UACtDuE,QAAQK,MAAMC,MAAQ,GACtBN,QAAQnE,UAAY,QACpBoE,KAAKtB,UAAW,aAMV4B,SAAWZ,KAAKa,MAAMN,QAEtBO,OAAS7E,KAAK8E,sBAAsBP,iBAAkBI,iBAE5DP,QAAQK,MAAMC,MAAQ,GACtBN,QAAQnE,UAAYD,KAAKsC,QAAQC,YACjC8B,KAAKtB,UAAW,EACT8B,OACT,MAAOrD,iCACL4C,QAAQK,MAAMC,MAAQ,MACtBN,QAAQnE,iCAAYuB,MAAMuD,iDAAW,+BACrCV,KAAKtB,UAAW,IAQxBG,mBACU8B,QAAUhF,KAAKgD,aAChBgC,cAIA9C,WAAW+C,eAAeD,SAoBnCF,sBAAsBP,iBAAkBW,oBAE9BF,QAAU,GAEVG,IAAM,OAGP,MAAOC,IAAKC,YAAaC,OAAOC,QAAQL,cAErCM,MAAMC,QAAQJ,WACdF,IAAIC,KAAO,GACXC,SAAS5E,SAAQjC,kBACMG,IAAfH,QAAQqC,SACF6E,sBAAeN,sCAEzBJ,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,WACRC,OAAQrH,gBAENsH,MAAQC,OAAOvH,QAAQqC,IAAImF,UACjCb,IAAIC,KAAKU,QAAS,MAGtBd,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,WACRC,OAAQR,eAKf,MAAOD,IAAKa,YAAaX,OAAOC,QAAQhB,kBAAmB,KACxD2B,aAAc,UAEQvH,IAAtBuG,aAAaE,OACbc,aAAc,GAEdV,MAAMC,QAAQQ,UAAW,KACpBC,kBAA4BvH,IAAbwG,IAAIC,WACdM,sBAAeN,kCAEzBa,SAASxF,SAAQjC,gBACPsH,MAAQC,OAAOvH,QAAQqC,IAAImF,cAC7BG,YAAcD,YAEbC,kBAAmCxH,IAApBwG,IAAIC,KAAKU,SACzBK,aAAc,GAEdA,aACAnB,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,SACRC,OAAQrH,iBAIjB,KACE0H,kBAA4BvH,IAAbwG,IAAIC,WACdM,uBAAgBN,iCAEtBc,aACAlB,QAAQW,KAAK,CACTxG,KAAMiG,IACNQ,OAAQ,SACRC,OAAQI,mBAMjBjB,QAUXoB,0BACWpG,KAAKoC,UAShBiE,QAAQC,SAAUC,YACT/H,QAAQiG,MAAM+B,cAASD,MAAME,uBAC7BjI,QAAQiG,MAAMiC,eAAUH,MAAMI,mBAMvC7D,kBACSV,WAAapC,KAAKoC,eAClBI,SAASoE,aAAa5G,KAAKoC,WAC5BpC,KAAKoC,eACAyE,cAEAC,OAObD,eAEUE,YAAcC,OAAOC,YAAc,EACnCC,YAAcF,OAAOG,WAAa,EAElC1C,MAAQ,CACV2C,SAAU,QACVC,OAAQ,OACRC,SAAU,OACVC,OAAQ,QACRC,MAAO,QACPhB,cAAQO,YAAc,UACtBL,eAASQ,YAAc,WAE3B5B,OAAOmC,OAAOzH,KAAKxB,QAAQiG,MAAOA,YAE7B1E,WAAWC,KAAKzB,UAAUsD,OAAO4C,MAAM8C,OAAS,YAChDxH,WAAWC,KAAKzB,UAAUgB,KAAKkF,MAAM8C,OAAS,YAE9C5E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAM1D+E,OACkB,CACV,WACA,SACA,WACA,MACA,OACA,SACA,SAEErG,SACFiH,MAAQ1H,KAAKxB,QAAQiG,MAAMkD,eAAeD,aAEzC/E,kBAAkB3C,KAAKD,WAAWC,KAAKzB,UAAUwD,MAQ1DY,kBAAkBnE,UACbA,QAAQyB,UAAWzB,QAAQ0C,QAAQiD,KAAO,CAAC3F,QAAQ0C,QAAQiD,IAAK3F,QAAQyB"}
\ No newline at end of file
diff --git a/lib/amd/src/local/reactive/debugpanel.js b/lib/amd/src/local/reactive/debugpanel.js
index 738ad6bbad385..f9c3c58909ee3 100644
--- a/lib/amd/src/local/reactive/debugpanel.js
+++ b/lib/amd/src/local/reactive/debugpanel.js
@@ -266,7 +266,7 @@ class DebugInstanceSubpanel extends BaseComponent {
this.addEventListener(
this.getElement(this.selectors.STATE),
'keyup',
- debounce(this._checkJSON, 500)
+ debounce(this._checkJSON.bind(this), 500)
);
this.addEventListener(
diff --git a/lib/classes/component.php b/lib/classes/component.php
index e7f3eb4b324ff..0c6063c9ecaaf 100644
--- a/lib/classes/component.php
+++ b/lib/classes/component.php
@@ -390,6 +390,9 @@ protected static function is_cache_valid(array $cache): bool {
$keyclasses = [
\core\exception\moodle_exception::class,
\core\output\bootstrap_renderer::class,
+ \core\lang_string::class,
+ \renderable::class,
+ \core\url::class,
];
foreach ($keyclasses as $classname) {
if (!array_key_exists($classname, $cache['classmap'])) {
@@ -727,14 +730,13 @@ protected static function fill_classmap_cache() {
self::$classmap = [];
self::load_classes('core', "$CFG->dirroot/lib/classes");
- self::load_legacy_classes($CFG->libdir);
+ self::load_legacy_classes($CFG->libdir, true);
foreach (self::$subsystems as $subsystem => $fulldir) {
if (!$fulldir) {
continue;
}
self::load_classes('core_' . $subsystem, "$fulldir/classes");
- self::load_legacy_classes($fulldir);
}
foreach (self::$plugins as $plugintype => $plugins) {
@@ -1448,8 +1450,12 @@ protected static function load_renamed_classes(?string $fulldir) {
* and the value is the path to the class file within the relative ../classes/ directory.
*
* @param string|null $fulldir The directory to the legacy classes.
+ * @param bool $allowsubsystems Whether to allow the specification of alternative subsystems for this path.
*/
- protected static function load_legacy_classes(?string $fulldir): void {
+ protected static function load_legacy_classes(
+ ?string $fulldir,
+ bool $allowsubsystems = false,
+ ): void {
if (is_null($fulldir)) {
return;
}
@@ -1460,7 +1466,32 @@ protected static function load_legacy_classes(?string $fulldir): void {
require($file);
if (is_array($legacyclasses)) {
foreach ($legacyclasses as $classname => $path) {
- self::$classmap[$classname] = "{$fulldir}/classes/{$path}";
+ if (is_array($path)) {
+ if (!$allowsubsystems) {
+ throw new \Exception(
+ "Invalid legacy classes path entry for {$classname}. " .
+ "Only files within the component can be specified.",
+ );
+ }
+ if (count($path) !== 2) {
+ throw new \Exception(
+ "Invalid legacy classes path entry for {$classname}. " .
+ "Entries must be in the format [subsystem, path].",
+ );
+ }
+ [$subsystem, $path] = $path;
+ $subsystem = substr($subsystem, 5);
+ if (!array_key_exists($subsystem, self::$subsystems)) {
+ throw new \Exception(
+ "Unknown subsystem '{$subsystem}' for legacy classes entry of '{$classname}'",
+ );
+ }
+
+ $subsystemfulldir = self::$subsystems[$subsystem];
+ self::$classmap[$classname] = "{$subsystemfulldir}/classes/{$path}";
+ } else {
+ self::$classmap[$classname] = "{$fulldir}/classes/{$path}";
+ }
}
}
}
diff --git a/lib/classes/emoticon_manager.php b/lib/classes/emoticon_manager.php
new file mode 100644
index 0000000000000..44351c022bd2d
--- /dev/null
+++ b/lib/classes/emoticon_manager.php
@@ -0,0 +1,191 @@
+.
+
+namespace core;
+
+use pix_emoticon;
+use stdClass;
+
+/**
+ * Provides core support for plugins that have to deal with emoticons (like HTML editor or emoticon filter).
+ *
+ * Whenever this manager mentiones 'emoticon object', the following data structure is expected:
+ * stdClass with properties text, imagename, imagecomponent, altidentifier and altcomponent
+ *
+ * @see \admin_setting_emoticons
+ *
+ * @package core
+ * @copyright 2010 David Mudrak
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class emoticon_manager {
+
+ /**
+ * Returns the currently enabled emoticons
+ *
+ * @param bool $selectable If true, only return emoticons that should be selectable from a list
+ * @return stdClass[] array of emoticon objects
+ */
+ public function get_emoticons(
+ bool $selectable = false,
+ ): array {
+ global $CFG;
+
+ $notselectable = ['martin', 'egg'];
+
+ if (empty($CFG->emoticons)) {
+ return [];
+ }
+
+ $emoticons = $this->decode_stored_config($CFG->emoticons);
+
+ if (!is_array($emoticons)) {
+ // Something is wrong with the format of stored setting.
+ debugging('Invalid format of emoticons setting, please resave the emoticons settings form', DEBUG_NORMAL);
+ return [];
+ }
+
+ if ($selectable) {
+ foreach ($emoticons as $index => $emote) {
+ if (in_array($emote->altidentifier, $notselectable)) {
+ // Skip this one.
+ unset($emoticons[$index]);
+ }
+ }
+ }
+
+ return $emoticons;
+ }
+
+ /**
+ * Converts emoticon object into renderable pix_emoticon object
+ *
+ * @param stdClass $emoticon emoticon object
+ * @param array $attributes explicit HTML attributes to set
+ * @return pix_emoticon
+ */
+ public function prepare_renderable_emoticon(
+ stdClass $emoticon,
+ array $attributes = [],
+ ): pix_emoticon {
+ $stringmanager = get_string_manager();
+ if ($stringmanager->string_exists($emoticon->altidentifier, $emoticon->altcomponent)) {
+ $alt = get_string($emoticon->altidentifier, $emoticon->altcomponent);
+ } else {
+ $alt = s($emoticon->text);
+ }
+ return new pix_emoticon($emoticon->imagename, $alt, $emoticon->imagecomponent, $attributes);
+ }
+
+ /**
+ * Encodes the array of emoticon objects into a string storable in config table
+ *
+ * @param stdClass[] $emoticons array of emoticon objects
+ * @return string
+ */
+ public function encode_stored_config(
+ array $emoticons,
+ ): string {
+ return json_encode($emoticons);
+ }
+
+ /**
+ * Decodes the string into an array of emoticon objects
+ *
+ * @param string $encoded
+ * @return ?array
+ */
+ public function decode_stored_config(
+ string $encoded,
+ ): ?array {
+ $decoded = json_decode($encoded);
+ if (!is_array($decoded)) {
+ return null;
+ }
+ return $decoded;
+ }
+
+ /**
+ * Returns default set of emoticons supported by Moodle
+ *
+ * @return stdClass[] array of emoticon objects
+ */
+ public function default_emoticons(): array {
+ return [
+ $this->prepare_emoticon_object(":-)", 's/smiley', 'smiley'),
+ $this->prepare_emoticon_object(":)", 's/smiley', 'smiley'),
+ $this->prepare_emoticon_object(":-D", 's/biggrin', 'biggrin'),
+ $this->prepare_emoticon_object(";-)", 's/wink', 'wink'),
+ $this->prepare_emoticon_object(":-/", 's/mixed', 'mixed'),
+ $this->prepare_emoticon_object("V-.", 's/thoughtful', 'thoughtful'),
+ $this->prepare_emoticon_object(":-P", 's/tongueout', 'tongueout'),
+ $this->prepare_emoticon_object(":-p", 's/tongueout', 'tongueout'),
+ $this->prepare_emoticon_object("B-)", 's/cool', 'cool'),
+ $this->prepare_emoticon_object("^-)", 's/approve', 'approve'),
+ $this->prepare_emoticon_object("8-)", 's/wideeyes', 'wideeyes'),
+ $this->prepare_emoticon_object(":o)", 's/clown', 'clown'),
+ $this->prepare_emoticon_object(":-(", 's/sad', 'sad'),
+ $this->prepare_emoticon_object(":(", 's/sad', 'sad'),
+ $this->prepare_emoticon_object("8-.", 's/shy', 'shy'),
+ $this->prepare_emoticon_object(":-I", 's/blush', 'blush'),
+ $this->prepare_emoticon_object(":-X", 's/kiss', 'kiss'),
+ $this->prepare_emoticon_object("8-o", 's/surprise', 'surprise'),
+ $this->prepare_emoticon_object("P-|", 's/blackeye', 'blackeye'),
+ $this->prepare_emoticon_object("8-[", 's/angry', 'angry'),
+ $this->prepare_emoticon_object("(grr)", 's/angry', 'angry'),
+ $this->prepare_emoticon_object("xx-P", 's/dead', 'dead'),
+ $this->prepare_emoticon_object("|-.", 's/sleepy', 'sleepy'),
+ $this->prepare_emoticon_object("}-]", 's/evil', 'evil'),
+ $this->prepare_emoticon_object("(h)", 's/heart', 'heart'),
+ $this->prepare_emoticon_object("(heart)", 's/heart', 'heart'),
+ $this->prepare_emoticon_object("(y)", 's/yes', 'yes', 'core'),
+ $this->prepare_emoticon_object("(n)", 's/no', 'no', 'core'),
+ $this->prepare_emoticon_object("(martin)", 's/martin', 'martin'),
+ $this->prepare_emoticon_object("( )", 's/egg', 'egg'),
+ ];
+ }
+
+ /**
+ * Helper method preparing an emoticon object
+ *
+ * @param string|string[] $text
+ * @param string $imagename to be used by {@see pix_emoticon}
+ * @param ?string $altidentifier alternative string identifier, null for no alt
+ * @param string $altcomponent where the alternative string is defined
+ * @param string $imagecomponent to be used by {@see pix_emoticon}
+ * @return stdClass
+ */
+ protected function prepare_emoticon_object(
+ string|array $text,
+ string $imagename,
+ ?string $altidentifier = null,
+ string $altcomponent = 'core_pix',
+ string $imagecomponent = 'core',
+ ): stdClass {
+ return (object) [
+ 'text' => $text,
+ 'imagename' => $imagename,
+ 'altidentifier' => $altidentifier,
+ 'altcomponent' => $altcomponent,
+ 'imagecomponent' => $imagecomponent,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(emoticon_manager::class, \emoticon_manager::class);
diff --git a/lib/classes/hook/navigation/secondary_extend.php b/lib/classes/hook/navigation/secondary_extend.php
new file mode 100644
index 0000000000000..ea25c2d14f6ad
--- /dev/null
+++ b/lib/classes/hook/navigation/secondary_extend.php
@@ -0,0 +1,55 @@
+.
+
+namespace core\hook\navigation;
+use core\hook\stoppable_trait;
+use core\navigation\views\secondary;
+
+/**
+ * Allows plugins to insert nodes into site secondary navigation
+ *
+ * @package core
+ * @author Sumaiya Javed
+ * @copyright 2024 Catalyst IT
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins to insert nodes into site secondary navigation')]
+#[\core\attribute\tags('navigation')]
+final class secondary_extend {
+ use stoppable_trait;
+
+ /**
+ * Creates new hook.
+ *
+ * @param secondary $secondaryview secondary navigation view
+ */
+ public function __construct(
+ /**
+ * @var secondary $secondaryview secondary navigation view
+ */
+ public readonly secondary $secondaryview,
+ ) {
+ }
+
+ /**
+ * secondary navigation view
+ *
+ * @return secondary
+ */
+ public function get_secondaryview(): secondary {
+ return $this->secondaryview;
+ }
+}
diff --git a/lib/classes/lang_string.php b/lib/classes/lang_string.php
new file mode 100644
index 0000000000000..5f09a9b5cb86d
--- /dev/null
+++ b/lib/classes/lang_string.php
@@ -0,0 +1,280 @@
+.
+
+namespace core;
+
+use core\exception\coding_exception;
+use stdClass;
+
+/**
+ * The lang_string class
+ *
+ * This special class is used to create an object representation of a string request.
+ * It is special because processing doesn't occur until the object is first used.
+ * The class was created especially to aid performance in areas where strings were
+ * required to be generated but were not necessarily used.
+ * As an example the admin tree when generated uses over 1500 strings, of which
+ * normally only 1/3 are ever actually printed at any time.
+ * The performance advantage is achieved by not actually processing strings that
+ * aren't being used, as such reducing the processing required for the page.
+ *
+ * How to use the lang_string class?
+ * There are two methods of using the lang_string class, first through the
+ * forth argument of the get_string function, and secondly directly.
+ * The following are examples of both.
+ * 1. Through get_string calls e.g.
+ * $string = get_string($identifier, $component, $a, true);
+ * $string = get_string('yes', 'moodle', null, true);
+ * 2. Direct instantiation
+ * $string = new lang_string($identifier, $component, $a, $lang);
+ * $string = new lang_string('yes');
+ *
+ * How do I use a lang_string object?
+ * The lang_string object makes use of a magic __toString method so that you
+ * are able to use the object exactly as you would use a string in most cases.
+ * This means you are able to collect it into a variable and then directly
+ * echo it, or concatenate it into another string, or similar.
+ * The other thing you can do is manually get the string by calling the
+ * lang_strings out method e.g.
+ * $string = new lang_string('yes');
+ * $string->out();
+ * Also worth noting is that the out method can take one argument, $lang which
+ * allows the developer to change the language on the fly.
+ *
+ * When should I use a lang_string object?
+ * The lang_string object is designed to be used in any situation where a
+ * string may not be needed, but needs to be generated.
+ * The admin tree is a good example of where lang_string objects should be
+ * used.
+ * A more practical example would be any class that requires strings that may
+ * not be printed (after all classes get rendered by renderers and who knows
+ * what they will do ;))
+ *
+ * When should I not use a lang_string object?
+ * Don't use lang_strings when you are going to use a string immediately.
+ * There is no need as it will be processed immediately and there will be no
+ * advantage, and in fact perhaps a negative hit as a class has to be
+ * instantiated for a lang_string object, however get_string won't require
+ * that.
+ *
+ * Limitations:
+ * 1. You cannot use a lang_string object as an array offset. Doing so will
+ * result in PHP throwing an error. (You can use it as an object property!)
+ *
+ * @package core
+ * @copyright 2011 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class lang_string {
+
+ /** @var string The strings component. Default '' */
+ protected ?string $component = '';
+
+ /** @var array|stdClass Any arguments required for the string. Default null */
+ protected mixed $a = null;
+
+ /** @var string The processed string (once processed) */
+ protected ?string $string = null;
+
+ /**
+ * A special boolean. If set to true then the object has been woken up and
+ * cannot be regenerated. If this is set then $this->string MUST be used.
+ * @var bool
+ */
+ protected bool $forcedstring = false;
+
+ /**
+ * Constructs a lang_string object
+ *
+ * This function should do as little processing as possible to ensure the best
+ * performance for strings that won't be used.
+ *
+ * @param string $identifier The strings identifier
+ * @param string|null $component The strings component
+ * @param mixed $a Any arguments the string requires
+ * @param string|null $lang The language to use when processing the string.
+ * @throws coding_exception
+ */
+ public function __construct(
+ /** @var string The strings identifier */
+ protected readonly string $identifier,
+ ?string $component = '',
+ mixed $a = null,
+ /** @var string The language to use when processing the string*/
+ protected readonly ?string $lang = null,
+ ) {
+ if (empty($component)) {
+ $component = 'moodle';
+ }
+
+ $this->component = $component;
+
+ // We MUST duplicate $a to ensure that it if it changes by reference those
+ // changes are not carried across.
+ // To do this we always ensure $a or its properties/values are strings
+ // and that any properties/values that arn't convertable are forgotten.
+ if ($a !== null) {
+ if (is_scalar($a)) {
+ $this->a = $a;
+ } else if ($a instanceof lang_string) {
+ $this->a = $a->out();
+ } else if (is_object($a) || is_array($a)) {
+ $a = (array)$a;
+ $this->a = [];
+ foreach ($a as $key => $value) {
+ // Make sure conversion errors don't get displayed (results in '').
+ if (is_array($value)) {
+ $this->a[$key] = '';
+ } else if (is_object($value)) {
+ if (method_exists($value, '__toString')) {
+ $this->a[$key] = $value->__toString();
+ } else {
+ $this->a[$key] = '';
+ }
+ } else {
+ $this->a[$key] = (string)$value;
+ }
+ }
+ }
+ }
+
+ if (debugging(false, DEBUG_DEVELOPER)) {
+ if (clean_param($this->identifier, PARAM_STRINGID) == '') {
+ throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of ' .
+ 'the string identifier. Please check your string definition');
+ }
+ if (!empty($this->component) && clean_param($this->component, PARAM_COMPONENT) == '') {
+ throw new coding_exception('Invalid string compontent. Please check your string definition');
+ }
+ if (!get_string_manager()->string_exists($this->identifier, $this->component)) {
+ debugging('String does not exist. Please check your string definition for '.$this->identifier.'/'.$this->component,
+ DEBUG_DEVELOPER);
+ }
+ }
+ }
+
+ /**
+ * Processes the string.
+ *
+ * This function actually processes the string, stores it in the string property
+ * and then returns it.
+ * You will notice that this function is VERY similar to the get_string method.
+ * That is because it is pretty much doing the same thing.
+ * However as this function is an upgrade it isn't as tolerant to backwards
+ * compatibility.
+ *
+ * @return string
+ * @throws coding_exception
+ */
+ protected function get_string(): string {
+ global $CFG;
+
+ // Check if we need to process the string.
+ if ($this->string === null) {
+ // Check the quality of the identifier.
+ if ($CFG->debugdeveloper && clean_param($this->identifier, PARAM_STRINGID) === '') {
+ throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of ' .
+ 'the string identifier. Please check your string definition', DEBUG_DEVELOPER);
+ }
+
+ // Process the string.
+ $this->string = get_string_manager()->get_string($this->identifier, $this->component, $this->a, $this->lang);
+ // Debugging feature lets you display string identifier and component.
+ if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
+ $this->string .= ' {' . $this->identifier . '/' . $this->component . '}';
+ }
+ }
+ // Return the string.
+ return $this->string;
+ }
+
+ /**
+ * Returns the string
+ *
+ * @param string $lang The langauge to use when processing the string
+ * @return string
+ */
+ public function out($lang = null): string {
+ if ($lang !== null && $lang != $this->lang && ($this->lang == null && $lang != current_language())) {
+ if ($this->forcedstring) {
+ debugging('lang_string objects that have been used cannot be printed in another language. ('.$this->lang.' used)',
+ DEBUG_DEVELOPER);
+ return $this->get_string();
+ }
+ $translatedstring = new lang_string($this->identifier, $this->component, $this->a, $lang);
+ return $translatedstring->out();
+ }
+ return $this->get_string();
+ }
+
+ /**
+ * Magic __toString method for printing a string
+ *
+ * @return string
+ */
+ public function __toString() {
+ return $this->get_string();
+ }
+
+ /**
+ * Magic __set_state method used for var_export
+ *
+ * @param array $array
+ * @return self
+ */
+ public static function __set_state(array $array): self {
+ $tmp = new lang_string($array['identifier'], $array['component'], $array['a'], $array['lang']);
+ $tmp->string = $array['string'];
+ $tmp->forcedstring = $array['forcedstring'];
+ return $tmp;
+ }
+
+ /**
+ * Prepares the lang_string for sleep and stores only the forcedstring and
+ * string properties... the string cannot be regenerated so we need to ensure
+ * it is generated for this.
+ *
+ * @return array
+ */
+ public function __sleep() {
+ $this->get_string();
+ $this->forcedstring = true;
+ return ['forcedstring', 'string', 'lang'];
+ }
+
+ /**
+ * Returns the identifier.
+ *
+ * @return string
+ */
+ public function get_identifier(): string {
+ return $this->identifier;
+ }
+
+ /**
+ * Returns the component.
+ *
+ * @return string
+ */
+ public function get_component(): string {
+ return $this->component;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(lang_string::class, \lang_string::class);
diff --git a/lib/classes/navigation/views/secondary.php b/lib/classes/navigation/views/secondary.php
index d9461681165a4..431af85d37d19 100644
--- a/lib/classes/navigation/views/secondary.php
+++ b/lib/classes/navigation/views/secondary.php
@@ -432,6 +432,10 @@ protected function load_course_navigation(?navigation_node $rootnode = null): vo
self::TYPE_COURSE, null, 'coursehome'), reset($nodekeys)
);
}
+
+ // Allow plugins to add nodes to the secondary navigation.
+ $hook = new \core\hook\navigation\secondary_extend($this);
+ \core\di::get(\core\hook\manager::class)->dispatch($hook);
}
/**
diff --git a/lib/classes/output/action_link.php b/lib/classes/output/action_link.php
new file mode 100644
index 0000000000000..c34d69ef17a8e
--- /dev/null
+++ b/lib/classes/output/action_link.php
@@ -0,0 +1,168 @@
+.
+
+namespace core\output;
+
+use core\output\actions\component_action;
+use moodle_url;
+use stdClass;
+
+/**
+ * Data structure describing html link with special action attached.
+ *
+ * @copyright 2010 Petr Skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class action_link implements renderable {
+ /**
+ * @var moodle_url Href url
+ */
+ public $url;
+
+ /**
+ * @var string Link text HTML fragment
+ */
+ public $text;
+
+ /**
+ * @var array HTML attributes
+ */
+ public $attributes;
+
+ /**
+ * @var array List of actions attached to link
+ */
+ public $actions;
+
+ /**
+ * @var pix_icon Optional pix icon to render with the link
+ */
+ public $icon;
+
+ /**
+ * Constructor
+ * @param moodle_url $url
+ * @param string $text HTML fragment
+ * @param null|component_action $action
+ * @param null|array $attributes associative array of html link attributes + disabled
+ * @param null|pix_icon $icon optional pix_icon to render with the link text
+ */
+ public function __construct(
+ moodle_url $url,
+ $text,
+ ?component_action $action = null,
+ ?array $attributes = null,
+ ?pix_icon $icon = null
+ ) {
+ $this->url = clone($url);
+ $this->text = $text;
+ if (empty($attributes['id'])) {
+ $attributes['id'] = html_writer::random_id('action_link');
+ }
+ $this->attributes = (array)$attributes;
+ if ($action) {
+ $this->add_action($action);
+ }
+ $this->icon = $icon;
+ }
+
+ /**
+ * Add action to the link.
+ *
+ * @param component_action $action
+ */
+ public function add_action(component_action $action) {
+ $this->actions[] = $action;
+ }
+
+ /**
+ * Adds a CSS class to this action link object
+ * @param string $class
+ */
+ public function add_class($class) {
+ if (empty($this->attributes['class'])) {
+ $this->attributes['class'] = $class;
+ } else {
+ $this->attributes['class'] .= ' ' . $class;
+ }
+ }
+
+ /**
+ * Returns true if the specified class has been added to this link.
+ * @param string $class
+ * @return bool
+ */
+ public function has_class($class) {
+ return strpos(' ' . $this->attributes['class'] . ' ', ' ' . $class . ' ') !== false;
+ }
+
+ /**
+ * Return the rendered HTML for the icon. Useful for rendering action links in a template.
+ * @return string
+ */
+ public function get_icon_html() {
+ global $OUTPUT;
+ if (!$this->icon) {
+ return '';
+ }
+ return $OUTPUT->render($this->icon);
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $data = new stdClass();
+ $attributes = $this->attributes;
+
+ $data->id = $attributes['id'];
+ unset($attributes['id']);
+
+ $data->disabled = !empty($attributes['disabled']);
+ unset($attributes['disabled']);
+
+ $data->text = $this->text instanceof renderable ? $output->render($this->text) : (string) $this->text;
+ $data->url = $this->url ? $this->url->out(false) : '';
+ $data->icon = $this->icon ? $this->icon->export_for_pix() : null;
+ $data->classes = isset($attributes['class']) ? $attributes['class'] : '';
+ unset($attributes['class']);
+
+ $data->attributes = array_map(function ($key, $value) {
+ return [
+ 'name' => $key,
+ 'value' => $value,
+ ];
+ }, array_keys($attributes), $attributes);
+
+ $data->actions = array_map(function ($action) use ($output) {
+ return $action->export_for_template($output);
+ }, !empty($this->actions) ? $this->actions : []);
+ $data->hasactions = !empty($this->actions);
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(action_link::class, \action_link::class);
diff --git a/lib/classes/output/action_menu.php b/lib/classes/output/action_menu.php
new file mode 100644
index 0000000000000..261054f1f9665
--- /dev/null
+++ b/lib/classes/output/action_menu.php
@@ -0,0 +1,681 @@
+.
+
+namespace core\output;
+
+use core\exception\coding_exception;
+use core\lang_string;
+use core\output\local\action_menu\subpanel;
+use core\output\action_menu\link as action_menu_link;
+use core\output\action_menu\filler as action_menu_filler;
+use moodle_page;
+use stdClass;
+
+/**
+ * An action menu.
+ *
+ * This action menu component takes a series of primary and secondary actions.
+ * The primary actions are displayed permanently and the secondary attributes are displayed within a drop
+ * down menu.
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class action_menu implements renderable, templatable {
+ /**
+ * Top right alignment.
+ */
+ const TL = 1;
+
+ /**
+ * Top right alignment.
+ */
+ const TR = 2;
+
+ /**
+ * Top right alignment.
+ */
+ const BL = 3;
+
+ /**
+ * Top right alignment.
+ */
+ const BR = 4;
+
+ /**
+ * The instance number. This is unique to this instance of the action menu.
+ * @var int
+ */
+ protected $instance = 0;
+
+ /**
+ * An array of primary actions. Please use {@see action_menu::add_primary_action()} to add actions.
+ * @var array
+ */
+ protected $primaryactions = [];
+
+ /**
+ * An array of secondary actions. Please use {@see action_menu::add_secondary_action()} to add actions.
+ * @var array
+ */
+ protected $secondaryactions = [];
+
+ /**
+ * An array of attributes added to the container of the action menu.
+ * Initialised with defaults during construction.
+ * @var array
+ */
+ public $attributes = [];
+ /**
+ * An array of attributes added to the container of the primary actions.
+ * Initialised with defaults during construction.
+ * @var array
+ */
+ public $attributesprimary = [];
+ /**
+ * An array of attributes added to the container of the secondary actions.
+ * Initialised with defaults during construction.
+ * @var array
+ */
+ public $attributessecondary = [];
+
+ /**
+ * The string to use next to the icon for the action icon relating to the secondary (dropdown) menu.
+ * @var array
+ */
+ public $actiontext = null;
+
+ /**
+ * The string to use for the accessible label for the menu.
+ * @var array
+ */
+ public $actionlabel = null;
+
+ /**
+ * An icon to use for the toggling the secondary menu (dropdown).
+ * @var pix_icon
+ */
+ public $actionicon;
+
+ /**
+ * Any text to use for the toggling the secondary menu (dropdown).
+ * @var string
+ */
+ public $menutrigger = '';
+
+ /**
+ * An array of attributes added to the trigger element of the secondary menu.
+ * @var array
+ */
+ public $triggerattributes = [];
+
+ /**
+ * Any extra classes for toggling to the secondary menu.
+ * @var string
+ */
+ public $triggerextraclasses = '';
+
+ /**
+ * Place the action menu before all other actions.
+ * @var bool
+ */
+ public $prioritise = false;
+
+ /**
+ * Dropdown menu alignment class.
+ * @var string
+ */
+ public $dropdownalignment = '';
+
+ /**
+ * Constructs the action menu with the given items.
+ *
+ * @param array $actions An array of actions (action_menu_link|pix_icon|string).
+ */
+ public function __construct(array $actions = []) {
+ static $initialised = 0;
+ $this->instance = $initialised;
+ $initialised++;
+
+ $this->attributes = [
+ 'id' => 'action-menu-' . $this->instance,
+ 'class' => 'moodle-actionmenu',
+ 'data-enhance' => 'moodle-core-actionmenu',
+ ];
+ $this->attributesprimary = [
+ 'id' => 'action-menu-' . $this->instance . '-menubar',
+ 'class' => 'menubar',
+ ];
+ $this->attributessecondary = [
+ 'id' => 'action-menu-' . $this->instance . '-menu',
+ 'class' => 'menu',
+ 'data-rel' => 'menu-content',
+ 'aria-labelledby' => 'action-menu-toggle-' . $this->instance,
+ 'role' => 'menu',
+ ];
+ $this->dropdownalignment = 'dropdown-menu-right';
+ foreach ($actions as $action) {
+ $this->add($action);
+ }
+ }
+
+ /**
+ * Sets the label for the menu trigger.
+ *
+ * @param string $label The text
+ */
+ public function set_action_label($label) {
+ $this->actionlabel = $label;
+ }
+
+ /**
+ * Sets the menu trigger text.
+ *
+ * @param string $trigger The text
+ * @param string $extraclasses Extra classes to style the secondary menu toggle.
+ */
+ public function set_menu_trigger($trigger, $extraclasses = '') {
+ $this->menutrigger = $trigger;
+ $this->triggerextraclasses = $extraclasses;
+ }
+
+ /**
+ * Classes for the trigger menu
+ */
+ const DEFAULT_KEBAB_TRIGGER_CLASSES = 'btn btn-icon d-flex align-items-center justify-content-center no-caret';
+
+ /**
+ * Setup trigger as in the kebab menu.
+ *
+ * @param string|null $triggername
+ * @param core_renderer|null $output
+ * @param string|null $extraclasses extra classes for the trigger {@see self::set_menu_trigger()}
+ * @throws coding_exception
+ */
+ public function set_kebab_trigger(
+ ?string $triggername = null,
+ ?core_renderer $output = null,
+ ?string $extraclasses = ''
+ ) {
+ global $OUTPUT;
+ if (empty($output)) {
+ $output = $OUTPUT;
+ }
+ $label = $triggername ?? get_string('actions');
+ $triggerclasses = self::DEFAULT_KEBAB_TRIGGER_CLASSES . ' ' . $extraclasses;
+ $icon = $output->pix_icon('i/menu', $label);
+ $this->set_menu_trigger($icon, $triggerclasses);
+ }
+
+ /**
+ * Return true if there is at least one visible link in the menu.
+ *
+ * @return bool
+ */
+ public function is_empty() {
+ return !count($this->primaryactions) && !count($this->secondaryactions);
+ }
+
+ /**
+ * Initialises JS required fore the action menu.
+ * The JS is only required once as it manages all action menu's on the page.
+ *
+ * @param moodle_page $page
+ */
+ public function initialise_js(moodle_page $page) {
+ static $initialised = false;
+ if (!$initialised) {
+ $page->requires->yui_module('moodle-core-actionmenu', 'M.core.actionmenu.init');
+ $initialised = true;
+ }
+ }
+
+ /**
+ * Adds an action to this action menu.
+ *
+ * @param action_link|pix_icon|subpanel|string $action
+ */
+ public function add($action) {
+
+ if ($action instanceof subpanel) {
+ $this->add_secondary_subpanel($action);
+ } else if ($action instanceof action_link) {
+ if ($action->primary) {
+ $this->add_primary_action($action);
+ } else {
+ $this->add_secondary_action($action);
+ }
+ } else if ($action instanceof pix_icon) {
+ $this->add_primary_action($action);
+ } else {
+ $this->add_secondary_action($action);
+ }
+ }
+
+ /**
+ * Adds a secondary subpanel.
+ * @param subpanel $subpanel
+ */
+ public function add_secondary_subpanel(subpanel $subpanel) {
+ $this->secondaryactions[] = $subpanel;
+ }
+
+ /**
+ * Adds a primary action to the action menu.
+ *
+ * @param action_menu_link|action_link|pix_icon|string $action
+ */
+ public function add_primary_action($action) {
+ if ($action instanceof action_link || $action instanceof pix_icon) {
+ $action->attributes['role'] = 'menuitem';
+ $action->attributes['tabindex'] = '-1';
+ if ($action instanceof action_menu_link) {
+ $action->actionmenu = $this;
+ }
+ }
+ $this->primaryactions[] = $action;
+ }
+
+ /**
+ * Adds a secondary action to the action menu.
+ *
+ * @param action_link|pix_icon|string $action
+ */
+ public function add_secondary_action($action) {
+ if ($action instanceof action_link || $action instanceof pix_icon) {
+ $action->attributes['role'] = 'menuitem';
+ $action->attributes['tabindex'] = '-1';
+ if ($action instanceof action_menu_link) {
+ $action->actionmenu = $this;
+ }
+ }
+ $this->secondaryactions[] = $action;
+ }
+
+ /**
+ * Returns the primary actions ready to be rendered.
+ *
+ * @param null|core_renderer $output The renderer to use for getting icons.
+ * @return array
+ */
+ public function get_primary_actions(?core_renderer $output = null) {
+ global $OUTPUT;
+ if ($output === null) {
+ $output = $OUTPUT;
+ }
+ $pixicon = $this->actionicon;
+ $linkclasses = ['toggle-display'];
+
+ $title = '';
+ if (!empty($this->menutrigger)) {
+ $pixicon = '';
+ $linkclasses[] = 'textmenu';
+ } else {
+ $title = new lang_string('actionsmenu', 'moodle');
+ $this->actionicon = new pix_icon(
+ 't/edit_menu',
+ '',
+ 'moodle',
+ ['class' => 'iconsmall actionmenu', 'title' => '']
+ );
+ $pixicon = $this->actionicon;
+ }
+ if ($pixicon instanceof renderable) {
+ $pixicon = $output->render($pixicon);
+ if ($pixicon instanceof pix_icon && isset($pixicon->attributes['alt'])) {
+ $title = $pixicon->attributes['alt'];
+ }
+ }
+ $string = '';
+ if ($this->actiontext) {
+ $string = $this->actiontext;
+ }
+ $label = '';
+ if ($this->actionlabel) {
+ $label = $this->actionlabel;
+ } else {
+ $label = $title;
+ }
+ $actions = $this->primaryactions;
+ $attributes = [
+ 'class' => implode(' ', $linkclasses),
+ 'title' => $title,
+ 'aria-label' => $label,
+ 'id' => 'action-menu-toggle-' . $this->instance,
+ 'role' => 'menuitem',
+ 'tabindex' => '-1',
+ ];
+ $link = html_writer::link('#', $string . $this->menutrigger . $pixicon, $attributes);
+ if ($this->prioritise) {
+ array_unshift($actions, $link);
+ } else {
+ $actions[] = $link;
+ }
+ return $actions;
+ }
+
+ /**
+ * Returns the secondary actions ready to be rendered.
+ * @return array
+ */
+ public function get_secondary_actions() {
+ return $this->secondaryactions;
+ }
+
+ /**
+ * Sets the selector that should be used to find the owning node of this menu.
+ * @param string $selector A CSS/YUI selector to identify the owner of the menu.
+ */
+ public function set_owner_selector($selector) {
+ $this->attributes['data-owner'] = $selector;
+ }
+
+ /**
+ * Sets the alignment of the dialogue in relation to button used to toggle it.
+ *
+ * @deprecated since Moodle 4.0
+ *
+ * @param int $dialogue One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
+ * @param int $button One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
+ */
+ public function set_alignment($dialogue, $button) {
+ debugging('The method action_menu::set_alignment() is deprecated, use action_menu::set_menu_left()', DEBUG_DEVELOPER);
+ if (isset($this->attributessecondary['data-align'])) {
+ // We've already got one set, lets remove the old class so as to avoid troubles.
+ $class = $this->attributessecondary['class'];
+ $search = 'align-' . $this->attributessecondary['data-align'];
+ $this->attributessecondary['class'] = str_replace($search, '', $class);
+ }
+ $align = $this->get_align_string($dialogue) . '-' . $this->get_align_string($button);
+ $this->attributessecondary['data-align'] = $align;
+ $this->attributessecondary['class'] .= ' align-' . $align;
+ }
+
+ /**
+ * Returns a string to describe the alignment.
+ *
+ * @param int $align One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
+ * @return string
+ */
+ protected function get_align_string($align) {
+ switch ($align) {
+ case self::TL:
+ return 'tl';
+ case self::TR:
+ return 'tr';
+ case self::BL:
+ return 'bl';
+ case self::BR:
+ return 'br';
+ default:
+ return 'tl';
+ }
+ }
+
+ /**
+ * Aligns the left corner of the dropdown.
+ *
+ */
+ public function set_menu_left() {
+ $this->dropdownalignment = 'dropdown-menu-left';
+ }
+
+ /**
+ * Sets a constraint for the dialogue.
+ *
+ * The constraint is applied when the dialogue is shown and limits the display of the dialogue to within the
+ * element the constraint identifies.
+ *
+ * This is required whenever the action menu is displayed inside any CSS element with the .no-overflow class
+ * (flexible_table and any of it's child classes are a likely candidate).
+ *
+ * @deprecated since Moodle 4.3
+ * @param string $ancestorselector A snippet of CSS used to identify the ancestor to contrain the dialogue to.
+ */
+ public function set_constraint($ancestorselector) {
+ debugging('The method set_constraint() is deprecated. Please use the set_boundary() method instead.', DEBUG_DEVELOPER);
+ $this->set_boundary('window');
+ }
+
+ /**
+ * Set the overflow constraint boundary of the dropdown menu.
+ * @see https://getbootstrap.com/docs/4.6/components/dropdowns/#options The 'boundary' option in the Bootstrap documentation
+ *
+ * @param string $boundary Accepts the values of 'viewport', 'window', or 'scrollParent'.
+ * @throws coding_exception
+ */
+ public function set_boundary(string $boundary) {
+ if (!in_array($boundary, ['viewport', 'window', 'scrollParent'])) {
+ throw new coding_exception("HTMLElement reference boundaries are not supported." .
+ "Accepted boundaries are 'viewport', 'window', or 'scrollParent'.", DEBUG_DEVELOPER);
+ }
+
+ $this->triggerattributes['data-boundary'] = $boundary;
+ }
+
+ /**
+ * If you call this method the action menu will be displayed but will not be enhanced.
+ *
+ * By not displaying the menu enhanced all items will be displayed in a single row.
+ *
+ * @deprecated since Moodle 3.2
+ */
+ public function do_not_enhance() {
+ debugging('The method action_menu::do_not_enhance() is deprecated, use a list of action_icon instead.', DEBUG_DEVELOPER);
+ }
+
+ /**
+ * Returns true if this action menu will be enhanced.
+ *
+ * @return bool
+ */
+ public function will_be_enhanced() {
+ return isset($this->attributes['data-enhance']);
+ }
+
+ /**
+ * Sets nowrap on items. If true menu items should not wrap lines if they are longer than the available space.
+ *
+ * This property can be useful when the action menu is displayed within a parent element that is either floated
+ * or relatively positioned.
+ * In that situation the width of the menu is determined by the width of the parent element which may not be large
+ * enough for the menu items without them wrapping.
+ * This disables the wrapping so that the menu takes on the width of the longest item.
+ *
+ * @param bool $value If true nowrap gets set, if false it gets removed. Defaults to true.
+ */
+ public function set_nowrap_on_items($value = true) {
+ $class = 'nowrap-items';
+ if (!empty($this->attributes['class'])) {
+ $pos = strpos($this->attributes['class'], $class);
+ if ($value === true && $pos === false) {
+ // The value is true and the class has not been set yet. Add it.
+ $this->attributes['class'] .= ' ' . $class;
+ } else if ($value === false && $pos !== false) {
+ // The value is false and the class has been set. Remove it.
+ $this->attributes['class'] = substr($this->attributes['class'], $pos, strlen($class));
+ }
+ } else if ($value) {
+ // The value is true and the class has not been set yet. Add it.
+ $this->attributes['class'] = $class;
+ }
+ }
+
+ /**
+ * Add classes to the action menu for an easier styling.
+ *
+ * @param string $class The class to add to attributes.
+ */
+ public function set_additional_classes(string $class = '') {
+ if (!empty($this->attributes['class'])) {
+ $this->attributes['class'] .= " " . $class;
+ } else {
+ $this->attributes['class'] = $class;
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $data = new stdClass();
+ // Assign a role of menubar to this action menu when:
+ // - it contains 2 or more primary actions; or
+ // - if it contains a primary action and secondary actions.
+ if (count($this->primaryactions) > 1 || (!empty($this->primaryactions) && !empty($this->secondaryactions))) {
+ $this->attributes['role'] = 'menubar';
+ }
+ $attributes = $this->attributes;
+
+ $data->instance = $this->instance;
+
+ $data->classes = isset($attributes['class']) ? $attributes['class'] : '';
+ unset($attributes['class']);
+
+ $data->attributes = array_map(function ($key, $value) {
+ return [ 'name' => $key, 'value' => $value ];
+ }, array_keys($attributes), $attributes);
+
+ $data->primary = $this->export_primary_actions_for_template($output);
+ $data->secondary = $this->export_secondary_actions_for_template($output);
+ $data->dropdownalignment = $this->dropdownalignment;
+
+ return $data;
+ }
+
+ /**
+ * Export the primary actions for the template.
+ * @param renderer_base $output
+ * @return stdClass
+ */
+ protected function export_primary_actions_for_template(renderer_base $output): stdClass {
+ $attributes = $this->attributes;
+ $attributesprimary = $this->attributesprimary;
+
+ $primary = new stdClass();
+ $primary->title = '';
+ $primary->prioritise = $this->prioritise;
+
+ $primary->classes = isset($attributesprimary['class']) ? $attributesprimary['class'] : '';
+ unset($attributesprimary['class']);
+
+ $primary->attributes = array_map(function ($key, $value) {
+ return ['name' => $key, 'value' => $value];
+ }, array_keys($attributesprimary), $attributesprimary);
+ $primary->triggerattributes = array_map(function ($key, $value) {
+ return ['name' => $key, 'value' => $value];
+ }, array_keys($this->triggerattributes), $this->triggerattributes);
+
+ $actionicon = $this->actionicon;
+ if (!empty($this->menutrigger)) {
+ $primary->menutrigger = $this->menutrigger;
+ $primary->triggerextraclasses = $this->triggerextraclasses;
+ if ($this->actionlabel) {
+ $primary->title = $this->actionlabel;
+ } else if ($this->actiontext) {
+ $primary->title = $this->actiontext;
+ } else {
+ $primary->title = strip_tags($this->menutrigger);
+ }
+ } else {
+ $primary->title = get_string('actionsmenu');
+ $iconattributes = ['class' => 'iconsmall actionmenu', 'title' => $primary->title];
+ $actionicon = new pix_icon('t/edit_menu', '', 'moodle', $iconattributes);
+ }
+
+ // If the menu trigger is within the menubar, assign a role of menuitem. Otherwise, assign as a button.
+ $primary->triggerrole = 'button';
+ if (isset($attributes['role']) && $attributes['role'] === 'menubar') {
+ $primary->triggerrole = 'menuitem';
+ }
+
+ if ($actionicon instanceof pix_icon) {
+ $primary->icon = $actionicon->export_for_pix();
+ if (!empty($actionicon->attributes['alt'])) {
+ $primary->title = $actionicon->attributes['alt'];
+ }
+ } else {
+ $primary->iconraw = $actionicon ? $output->render($actionicon) : '';
+ }
+
+ $primary->actiontext = $this->actiontext ? (string) $this->actiontext : '';
+ $primary->items = array_map(function ($item) use ($output) {
+ $data = (object) [];
+ if ($item instanceof action_menu_link) {
+ $data->actionmenulink = $item->export_for_template($output);
+ } else if ($item instanceof action_menu_filler) {
+ $data->actionmenufiller = $item->export_for_template($output);
+ } else if ($item instanceof action_link) {
+ $data->actionlink = $item->export_for_template($output);
+ } else if ($item instanceof pix_icon) {
+ $data->pixicon = $item->export_for_template($output);
+ } else {
+ $data->rawhtml = ($item instanceof renderable) ? $output->render($item) : $item;
+ }
+ return $data;
+ }, $this->primaryactions);
+ return $primary;
+ }
+
+ /**
+ * Export the secondary actions for the template.
+ * @param renderer_base $output
+ * @return stdClass
+ */
+ protected function export_secondary_actions_for_template(renderer_base $output): stdClass {
+ $attributessecondary = $this->attributessecondary;
+ $secondary = new stdClass();
+ $secondary->classes = isset($attributessecondary['class']) ? $attributessecondary['class'] : '';
+ unset($attributessecondary['class']);
+
+ $secondary->attributes = array_map(function ($key, $value) {
+ return ['name' => $key, 'value' => $value];
+ }, array_keys($attributessecondary), $attributessecondary);
+ $secondary->items = array_map(function ($item) use ($output) {
+ $data = (object) [
+ 'simpleitem' => true,
+ ];
+ if ($item instanceof action_menu_link) {
+ $data->actionmenulink = $item->export_for_template($output);
+ $data->simpleitem = false;
+ } else if ($item instanceof action_menu_filler) {
+ $data->actionmenufiller = $item->export_for_template($output);
+ $data->simpleitem = false;
+ } else if ($item instanceof subpanel) {
+ $data->subpanel = $item->export_for_template($output);
+ $data->simpleitem = false;
+ } else if ($item instanceof action_link) {
+ $data->actionlink = $item->export_for_template($output);
+ } else if ($item instanceof pix_icon) {
+ $data->pixicon = $item->export_for_template($output);
+ } else {
+ $data->rawhtml = ($item instanceof renderable) ? $output->render($item) : $item;
+ }
+ return $data;
+ }, $this->secondaryactions);
+ return $secondary;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(action_menu::class, \action_menu::class);
diff --git a/lib/classes/output/action_menu/filler.php b/lib/classes/output/action_menu/filler.php
new file mode 100644
index 0000000000000..1d8863ebb87b0
--- /dev/null
+++ b/lib/classes/output/action_menu/filler.php
@@ -0,0 +1,49 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\action_link;
+use core\output\html_writer;
+use core\output\renderable;
+
+/**
+ * An action menu filler
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class filler extends action_link implements renderable {
+ /**
+ * True if this is a primary action. False if not.
+ * @var bool
+ */
+ public $primary = true;
+
+ /**
+ * Constructs the object.
+ */
+ public function __construct() {
+ $this->attributes['id'] = html_writer::random_id('action_link');
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(filler::class, \action_menu_filler::class);
diff --git a/lib/classes/output/action_menu/link.php b/lib/classes/output/action_menu/link.php
new file mode 100644
index 0000000000000..ea6b2da25f2f9
--- /dev/null
+++ b/lib/classes/output/action_menu/link.php
@@ -0,0 +1,120 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\action_menu;
+use core\output\action_link;
+use core\output\pix_icon;
+use core\output\renderable;
+use core\output\renderer_base;
+use moodle_url;
+use stdClass;
+
+/**
+ * An action menu action
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class link extends action_link implements renderable {
+ /**
+ * True if this is a primary action. False if not.
+ * @var bool
+ */
+ public $primary = true;
+
+ /**
+ * The action menu this link has been added to.
+ * @var action_menu
+ */
+ public $actionmenu = null;
+
+ /**
+ * The number of instances of this action menu link (and its subclasses).
+ *
+ * @var int
+ * @deprecated since Moodle 4.4.
+ */
+ protected static $instance = 1;
+
+ /**
+ * Constructs the object.
+ *
+ * @param moodle_url $url The URL for the action.
+ * @param pix_icon|null $icon The icon to represent the action.
+ * @param string $text The text to represent the action.
+ * @param bool $primary Whether this is a primary action or not.
+ * @param array $attributes Any attribtues associated with the action.
+ */
+ public function __construct(moodle_url $url, ?pix_icon $icon, $text, $primary = true, array $attributes = []) {
+ parent::__construct($url, $text, null, $attributes, $icon);
+ $this->primary = (bool)$primary;
+ $this->add_class('menu-action');
+ $this->attributes['role'] = 'menuitem';
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $data = parent::export_for_template($output);
+
+ // Ignore what the parent did with the attributes, except for ID and class.
+ $data->attributes = [];
+ $attributes = $this->attributes;
+ unset($attributes['id']);
+ unset($attributes['class']);
+
+ // Handle text being a renderable.
+ if ($this->text instanceof renderable) {
+ $data->text = $this->render($this->text);
+ }
+
+ $data->showtext = (!$this->icon || $this->primary === false);
+
+ $data->icon = null;
+ if ($this->icon) {
+ $icon = $this->icon;
+ if ($this->primary || !$this->actionmenu->will_be_enhanced()) {
+ $attributes['title'] = $data->text;
+ }
+ $data->icon = $icon ? $icon->export_for_pix() : null;
+ }
+
+ $data->disabled = !empty($attributes['disabled']);
+ unset($attributes['disabled']);
+
+ $data->attributes = array_map(function ($key, $value) {
+ return [
+ 'name' => $key,
+ 'value' => $value,
+ ];
+ }, array_keys($attributes), $attributes);
+
+ return $data;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(link::class, \action_menu_link::class);
diff --git a/lib/classes/output/action_menu/link_primary.php b/lib/classes/output/action_menu/link_primary.php
new file mode 100644
index 0000000000000..c7d314b98ce24
--- /dev/null
+++ b/lib/classes/output/action_menu/link_primary.php
@@ -0,0 +1,47 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\pix_icon;
+use moodle_url;
+
+/**
+ * A primary action menu action
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class link_primary extends link {
+ /**
+ * Constructs the object.
+ *
+ * @param moodle_url $url
+ * @param pix_icon|null $icon
+ * @param string $text
+ * @param array $attributes
+ */
+ public function __construct(moodle_url $url, ?pix_icon $icon, $text, array $attributes = []) {
+ parent::__construct($url, $icon, $text, true, $attributes);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(link_primary::class, \action_menu_link_primary::class);
diff --git a/lib/classes/output/action_menu/link_secondary.php b/lib/classes/output/action_menu/link_secondary.php
new file mode 100644
index 0000000000000..dac7767f2ef58
--- /dev/null
+++ b/lib/classes/output/action_menu/link_secondary.php
@@ -0,0 +1,47 @@
+.
+
+namespace core\output\action_menu;
+
+use core\output\pix_icon;
+use moodle_url;
+
+/**
+ * A secondary action menu action
+ *
+ * @package core
+ * @category output
+ * @copyright 2013 Sam Hemelryk
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class link_secondary extends link {
+ /**
+ * Constructs the object.
+ *
+ * @param moodle_url $url
+ * @param pix_icon|null $icon
+ * @param string $text
+ * @param array $attributes
+ */
+ public function __construct(moodle_url $url, ?pix_icon $icon, $text, array $attributes = []) {
+ parent::__construct($url, $icon, $text, false, $attributes);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(link_secondary::class, \action_menu_link_secondary::class);
diff --git a/lib/classes/output/local/action_menu/subpanel.php b/lib/classes/output/action_menu/subpanel.php
similarity index 86%
rename from lib/classes/output/local/action_menu/subpanel.php
rename to lib/classes/output/action_menu/subpanel.php
index cfcca6d6bb191..94257d2a097d0 100644
--- a/lib/classes/output/local/action_menu/subpanel.php
+++ b/lib/classes/output/action_menu/subpanel.php
@@ -14,17 +14,17 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -80,3 +80,8 @@ public function export_for_template(\renderer_base $output): stdClass {
return $data;
}
}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(subpanel::class, \core\output\local\action_menu\subpanel::class);
diff --git a/lib/classes/output/actions/component_action.php b/lib/classes/output/actions/component_action.php
new file mode 100644
index 0000000000000..e8af7e60dbfc2
--- /dev/null
+++ b/lib/classes/output/actions/component_action.php
@@ -0,0 +1,90 @@
+.
+
+namespace core\output\actions;
+
+use core\exception\coding_exception;
+use core\output\renderer_base;
+use core\output\templatable;
+use stdClass;
+
+/**
+ * Helper class used by other components that involve an action on the page (URL or JS).
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class component_action implements templatable {
+ /**
+ * @var string $event The DOM event that will trigger this action when caught
+ */
+ public $event;
+
+ /**
+ * @var string A function name to call when the button is clicked
+ * The JS function you create must have two arguments:
+ * 1. The event object
+ * 2. An object/array of arguments ($jsfunctionargs)
+ */
+ public $jsfunction = false;
+
+ /**
+ * @var array An array of arguments to pass to the JS function
+ */
+ public $jsfunctionargs = [];
+
+ /**
+ * Constructor
+ * @param string $event DOM event
+ * @param string $jsfunction An optional JS function. Required if jsfunctionargs is given
+ * @param array $jsfunctionargs An array of arguments to pass to the jsfunction
+ */
+ public function __construct($event, $jsfunction, $jsfunctionargs = []) {
+ $this->event = $event;
+
+ $this->jsfunction = $jsfunction;
+ $this->jsfunctionargs = $jsfunctionargs;
+
+ if (!empty($this->jsfunctionargs)) {
+ if (empty($this->jsfunction)) {
+ throw new coding_exception('The component_action object needs a jsfunction value to pass the jsfunctionargs to.');
+ }
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output The renderer.
+ * @return stdClass
+ */
+ public function export_for_template(renderer_base $output) {
+ $args = !empty($this->jsfunctionargs) ? json_encode($this->jsfunctionargs) : false;
+ return (object) [
+ 'event' => $this->event,
+ 'jsfunction' => $this->jsfunction,
+ 'jsfunctionargs' => $args,
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(component_action::class, \component_action::class);
diff --git a/lib/classes/output/actions/confirm_action.php b/lib/classes/output/actions/confirm_action.php
new file mode 100644
index 0000000000000..f18ce1c1fbdcc
--- /dev/null
+++ b/lib/classes/output/actions/confirm_action.php
@@ -0,0 +1,58 @@
+.
+
+namespace core\output\actions;
+
+/**
+ * Confirm action
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class confirm_action extends component_action {
+ /**
+ * Constructs the confirm action object
+ *
+ * @param string $message The message to display to the user when they are shown
+ * the confirm dialogue.
+ * @param string $callback Deprecated since 2.7
+ * @param string $continuelabel The string to use for he continue button
+ * @param string $cancellabel The string to use for the cancel button
+ */
+ public function __construct($message, $callback = null, $continuelabel = null, $cancellabel = null) {
+ if ($callback !== null) {
+ debugging(
+ 'The callback argument to new confirm_action() has been deprecated.' .
+ ' If you need to use a callback, please write Javascript to use moodle-core-notification-confirmation ' .
+ 'and attach to the provided events.',
+ DEBUG_DEVELOPER,
+ );
+ }
+ parent::__construct('click', 'M.util.show_confirm_dialog', [
+ 'message' => $message,
+ 'continuelabel' => $continuelabel,
+ 'cancellabel' => $cancellabel,
+ ]);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(confirm_action::class, \confirm_action::class);
diff --git a/lib/classes/output/actions/popup_action.php b/lib/classes/output/actions/popup_action.php
new file mode 100644
index 0000000000000..9dcd3291f0a98
--- /dev/null
+++ b/lib/classes/output/actions/popup_action.php
@@ -0,0 +1,120 @@
+.
+
+namespace core\output\actions;
+
+use core\exception\coding_exception;
+use moodle_url;
+
+/**
+ * Component action for a popup window.
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class popup_action extends component_action {
+ /**
+ * @var string The JS function to call for the popup
+ */
+ public $jsfunction = 'openpopup';
+
+ /**
+ * @var array An array of parameters that will be passed to the openpopup JS function
+ */
+ public $params = [
+ 'height' => 400,
+ 'width' => 500,
+ 'top' => 0,
+ 'left' => 0,
+ 'menubar' => false,
+ 'location' => false,
+ 'scrollbars' => true,
+ 'resizable' => true,
+ 'toolbar' => true,
+ 'status' => true,
+ 'directories' => false,
+ 'fullscreen' => false,
+ 'dependent' => true,
+ ];
+
+ /**
+ * Constructor
+ *
+ * @param string $event DOM event
+ * @param moodle_url|string $url A moodle_url object, required if no jsfunction is given
+ * @param string $name The JS function to call for the popup (default 'popup')
+ * @param array $params An array of popup parameters
+ */
+ public function __construct($event, $url, $name = 'popup', $params = []) {
+ global $CFG;
+
+ $url = new moodle_url($url);
+
+ if ($name) {
+ $checkname = $name;
+ if (($checkname = preg_replace("/\s/", '_', $checkname)) != $name) {
+ throw new coding_exception(
+ "The {$name} of a popup window shouldn't contain spaces - string modified. {$name} changed to {$checkname}",
+ );
+ $name = $checkname;
+ }
+ } else {
+ $name = 'popup';
+ }
+
+ foreach ($this->params as $var => $val) {
+ if (array_key_exists($var, $params)) {
+ $this->params[$var] = $params[$var];
+ }
+ }
+
+ $attributes = ['url' => $url->out(false), 'name' => $name, 'options' => $this->get_js_options($params)];
+ if (!empty($params['fullscreen'])) {
+ $attributes['fullscreen'] = 1;
+ }
+ parent::__construct($event, $this->jsfunction, $attributes);
+ }
+
+ /**
+ * Returns a string of concatenated option->value pairs used by JS to call the popup window,
+ * based on this object's variables
+ *
+ * @return string String of option->value pairs for JS popup function.
+ */
+ public function get_js_options() {
+ $jsoptions = '';
+
+ foreach ($this->params as $var => $val) {
+ if (is_string($val) || is_int($val)) {
+ $jsoptions .= "$var=$val,";
+ } else if (is_bool($val)) {
+ $jsoptions .= ($val) ? "$var," : "$var=0,";
+ }
+ }
+
+ $jsoptions = substr($jsoptions, 0, strlen($jsoptions) - 1);
+
+ return $jsoptions;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(popup_action::class, \popup_action::class);
diff --git a/lib/classes/output/activity_header.php b/lib/classes/output/activity_header.php
index b2fa9522db1ef..01bfd47093192 100644
--- a/lib/classes/output/activity_header.php
+++ b/lib/classes/output/activity_header.php
@@ -17,8 +17,6 @@
namespace core\output;
use moodle_page;
-use renderer_base;
-use url_select;
/**
* Data structure representing standard components displayed on the activity header.
@@ -31,7 +29,7 @@
* @package core
* @category output
*/
-class activity_header implements \renderable, \templatable {
+class activity_header implements renderable, templatable {
/** @var moodle_page $page The current page we are looking at */
protected $page;
/** @var string $title The title to be displayed in the header. Defaults to activityrecord name. */
@@ -66,8 +64,10 @@ public function __construct(moodle_page $page, \stdClass $user) {
$this->title = format_string($page->activityrecord->name);
}
- if (empty($layoutoptions['nodescription']) && !empty($page->activityrecord->intro) &&
- trim($page->activityrecord->intro)) {
+ if (
+ empty($layoutoptions['nodescription']) && !empty($page->activityrecord->intro) &&
+ trim($page->activityrecord->intro)
+ ) {
$this->description = format_module_intro($this->page->activityname, $page->activityrecord, $page->cm->id);
}
}
diff --git a/lib/classes/output/checkbox_toggleall.php b/lib/classes/output/checkbox_toggleall.php
index 5a900b89101a0..3484de9101587 100644
--- a/lib/classes/output/checkbox_toggleall.php
+++ b/lib/classes/output/checkbox_toggleall.php
@@ -23,12 +23,8 @@
*/
namespace core\output;
-defined('MOODLE_INTERNAL') || die();
-use renderable;
-use renderer_base;
use stdClass;
-use templatable;
/**
* The checkbox-toggleall renderable class.
@@ -38,7 +34,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class checkbox_toggleall implements renderable, templatable {
-
/** @var string The name of the group of checkboxes to be toggled. */
protected $togglegroup;
diff --git a/lib/classes/output/choicelist.php b/lib/classes/output/choicelist.php
index e01d949badb5e..65a47919a541c 100644
--- a/lib/classes/output/choicelist.php
+++ b/lib/classes/output/choicelist.php
@@ -16,10 +16,6 @@
namespace core\output;
-use renderable;
-use renderer_base;
-use core\output\named_templatable;
-
/**
* A generic user choice output class.
*
@@ -30,8 +26,7 @@
* @copyright 2023 Ferran Recio
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class choicelist implements renderable, named_templatable {
-
+class choicelist implements named_templatable, renderable {
/** @var object[] The user choices. */
protected $options = [];
@@ -102,13 +97,13 @@ public function count_options(): int {
* @return \stdClass[]
*/
public function get_selectable_options(): array {
- $selectableOptions = [];
+ $selectableoptions = [];
foreach ($this->options as $option) {
if ($option['value'] !== $this->selected && !$option['disabled']) {
- $selectableOptions[] = (object) $option;
+ $selectableoptions[] = (object) $option;
}
}
- return $selectableOptions;
+ return $selectableoptions;
}
/**
diff --git a/lib/classes/output/chooser.php b/lib/classes/output/chooser.php
index d63831fe4d004..0f7c86df65aa4 100644
--- a/lib/classes/output/chooser.php
+++ b/lib/classes/output/chooser.php
@@ -23,14 +23,10 @@
*/
namespace core\output;
-defined('MOODLE_INTERNAL') || die();
use lang_string;
use moodle_url;
-use renderer_base;
-use renderable;
use stdClass;
-use templatable;
/**
* The chooser renderable class.
@@ -40,7 +36,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class chooser implements renderable, templatable {
-
/** @var moodle_url The form action URL. */
public $actionurl;
/** @var lang_string The instructions to display. */
@@ -85,7 +80,7 @@ public function add_param($name, $value, $id = null) {
$this->params[] = [
'name' => $name,
'value' => $value,
- 'id' => $id
+ 'id' => $id,
];
}
@@ -124,11 +119,10 @@ public function export_for_template(renderer_base $output) {
$data->sesskey = sesskey();
$data->title = (string) $this->title;
- $data->sections = array_map(function($section) use ($output) {
+ $data->sections = array_map(function ($section) use ($output) {
return $section->export_for_template($output);
}, $this->sections);
return $data;
}
-
}
diff --git a/lib/classes/output/chooser_item.php b/lib/classes/output/chooser_item.php
index d6392c52b96af..c90d6f115b881 100644
--- a/lib/classes/output/chooser_item.php
+++ b/lib/classes/output/chooser_item.php
@@ -24,13 +24,9 @@
namespace core\output;
-use coding_exception;
-use context;
-use pix_icon;
-use renderer_base;
-use renderable;
+use core\exception\coding_exception;
+use core\context;
use stdClass;
-use templatable;
/**
* The chooser_item renderable class.
@@ -40,7 +36,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class chooser_item implements renderable, templatable {
-
/** @var string An identifier for the item. */
public $id;
/** @var string The label of this item. */
@@ -93,11 +88,17 @@ public function export_for_template(renderer_base $output) {
$data->description = '';
if (!empty($this->description)) {
- list($data->description) = \core_external\util::format_text((string) $this->description, FORMAT_MARKDOWN,
- $this->context->id, null, null, null, $options);
+ [$data->description] = \core_external\util::format_text(
+ (string) $this->description,
+ FORMAT_MARKDOWN,
+ $this->context->id,
+ null,
+ null,
+ null,
+ $options
+ );
}
return $data;
}
-
}
diff --git a/lib/classes/output/chooser_section.php b/lib/classes/output/chooser_section.php
index ec2f270c33fe4..b4e85d245812b 100644
--- a/lib/classes/output/chooser_section.php
+++ b/lib/classes/output/chooser_section.php
@@ -23,13 +23,9 @@
*/
namespace core\output;
-defined('MOODLE_INTERNAL') || die();
use lang_string;
-use renderer_base;
-use renderable;
use stdClass;
-use templatable;
/**
* The chooser_section renderable class.
@@ -39,7 +35,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class chooser_section implements renderable, templatable {
-
/** @var string $id An identifier for the section. */
public $id;
/** @var lang_string $label The label of the section. */
@@ -70,10 +65,9 @@ public function export_for_template(renderer_base $output) {
$data = new stdClass();
$data->id = $this->id;
$data->label = (string) $this->label;
- $data->items = array_map(function($item) use ($output) {
+ $data->items = array_map(function ($item) use ($output) {
return $item->export_for_template($output);
}, array_values($this->items));
return $data;
}
-
}
diff --git a/lib/classes/output/comboboxsearch.php b/lib/classes/output/comboboxsearch.php
index 0f9a18025339a..f0120c8874a89 100644
--- a/lib/classes/output/comboboxsearch.php
+++ b/lib/classes/output/comboboxsearch.php
@@ -16,20 +16,16 @@
namespace core\output;
-use moodle_exception;
-use renderable;
-use renderer_base;
-use templatable;
+use core\exception\moodle_exception;
/**
* Renderable class for the comboboxsearch.
*
- * @package core_output
+ * @package core
* @copyright 2022 Mathew May
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class comboboxsearch implements renderable, templatable {
-
/** @var bool $renderlater Should the dropdown render straightaway? We sometimes need to output the component without all of the
* data and leave the rendering of any defaults and actual data to the caller. We will give you a basic placeholder that can
* then be easily replaced.*/
@@ -53,7 +49,7 @@ class comboboxsearch implements renderable, templatable {
/** @var null|string $buttonheader If the button item in the tertiary nav needs an extra top header for context. */
protected $buttonheader;
- /** @var boolean $usesbutton Whether to provide a A11y button. */
+ /** @var bool $usesbutton Whether to provide a A11y button. */
protected $usesbutton;
/** @var null|string $label The label of the combobox. */
@@ -99,15 +95,16 @@ public function __construct(
throw new moodle_exception(
'incorrectdropdownvars',
'core',
- '', null,
+ '',
+ null,
'Dropdown content must be set to render later.'
);
}
if ($usebutton && !$label) {
debugging(
- 'You have requested to use the button but have not provided a label for the combobox.',
- DEBUG_DEVELOPER
+ 'You have requested to use the button but have not provided a label for the combobox.',
+ DEBUG_DEVELOPER
);
}
@@ -140,7 +137,7 @@ public function __construct(
public function export_for_template(renderer_base $output): array {
return [
'renderlater' => $this->renderlater,
- 'buttoncontent' => $this->buttoncontent ,
+ 'buttoncontent' => $this->buttoncontent,
'dropdowncontent' => $this->dropdowncontent,
'parentclasses' => $this->parentclasses,
'buttonclasses' => $this->buttonclasses,
diff --git a/lib/classes/output/context_header.php b/lib/classes/output/context_header.php
new file mode 100644
index 0000000000000..b3030ced3afcd
--- /dev/null
+++ b/lib/classes/output/context_header.php
@@ -0,0 +1,151 @@
+.
+
+namespace core\output;
+
+/**
+ * Renderable for the main page header.
+ *
+ * @package core
+ * @category output
+ * @since 2.9
+ * @copyright 2015 Adrian Greeve
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class context_header implements renderable, templatable {
+ /** @var string $heading Main heading */
+ public $heading;
+
+ /** @var int $headinglevel Main heading 'h' tag level */
+ public $headinglevel;
+
+ /** @var string|null $imagedata HTML code for the picture in the page header */
+ public $imagedata;
+
+ /**
+ * @var array $additionalbuttons Additional buttons for the header e.g. Messaging button for the user header.
+ * array elements - title => alternate text for the image, or if no image is available the button text.
+ * url => Link for the button to head to. Should be a moodle_url.
+ * image => location to the image, or name of the image in /pix/t/{image name}.
+ * linkattributes => additional attributes for the element.
+ * page => page object. Don't include if the image is an external image.
+ */
+ public $additionalbuttons;
+
+ /** @var string $prefix A string that is before the title */
+ public $prefix;
+
+ /**
+ * Constructor.
+ *
+ * @param string $heading Main heading data.
+ * @param int $headinglevel Main heading 'h' tag level.
+ * @param string|null $imagedata HTML code for the picture in the page header.
+ * @param string $additionalbuttons Buttons for the header e.g. Messaging button for the user header.
+ * @param string $prefix Text that precedes the heading.
+ */
+ public function __construct($heading = null, $headinglevel = 1, $imagedata = null, $additionalbuttons = null, $prefix = null) {
+ $this->heading = $heading;
+ $this->headinglevel = $headinglevel;
+ $this->imagedata = $imagedata;
+ $this->additionalbuttons = $additionalbuttons;
+ // If we have buttons then format them.
+ if (isset($this->additionalbuttons)) {
+ $this->format_button_images();
+ }
+ $this->prefix = $prefix;
+ }
+
+ /**
+ * Adds an array element for a formatted image.
+ */
+ protected function format_button_images() {
+
+ foreach ($this->additionalbuttons as $buttontype => $button) {
+ $page = $button['page'];
+ // If no image is provided then just use the title.
+ if (!isset($button['image'])) {
+ $this->additionalbuttons[$buttontype]['formattedimage'] = $button['title'];
+ } else {
+ // Check to see if this is an internal Moodle icon.
+ $internalimage = $page->theme->resolve_image_location('t/' . $button['image'], 'moodle');
+ if ($internalimage) {
+ $this->additionalbuttons[$buttontype]['formattedimage'] = 't/' . $button['image'];
+ } else {
+ // Treat as an external image.
+ $this->additionalbuttons[$buttontype]['formattedimage'] = $button['image'];
+ }
+ }
+
+ if (isset($button['linkattributes']['class'])) {
+ $class = $button['linkattributes']['class'] . ' btn';
+ } else {
+ $class = 'btn';
+ }
+ // Add the bootstrap 'btn' class for formatting.
+ $this->additionalbuttons[$buttontype]['linkattributes'] = array_merge(
+ $button['linkattributes'],
+ ['class' => $class]
+ );
+ }
+ }
+
+ /**
+ * Export for template.
+ *
+ * @param renderer_base $output Renderer.
+ * @return array
+ */
+ public function export_for_template(renderer_base $output): array {
+ // Heading.
+ $headingtext = isset($this->heading) ? $this->heading : $output->get_page()->heading;
+ $heading = $output->heading($headingtext, $this->headinglevel, "h2 mb-0");
+
+ // Buttons.
+ if (isset($this->additionalbuttons)) {
+ $additionalbuttons = [];
+ foreach ($this->additionalbuttons as $button) {
+ if (!isset($button->page)) {
+ // Include js for messaging.
+ if ($button['buttontype'] === 'togglecontact') {
+ \core_message\helper::togglecontact_requirejs();
+ }
+ if ($button['buttontype'] === 'message') {
+ \core_message\helper::messageuser_requirejs();
+ }
+ }
+ foreach ($button['linkattributes'] as $key => $value) {
+ $button['attributes'][] = ['name' => $key, 'value' => $value];
+ }
+ $additionalbuttons[] = $button;
+ }
+ }
+
+ return [
+ 'heading' => $heading,
+ 'headinglevel' => $this->headinglevel,
+ 'imagedata' => $this->imagedata,
+ 'prefix' => $this->prefix,
+ 'hasadditionalbuttons' => !empty($additionalbuttons),
+ 'additionalbuttons' => $additionalbuttons ?? [],
+ ];
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(context_header::class, \context_header::class);
diff --git a/lib/classes/output/core_renderer.php b/lib/classes/output/core_renderer.php
new file mode 100644
index 0000000000000..27d63344b7bb7
--- /dev/null
+++ b/lib/classes/output/core_renderer.php
@@ -0,0 +1,4893 @@
+.
+
+namespace core\output;
+
+use breadcrumb_navigation_node;
+use cm_info;
+use core_block\output\block_contents;
+use core_block\output\block_move_target;
+use core_completion\cm_completion_details;
+use core\context;
+use core_course\output\activity_information;
+use core_tag\output\taglist;
+use core_text;
+use core_useragent;
+use core\check\check as check_check;
+use core\check\result as check_result;
+use core\context\system as context_system;
+use core\context\course as context_course;
+use core\di;
+use core\exception\coding_exception;
+use core\hook\manager as hook_manager;
+use core\hook\output\after_standard_main_region_html_generation;
+use core\hook\output\before_footer_html_generation;
+use core\hook\output\before_html_attributes;
+use core\hook\output\before_http_headers;
+use core\hook\output\before_standard_footer_html_generation;
+use core\hook\output\before_standard_top_of_body_html_generation;
+use core\output\action_menu\link as action_menu_link;
+use core\output\action_menu\link_primary as action_menu_link_primary;
+use core\output\actions\component_action;
+use core\output\actions\popup_action;
+use core\output\action_menu\filler as action_menu_filler;
+use core\plugin_manager;
+use core\output\action_menu\link_secondary as action_menu_link_secondary;
+use moodleform;
+use moodle_page;
+use moodle_url;
+use navigation_node;
+use rating;
+use rating_manager;
+use stdClass;
+use HTML_QuickForm_element;
+
+/**
+ * The standard implementation of the core_renderer interface.
+ *
+ * @copyright 2009 Tim Hunt
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
+ * @category output
+ */
+class core_renderer extends renderer_base {
+ /**
+ * Do NOT use, please use main_content() ?>
+ * in layout files instead.
+ * @deprecated
+ * @var string used in {@see core_renderer::header()}.
+ */
+ const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
+
+ /**
+ * @var string Used to pass information from {@see core_renderer::doctype()} to
+ * @see core_renderer::standard_head_html()
+ */
+ protected $contenttype;
+
+ /**
+ * @var string Used by {@see core_renderer::redirect_message()} method to communicate
+ * with {@see core_renderer::header()}.
+ */
+ protected $metarefreshtag = '';
+
+ /**
+ * @var string Unique token for the closing HTML
+ */
+ protected $unique_end_html_token; // phpcs:ignore moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+ /**
+ * @var string Unique token for performance information
+ */
+ protected $unique_performance_info_token; // phpcs:ignore moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+ /**
+ * @var string Unique token for the main content.
+ */
+ protected $unique_main_content_token; // phpcs:ignore moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+ /** @var custom_menu_item language The language menu if created */
+ protected $language = null;
+
+ /** @var string The current selector for an element being streamed into */
+ protected $currentselector = '';
+
+ /** @var string The current element tag which is being streamed into */
+ protected $currentelement = '';
+
+ /**
+ * Constructor
+ *
+ * @param moodle_page $page the page we are doing output for.
+ * @param string $target one of rendering target constants
+ */
+ public function __construct(moodle_page $page, $target) {
+ $this->opencontainers = $page->opencontainers;
+ $this->page = $page;
+ $this->target = $target;
+
+ $this->unique_end_html_token = '%%ENDHTML-' . sesskey() . '%%';
+ $this->unique_performance_info_token = '%%PERFORMANCEINFO-' . sesskey() . '%%';
+ $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - ' . sesskey() . ']';
+ }
+
+ /**
+ * Get the DOCTYPE declaration that should be used with this page. Designed to
+ * be called in theme layout.php files.
+ *
+ * @return string the DOCTYPE declaration that should be used.
+ */
+ public function doctype() {
+ if ($this->page->theme->doctype === 'html5') {
+ $this->contenttype = 'text/html; charset=utf-8';
+ return "\n";
+ } else if ($this->page->theme->doctype === 'xhtml5') {
+ $this->contenttype = 'application/xhtml+xml; charset=utf-8';
+ return "\n";
+ } else {
+ // legacy xhtml 1.0
+ $this->contenttype = 'text/html; charset=utf-8';
+ return ('' . "\n");
+ }
+ }
+
+ /**
+ * The attributes that should be added to the tag. Designed to
+ * be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function htmlattributes() {
+ $return = get_html_lang(true);
+
+ $hook = new before_html_attributes($this);
+
+ if ($this->page->theme->doctype !== 'html5') {
+ $hook->add_attribute('xmlns', 'http://www.w3.org/1999/xhtml');
+ }
+
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+
+ foreach ($hook->get_attributes() as $key => $val) {
+ $val = s($val);
+ $return .= " $key=\"$val\"";
+ }
+
+ return $return;
+ }
+
+ /**
+ * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
+ * that should be included in the tag. Designed to be called in theme
+ * layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_head_html() {
+ global $CFG, $SESSION, $SITE;
+
+ // Before we output any content, we need to ensure that certain
+ // page components are set up.
+
+ // Blocks must be set up early as they may require javascript which
+ // has to be included in the page header before output is created.
+ foreach ($this->page->blocks->get_regions() as $region) {
+ $this->page->blocks->ensure_content_created($region, $this);
+ }
+
+ // Give plugins an opportunity to add any head elements. The callback
+ // must always return a string containing valid html head content.
+
+ $hook = new \core\hook\output\before_standard_head_html_generation($this);
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+
+ // Allow a url_rewrite plugin to setup any dynamic head content.
+ if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
+ $class = $CFG->urlrewriteclass;
+ $hook->add_html($class::html_head_setup());
+ }
+
+ $hook->add_html('' . "\n");
+ $hook->add_html('' . "\n");
+ // This is only set by the {@see redirect()} method
+ $hook->add_html($this->metarefreshtag);
+
+ // Check if a periodic refresh delay has been set and make sure we arn't
+ // already meta refreshing
+ if ($this->metarefreshtag == '' && $this->page->periodicrefreshdelay !== null) {
+ $hook->add_html(
+ html_writer::empty_tag('meta', [
+ 'http-equiv' => 'refresh',
+ 'content' => $this->page->periodicrefreshdelay . ';url=' . $this->page->url->out(),
+ ]),
+ );
+ }
+
+ $output = $hook->get_output();
+
+ // Set up help link popups for all links with the helptooltip class
+ $this->page->requires->js_init_call('M.util.help_popups.setup');
+
+ $focus = $this->page->focuscontrol;
+ if (!empty($focus)) {
+ if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
+ // This is a horrifically bad way to handle focus but it is passed in
+ // through messy formslib::moodleform
+ $this->page->requires->js_function_call('old_onload_focus', [$matches[1], $matches[2]]);
+ } else if (strpos($focus, '.') !== false) {
+ // Old style of focus, bad way to do it
+ debugging('This code is using the old style focus event, Please update this code to focus on an element id or the moodleform focus method.', DEBUG_DEVELOPER);
+ $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
+ } else {
+ // Focus element with given id
+ $this->page->requires->js_function_call('focuscontrol', [$focus]);
+ }
+ }
+
+ // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
+ // any other custom CSS can not be overridden via themes and is highly discouraged
+ $urls = $this->page->theme->css_urls($this->page);
+ foreach ($urls as $url) {
+ $this->page->requires->css_theme($url);
+ }
+
+ // Get the theme javascript head and footer
+ if ($jsurl = $this->page->theme->javascript_url(true)) {
+ $this->page->requires->js($jsurl, true);
+ }
+ if ($jsurl = $this->page->theme->javascript_url(false)) {
+ $this->page->requires->js($jsurl);
+ }
+
+ // Get any HTML from the page_requirements_manager.
+ $output .= $this->page->requires->get_head_code($this->page, $this);
+
+ // List alternate versions.
+ foreach ($this->page->alternateversions as $type => $alt) {
+ $output .= html_writer::empty_tag('link', [
+ 'rel' => 'alternate',
+ 'type' => $type,
+ 'title' => $alt->title,
+ 'href' => $alt->url,
+ ]);
+ }
+
+ // Add noindex tag if relevant page and setting applied.
+ $allowindexing = isset($CFG->allowindexing) ? $CFG->allowindexing : 0;
+ $loginpages = ['login-index', 'login-signup'];
+ if ($allowindexing == 2 || ($allowindexing == 0 && in_array($this->page->pagetype, $loginpages))) {
+ if (!isset($CFG->additionalhtmlhead)) {
+ $CFG->additionalhtmlhead = '';
+ }
+ $CFG->additionalhtmlhead .= '';
+ }
+
+ if (!empty($CFG->additionalhtmlhead)) {
+ $output .= "\n" . $CFG->additionalhtmlhead;
+ }
+
+ if ($this->page->pagelayout == 'frontpage') {
+ $summary = s(strip_tags(format_text($SITE->summary, FORMAT_HTML)));
+ if (!empty($summary)) {
+ $output .= "\n";
+ }
+ }
+
+ return $output;
+ }
+
+ /**
+ * The standard tags (typically skip links) that should be output just inside
+ * the start of the tag. Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_top_of_body_html() {
+ global $CFG;
+ $output = $this->page->requires->get_top_of_body_code($this);
+ if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmltopofbody)) {
+ $output .= "\n" . $CFG->additionalhtmltopofbody;
+ }
+
+ // Allow components to add content to the top of the body.
+ $hook = new before_standard_top_of_body_html_generation($this, $output);
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+ $output = $hook->get_output();
+
+ $output .= $this->maintenance_warning();
+
+ return $output;
+ }
+
+ /**
+ * Scheduled maintenance warning message.
+ *
+ * Note: This is a nasty hack to display maintenance notice, this should be moved
+ * to some general notification area once we have it.
+ *
+ * @return string
+ */
+ public function maintenance_warning() {
+ global $CFG;
+
+ $output = '';
+ if (isset($CFG->maintenance_later) and $CFG->maintenance_later > time()) {
+ $timeleft = $CFG->maintenance_later - time();
+ // If timeleft less than 30 sec, set the class on block to error to highlight.
+ $errorclass = ($timeleft < 30) ? 'alert-error alert-danger' : 'alert-warning';
+ $output .= $this->box_start($errorclass . ' moodle-has-zindex maintenancewarning m-3 alert');
+ $a = new stdClass();
+ $a->hour = (int)($timeleft / 3600);
+ $a->min = (int)(floor($timeleft / 60) % 60);
+ $a->sec = (int)($timeleft % 60);
+ if ($a->hour > 0) {
+ $output .= get_string('maintenancemodeisscheduledlong', 'admin', $a);
+ } else {
+ $output .= get_string('maintenancemodeisscheduled', 'admin', $a);
+ }
+
+ $output .= $this->box_end();
+ $this->page->requires->yui_module(
+ 'moodle-core-maintenancemodetimer',
+ 'M.core.maintenancemodetimer',
+ [['timeleftinsec' => $timeleft]]
+ );
+ $this->page->requires->strings_for_js(
+ ['maintenancemodeisscheduled', 'maintenancemodeisscheduledlong', 'sitemaintenance'],
+ 'admin'
+ );
+ }
+ return $output;
+ }
+
+ /**
+ * content that should be output in the footer area
+ * of the page. Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_footer_html() {
+ if (during_initial_install()) {
+ // Debugging info can not work before install is finished,
+ // in any case we do not want any links during installation!
+ return '';
+ }
+
+ $hook = new before_standard_footer_html_generation($this);
+ $hook->process_legacy_callbacks();
+ di::get(hook_manager::class)->dispatch($hook);
+ $output = $hook->get_output();
+
+ if ($this->page->devicetypeinuse == 'legacy') {
+ // The legacy theme is in use print the notification
+ $output .= html_writer::tag('div', get_string('legacythemeinuse'), ['class' => 'legacythemeinuse']);
+ }
+
+ // Get links to switch device types (only shown for users not on a default device)
+ $output .= $this->theme_switch_links();
+
+ return $output;
+ }
+
+ /**
+ * Performance information and validation links for debugging.
+ *
+ * @return string HTML fragment.
+ */
+ public function debug_footer_html() {
+ global $CFG, $SCRIPT;
+ $output = '';
+
+ if (during_initial_install()) {
+ // Debugging info can not work before install is finished.
+ return $output;
+ }
+
+ // This function is normally called from a layout.php file
+ // but some of the content won't be known until later, so we return a placeholder
+ // for now. This will be replaced with the real content in the footer.
+ $output .= $this->unique_performance_info_token;
+
+ if (!empty($CFG->debugpageinfo)) {
+ $output .= '
+
+EOD;
+ }
+ $html .= '
{{> block_timeline/nav-day-filter }}
diff --git a/blocks/timeline/tests/behat/block_timeline_search.feature b/blocks/timeline/tests/behat/block_timeline_search.feature
index f25bbd4cf856e..5814ea418a35b 100644
--- a/blocks/timeline/tests/behat/block_timeline_search.feature
+++ b/blocks/timeline/tests/behat/block_timeline_search.feature
@@ -141,7 +141,7 @@ Feature: The timeline block allows users to search for upcoming activities
And I should see "Test choice 7" in the ".block-timeline [data-region='view-courses']" "css_element"
And I should see "Test choice 8" in the ".block-timeline [data-region='view-courses']" "css_element"
When I set the field "Search by activity type or name" to "choice 1"
- And I wait until "Course 4" "text" does not exist
+ And I wait until "//h4[contains(@class, 'h5') and contains(.,'Course 4')]" "xpath_element" does not exist
Then I should see "Test choice 1" in the "Timeline" "block"
And I should see "Course 2" in the ".block-timeline [data-region='view-courses']" "css_element"
And I should not see "Course 1" in the ".block-timeline [data-region='view-courses']" "css_element"
diff --git a/cache/tests/cache_test.php b/cache/tests/cache_test.php
index 142b11cf2fa31..c6371b4b5df46 100644
--- a/cache/tests/cache_test.php
+++ b/cache/tests/cache_test.php
@@ -2230,7 +2230,7 @@ public function test_application_locking_before_write(): void {
/**
* Test that locking before write works when writing across multiple layers.
*
- * @covers \cache_loader
+ * @covers \cache_application
* @return void
*/
public function test_application_locking_multiple_layers(): void {
@@ -2310,7 +2310,7 @@ public function test_application_locking_multiple_layers(): void {
/**
* Tests that locking fails correctly when either layer of a 2-layer cache has a lock already.
*
- * @covers \cache_loader
+ * @covers \cache_application
*/
public function test_application_locking_multiple_layers_failures(): void {
diff --git a/calendar/renderer.php b/calendar/renderer.php
index 5134fa007fa5c..2c356347dc671 100644
--- a/calendar/renderer.php
+++ b/calendar/renderer.php
@@ -206,7 +206,7 @@ public function course_filter_selector(moodle_url $returnurl, $label = null, $co
}
$contextrecords = [];
- $courses = calendar_get_default_courses($courseid, 'id, shortname');
+ $courses = calendar_get_default_courses($courseid, 'id, fullname');
if (!empty($courses) && count($courses) > CONTEXT_CACHE_MAX_SIZE) {
// We need to pull the context records from the DB to preload them
@@ -235,7 +235,9 @@ public function course_filter_selector(moodle_url $returnurl, $label = null, $co
context_helper::preload_from_record($contextrecords[$course->id]);
}
$coursecontext = context_course::instance($course->id);
- $courseoptions[$course->id] = format_string($course->shortname, true, array('context' => $coursecontext));
+ // Limit the displayed course name to prevent the dropdown from getting too wide.
+ $coursename = shorten_text($course->fullname, 50, true);
+ $courseoptions[$course->id] = format_string($coursename, true, ['context' => $coursecontext]);
}
if ($courseid) {
@@ -260,7 +262,7 @@ public function course_filter_selector(moodle_url $returnurl, $label = null, $co
}
$select = html_writer::label($label, $filterid, false, $labelattributes);
$select .= html_writer::select($courseoptions, 'course', $selected, false,
- ['class' => 'cal_courses_flt ml-1 mr-auto', 'id' => $filterid]);
+ ['class' => 'cal_courses_flt ml-1 mr-auto mr-2 mb-2', 'id' => $filterid]);
return $select;
}
@@ -298,9 +300,8 @@ public function render_subscriptions_header(): string {
*/
public function render_no_calendar_subscriptions(): string {
$output = html_writer::start_div('mt-5');
- $importlink = html_writer::link((new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out(),
- get_string('importcalendarexternal', 'calendar'));
- $output .= get_string('nocalendarsubscriptions', 'calendar', $importlink);
+ $importlink = (new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out();
+ $output .= get_string('nocalendarsubscriptionsimportexternal', 'core_calendar', $importlink);
$output .= html_writer::end_div();
return $output;
@@ -327,7 +328,8 @@ public function subscription_details($unused, $subscriptions, $unused2 = '') {
$table->id = 'subscription_details_table';
if (empty($subscriptions)) {
- $cell = new html_table_cell(get_string('nocalendarsubscriptions', 'calendar'));
+ $importlink = (new moodle_url('/calendar/import.php', calendar_get_export_import_link_params()))->out();
+ $cell = new html_table_cell(get_string('nocalendarsubscriptionsimportexternal', 'core_calendar', $importlink));
$cell->colspan = 5;
$table->data[] = new html_table_row(array($cell));
}
diff --git a/calendar/templates/add_event_button.mustache b/calendar/templates/add_event_button.mustache
index 115e58ce5dbe4..06cdebfd80dca 100644
--- a/calendar/templates/add_event_button.mustache
+++ b/calendar/templates/add_event_button.mustache
@@ -34,7 +34,7 @@
}}
{{#defaulteventcontext}}
-
diff --git a/course/templates/defaultactivitycompletion.mustache b/course/templates/defaultactivitycompletion.mustache
index d2a64d21855d0..5d1e05dc7c5d6 100644
--- a/course/templates/defaultactivitycompletion.mustache
+++ b/course/templates/defaultactivitycompletion.mustache
@@ -68,7 +68,7 @@
{{#pix}} t/expandedchevron, core {{/pix}}
{{#str}} collapsecategory, core, {{formatedname}} {{/str}}
-
+
{{{formattedname}}}
+$string['iplookupgeoplugin'] = 'The geoPlugin service is currently being used to look up geographical information. For more accurate results we recommend installing a local copy of the MaxMind GeoIP City database.'; +$string['iplookupinfo'] = 'The free online NetGeo server is used to look up IP address locations. The database is not maintained any more though, and may return incorrect data. Installing a local copy of a GeoIP database from MaxMind is recommended.
If a Google Maps API V3 key is provided, IP address location is displayed using Google Maps. You need a Google account and to apply for a Google Maps API key. If no Google Maps API V3 key is provided, IP address location is displayed using OpenStreetMap.'; -$string['iplookupmaxmindnote'] = 'This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.'; +$string['iplookupmaxmindnote'] = 'This product includes GeoIP City data created by MaxMind, available from https://www.maxmind.com.'; $string['iscustomadminwarnings'] = 'It has been detected that your site is using a custom admin directory. This feature is no longer supported and will be removed after Moodle 4.2.'; $string['ishttpswarning'] = 'It has been detected that your site is not secured using HTTPS. It is strongly recommended to migrate your site to HTTPS for increased security and improved integration with other systems.'; $string['keeptagnamecase'] = 'Keep tag name casing'; @@ -1436,6 +1442,7 @@ $string['taskstatscron'] = 'Background processing for statistics'; $string['tasktagcron'] = 'Background processing for tags'; $string['tasktempfilecleanup'] = 'Delete stale temp files'; +$string['taskupdategeoip2file'] = 'Update GeoIP file'; $string['tempdatafoldercleanup'] = 'Clean up temporary data files older than'; $string['templates'] = 'Templates'; $string['testoutgoingmailconf'] = 'Test outgoing mail configuration'; diff --git a/lang/en/backup.php b/lang/en/backup.php index 9fa54d69ea646..8a9002a0488af 100644 --- a/lang/en/backup.php +++ b/lang/en/backup.php @@ -198,6 +198,7 @@ $string['enterasearch'] = 'Enter a search'; $string['error_block_for_module_not_found'] = 'Orphan block instance (id: {$a->bid}) for course module (id: {$a->mid}) found. This block will not be backed up'; $string['error_course_module_not_found'] = 'Orphan course module (id: {$a}) found. This module will not be backed up.'; +$string['error_delegate_section_not_found'] = 'Missing delegate section form course module (id: {$a}. The section will not be backed up.'; $string['errorcopyingbackupfile'] = "Failed to copy the backup file to the temporary folder before restoring."; $string['errorfilenamerequired'] = 'You must enter a valid filename for this backup'; $string['errorfilenametoolong'] = 'The filename must be less than 255 characters in length.'; @@ -416,6 +417,7 @@ $string['skipmodifprev'] = 'Skip courses not modified since previous backup'; $string['skipmodifprevhelp'] = 'Choose whether to skip courses that have not been modified since the last automatic backup. This requires logging to be enabled.'; $string['status'] = 'Status'; +$string['subsectioncontent'] = 'Subsection content'; $string['successful'] = 'Backup successful'; $string['successfulcopy'] = 'Copy successful'; $string['successfulrestore'] = 'Restore successful'; diff --git a/lang/en/calendar.php b/lang/en/calendar.php index f922d5d46d90d..694efe548bf09 100644 --- a/lang/en/calendar.php +++ b/lang/en/calendar.php @@ -168,7 +168,6 @@ $string['hideeventtype'] = 'Hide {$a} events'; $string['showeventtype'] = 'Show {$a} events'; $string['hourly'] = 'Hourly'; -$string['importcalendarexternal'] = 'Import an external calendar?'; $string['importcalendar'] = 'Import calendar'; $string['importcalendarheading'] = 'Import calendar...'; $string['importcalendarfrom'] = 'Import from'; @@ -193,9 +192,9 @@ $string['never'] = 'Never'; $string['newevent'] = 'New event'; $string['newmonthannouncement'] = 'Calendar is now set to {$a}.'; +$string['nocalendarsubscriptionsimportexternal'] = 'No calendar subscriptions yet. Import an external calendar'; $string['notitle'] = 'no title'; $string['noupcomingevents'] = 'There are no upcoming events'; -$string['nocalendarsubscriptions'] = 'No calendar subscriptions yet. Do you want to {$a}'; $string['oneevent'] = '1 event'; $string['pollinterval'] = 'Update interval'; $string['pollinterval_help'] = 'How often you would like the calendar to update with new events.'; @@ -287,3 +286,7 @@ // Deprecated since Moodle 4.4. $string['coursecalendar'] = '{$a} calendar'; + +// Deprecated since Moodle 4.5. +$string['importcalendarexternal'] = 'Import an external calendar?'; +$string['nocalendarsubscriptions'] = 'No calendar subscriptions yet. Do you want to {$a}'; diff --git a/lang/en/cohort.php b/lang/en/cohort.php index b913521a1c03a..93c94e0f20536 100644 --- a/lang/en/cohort.php +++ b/lang/en/cohort.php @@ -47,6 +47,7 @@ $string['currentusersmatching'] = 'Current users matching'; $string['defaultcontext'] = 'Default context'; $string['delcohort'] = 'Delete cohort'; +$string['delcohortsconfirm'] = 'Do you really want to delete the selected cohorts?'; $string['delconfirm'] = 'Do you really want to delete cohort \'{$a}\'?'; $string['description'] = 'Description'; $string['displayedrows'] = '{$a->displayed} rows displayed out of {$a->total}.'; diff --git a/lang/en/deprecated.txt b/lang/en/deprecated.txt index 31c9828e288d2..b934616128dbf 100644 --- a/lang/en/deprecated.txt +++ b/lang/en/deprecated.txt @@ -113,4 +113,6 @@ coursesearch_help,core blocknotexist,core_debug modulenotexist,core_debug coursecalendar,core_calendar +importcalendarexternal,core_calendar +nocalendarsubscriptions,core_calendar datechanged,core diff --git a/lang/en/error.php b/lang/en/error.php index 09764f33a61d3..9de16f6fe16f9 100644 --- a/lang/en/error.php +++ b/lang/en/error.php @@ -96,7 +96,7 @@ $string['cannotfindlang'] = 'Cannot find "{$a}" language pack!'; $string['cannotfindteacher'] = 'Cannot find teacher'; $string['cannotfinduser'] = 'Cannot find user named "{$a}"'; -$string['cannotgeoplugin'] = 'Cannot connect to the geoPlugin server at https://www.geoplugin.com. Please check your proxy settings or install the MaxMind GeoLite City data file.'; +$string['cannotgeoplugin'] = 'Cannot connect to the geoPlugin server at https://www.geoplugin.com. Please check your proxy settings or install the MaxMind GeoIP City data file.'; $string['cannotgetblock'] = 'Could not retrieve blocks from the database'; $string['cannotgetcats'] = 'Cannot get category record'; $string['cannotgetdata'] = 'Cannot get data'; diff --git a/lang/en/moodle.php b/lang/en/moodle.php index 13d916783acee..9a27682c6c309 100644 --- a/lang/en/moodle.php +++ b/lang/en/moodle.php @@ -1863,7 +1863,12 @@ $string['reset'] = 'Reset'; $string['resetcomponent'] = 'Component'; $string['resetcourse'] = 'Reset course'; -$string['resetinfo'] = 'Delete all user data and reset this course to its original state, keeping activities and settings intact.'; +$string['resetcourseconfirm'] = 'Reset course?'; +$string['resetcoursewarning'] = 'Are you sure you want to reset the course \'{$a}\'? +
+This will delete the selected data and reset the course back to its original state. You can\'t undo this action.'; +$string['resetinfo'] = 'This feature allows you to clear all user data and reset the course to its original state. Course activities and settings will remain untouched.'; +$string['resetinfoselect'] = 'Select the data you want to delete or reset from the categories below:'; $string['resetnotimplemented'] = 'Reset not supported'; $string['resetnotimplementedinfo'] = 'These activities can\'t be reset:'; $string['resetrecordexpired'] = 'The password reset link you used is more than {$a} minutes old and has expired. Please initiate a new password reset.'; diff --git a/lang/en/report.php b/lang/en/report.php new file mode 100644 index 0000000000000..a2f9672ab1f3c --- /dev/null +++ b/lang/en/report.php @@ -0,0 +1,26 @@ +. + +/** + * Strings for component 'report', language 'en' + * + * @package core_report + * @copyright 2024 Amaia Anabitarte
' . get_string(
+ 'pageinfodebugsummary',
+ 'core_admin',
+ $this->page->debug_summary()
+ ) . '
';
+ }
+ if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) { // Only in developer mode
+ // Add link to profiling report if necessary
+ if (function_exists('profiling_is_running') && profiling_is_running()) {
+ $txt = get_string('profiledscript', 'admin');
+ $title = get_string('profiledscriptview', 'admin');
+ $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
+ $link = '' . $txt . '';
+ $output .= '';
+ }
+ $purgeurl = new moodle_url('/admin/purgecaches.php', [
+ 'confirm' => 1,
+ 'sesskey' => sesskey(),
+ 'returnurl' => $this->page->url->out_as_local_url(false),
+ ]);
+ $output .= '' .
+ html_writer::link($purgeurl, get_string('purgecaches', 'admin')) . '
';
+
+ // Reactive module debug panel.
+ $output .= $this->render_from_template('core/local/reactive/debugpanel', []);
+ }
+ if (!empty($CFG->debugvalidators)) {
+ $siteurl = qualified_me();
+ $nuurl = new moodle_url('https://validator.w3.org/nu/', ['doc' => $siteurl, 'showsource' => 'yes']);
+ $waveurl = new moodle_url('https://wave.webaim.org/report#/' . urlencode($siteurl));
+ $validatorlinks = [
+ html_writer::link($nuurl, get_string('validatehtml')),
+ html_writer::link($waveurl, get_string('wcagcheck')),
+ ];
+ $validatorlinkslist = html_writer::alist($validatorlinks, ['class' => 'list-unstyled ml-1']);
+ $output .= html_writer::div($validatorlinkslist, 'validators');
+ }
+ return $output;
+ }
+
+ /**
+ * Returns standard main content placeholder.
+ * Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function main_content() {
+ // This is here because it is the only place we can inject the "main" role over the entire main content area
+ // without requiring all theme's to manually do it, and without creating yet another thing people need to
+ // remember in the theme.
+ // This is an unfortunate hack. DO NO EVER add anything more here.
+ // DO NOT add classes.
+ // DO NOT add an id.
+ return '' . $this->unique_main_content_token . '
';
+ }
+
+ /**
+ * Returns information about an activity.
+ *
+ * @deprecated since Moodle 4.3 MDL-78744
+ * @todo MDL-78926 This method will be deleted in Moodle 4.7
+ * @param cm_info $cminfo The course module information.
+ * @param cm_completion_details $completiondetails The completion details for this activity module.
+ * @param array $activitydates The dates for this activity module.
+ * @return string the activity information HTML.
+ * @throws coding_exception
+ */
+ public function activity_information(cm_info $cminfo, cm_completion_details $completiondetails, array $activitydates): string {
+ debugging('activity_information method is deprecated.', DEBUG_DEVELOPER);
+ if (!$completiondetails->has_completion() && empty($activitydates)) {
+ // No need to render the activity information when there's no completion info and activity dates to show.
+ return '';
+ }
+ $activityinfo = new activity_information($cminfo, $completiondetails, $activitydates);
+ $renderer = $this->page->get_renderer('core', 'course');
+ return $renderer->render($activityinfo);
+ }
+
+ /**
+ * Returns standard navigation between activities in a course.
+ *
+ * @return string the navigation HTML.
+ */
+ public function activity_navigation() {
+ // First we should check if we want to add navigation.
+ $context = $this->page->context;
+ if (
+ ($this->page->pagelayout !== 'incourse' && $this->page->pagelayout !== 'frametop')
+ || $context->contextlevel != CONTEXT_MODULE
+ ) {
+ return '';
+ }
+
+ // If the activity is in stealth mode, show no links.
+ if ($this->page->cm->is_stealth()) {
+ return '';
+ }
+
+ $course = $this->page->cm->get_course();
+ $courseformat = course_get_format($course);
+
+ // If the theme implements course index and the current course format uses course index and the current
+ // page layout is not 'frametop' (this layout does not support course index), show no links.
+ if (
+ $this->page->theme->usescourseindex && $courseformat->uses_course_index() &&
+ $this->page->pagelayout !== 'frametop'
+ ) {
+ return '';
+ }
+
+ // Get a list of all the activities in the course.
+ $modules = get_fast_modinfo($course->id)->get_cms();
+
+ // Put the modules into an array in order by the position they are shown in the course.
+ $mods = [];
+ $activitylist = [];
+ foreach ($modules as $module) {
+ // Only add activities the user can access, aren't in stealth mode and have a url (eg. mod_label does not).
+ if (!$module->uservisible || $module->is_stealth() || empty($module->url)) {
+ continue;
+ }
+ $mods[$module->id] = $module;
+
+ // No need to add the current module to the list for the activity dropdown menu.
+ if ($module->id == $this->page->cm->id) {
+ continue;
+ }
+ // Module name.
+ $modname = $module->get_formatted_name();
+ // Display the hidden text if necessary.
+ if (!$module->visible) {
+ $modname .= ' ' . get_string('hiddenwithbrackets');
+ }
+ // Module URL.
+ $linkurl = new moodle_url($module->url, ['forceview' => 1]);
+ // Add module URL (as key) and name (as value) to the activity list array.
+ $activitylist[$linkurl->out(false)] = $modname;
+ }
+
+ $nummods = count($mods);
+
+ // If there is only one mod then do nothing.
+ if ($nummods == 1) {
+ return '';
+ }
+
+ // Get an array of just the course module ids used to get the cmid value based on their position in the course.
+ $modids = array_keys($mods);
+
+ // Get the position in the array of the course module we are viewing.
+ $position = array_search($this->page->cm->id, $modids);
+
+ $prevmod = null;
+ $nextmod = null;
+
+ // Check if we have a previous mod to show.
+ if ($position > 0) {
+ $prevmod = $mods[$modids[$position - 1]];
+ }
+
+ // Check if we have a next mod to show.
+ if ($position < ($nummods - 1)) {
+ $nextmod = $mods[$modids[$position + 1]];
+ }
+
+ $activitynav = new \core_course\output\activity_navigation($prevmod, $nextmod, $activitylist);
+ $renderer = $this->page->get_renderer('core', 'course');
+ return $renderer->render($activitynav);
+ }
+
+ /**
+ * The standard tags (typically script tags that are not needed earlier) that
+ * should be output after everything else. Designed to be called in theme layout.php files.
+ *
+ * @return string HTML fragment.
+ */
+ public function standard_end_of_body_html() {
+ global $CFG;
+
+ // This function is normally called from a layout.php file in {@see core_renderer::header()}
+ // but some of the content won't be known until later, so we return a placeholder
+ // for now. This will be replaced with the real content in {@see core_renderer::footer()}.
+ $output = '';
+ if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlfooter)) {
+ $output .= "\n" . $CFG->additionalhtmlfooter;
+ }
+ $output .= $this->unique_end_html_token;
+ return $output;
+ }
+
+ /**
+ * The standard HTML that should be output just before the ' . + get_string('moreinformation') . '
'; + if (empty($CFG->rolesactive)) { + $message .= ''; + // It is usually not possible to recover from errors triggered during installation, you may need to create a new database or use a different database prefix for new installation. + } + $output .= $this->box($message, 'errorbox alert alert-danger', null, ['data-rel' => 'fatalerror']); + + if ($CFG->debugdeveloper) { + $labelsep = get_string('labelsep', 'langconfig'); + if (!empty($debuginfo)) { + $debuginfo = s($debuginfo); // removes all nasty JS + $debuginfo = str_replace("\n", '', $debuginfo); // keep newlines + $label = get_string('debuginfo', 'debug') . $labelsep; + $output .= $this->notification("$label " . $debuginfo, 'notifytiny'); + } + if (!empty($backtrace)) { + $label = get_string('stacktrace', 'debug') . $labelsep; + $output .= $this->notification("$label " . format_backtrace($backtrace), 'notifytiny'); + } + if ($obbuffer !== '') { + $label = get_string('outputbuffer', 'debug') . $labelsep; + $output .= $this->notification("$label " . s($obbuffer), 'notifytiny'); + } + } + + if (empty($CFG->rolesactive)) { + // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable + } else if (!empty($link)) { + $output .= $this->continue_button($link); + } + + $output .= $this->footer(); + + // Padding to encourage IE to display our error page, rather than its own. + $output .= str_repeat(' ', 512); + + return $output; + } + + /** + * Output a notification (that is, a status message about something that has just happened). + * + * Note: \core\notification::add() may be more suitable for your usage. + * + * @param string $message The message to print out. + * @param ?string $type The type of notification. See constants on notification. + * @param bool $closebutton Whether to show a close icon to remove the notification (default true). + * @return string the HTML to output. + */ + public function notification($message, $type = null, $closebutton = true) { + $typemappings = [ + // Valid types. + 'success' => notification::NOTIFY_SUCCESS, + 'info' => notification::NOTIFY_INFO, + 'warning' => notification::NOTIFY_WARNING, + 'error' => notification::NOTIFY_ERROR, + + // Legacy types mapped to current types. + 'notifyproblem' => notification::NOTIFY_ERROR, + 'notifytiny' => notification::NOTIFY_ERROR, + 'notifyerror' => notification::NOTIFY_ERROR, + 'notifysuccess' => notification::NOTIFY_SUCCESS, + 'notifymessage' => notification::NOTIFY_INFO, + 'notifyredirect' => notification::NOTIFY_INFO, + 'redirectmessage' => notification::NOTIFY_INFO, + ]; + + $extraclasses = []; + + if ($type) { + if (strpos($type, ' ') === false) { + // No spaces in the list of classes, therefore no need to loop over and determine the class. + if (isset($typemappings[$type])) { + $type = $typemappings[$type]; + } else { + // The value provided did not match a known type. It must be an extra class. + $extraclasses = [$type]; + } + } else { + // Identify what type of notification this is. + $classarray = explode(' ', self::prepare_classes($type)); + + // Separate out the type of notification from the extra classes. + foreach ($classarray as $class) { + if (isset($typemappings[$class])) { + $type = $typemappings[$class]; + } else { + $extraclasses[] = $class; + } + } + } + } + + $notification = new notification($message, $type, $closebutton); + if (count($extraclasses)) { + $notification->set_extra_classes($extraclasses); + } + + // Return the rendered template. + return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this)); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_problem() { + throw new coding_exception('core_renderer::notify_problem() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_success() { + throw new coding_exception('core_renderer::notify_success() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_message() { + throw new coding_exception('core_renderer::notify_message() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more. + */ + public function notify_redirect() { + throw new coding_exception('core_renderer::notify_redirect() can not be used any more, ' . + 'please use \core\notification::add(), or \core\output\notification as required.'); + } + + /** + * Render a notification (that is, a status message about something that has + * just happened). + * + * @param notification $notification the notification to print out + * @return string the HTML to output. + */ + protected function render_notification(notification $notification) { + return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this)); + } + + /** + * Returns HTML to display a continue button that goes to a particular URL. + * + * @param string|moodle_url $url The url the button goes to. + * @return string the HTML to output. + */ + public function continue_button($url) { + if (!($url instanceof moodle_url)) { + $url = new moodle_url($url); + } + $button = new single_button($url, get_string('continue'), 'get', single_button::BUTTON_PRIMARY); + $button->class = 'continuebutton'; + + return $this->render($button); + } + + /** + * Returns HTML to display a single paging bar to provide access to other pages (usually in a search) + * + * Theme developers: DO NOT OVERRIDE! Please override function + * {@see core_renderer::render_paging_bar()} instead. + * + * @param int $totalcount The total number of entries available to be paged through + * @param int $page The page you are currently viewing + * @param int $perpage The number of entries that should be shown per page + * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added + * @param string $pagevar name of page parameter that holds the page number + * @return string the HTML to output. + */ + public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') { + $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar); + return $this->render($pb); + } + + /** + * Returns HTML to display the paging bar. + * + * @param paging_bar $pagingbar + * @return string the HTML to output. + */ + protected function render_paging_bar(paging_bar $pagingbar) { + // Any more than 10 is not usable and causes weird wrapping of the pagination. + $pagingbar->maxdisplay = 10; + return $this->render_from_template('core/paging_bar', $pagingbar->export_for_template($this)); + } + + /** + * Returns HTML to display initials bar to provide access to other pages (usually in a search) + * + * @param string $current the currently selected letter. + * @param string $class class name to add to this initial bar. + * @param string $title the name to put in front of this initial bar. + * @param string $urlvar URL parameter name for this initial. + * @param string $url URL object. + * @param array $alpha of letters in the alphabet. + * @param bool $minirender Return a trimmed down view of the initials bar. + * @return string the HTML to output. + */ + public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null, bool $minirender = false) { + $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha, $minirender); + return $this->render($ib); + } + + /** + * Internal implementation of initials bar rendering. + * + * @param initials_bar $initialsbar + * @return string + */ + protected function render_initials_bar(initials_bar $initialsbar) { + return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this)); + } + + /** + * Output the place a skip link goes to. + * + * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call. + * @return string the HTML to output. + */ + public function skip_link_target($id = null) { + return html_writer::span('', '', ['id' => $id]); + } + + /** + * Outputs a heading + * + * @param string $text The text of the heading + * @param int $level The level of importance of the heading. Defaulting to 2 + * @param string $classes A space-separated list of CSS classes. Defaulting to null + * @param string $id An optional ID + * @return string the HTML to output. + */ + public function heading($text, $level = 2, $classes = null, $id = null) { + $level = (int) $level; + if ($level < 1 or $level > 6) { + throw new coding_exception('Heading level must be an integer between 1 and 6.'); + } + return html_writer::tag('h' . $level, $text, ['id' => $id, 'class' => renderer_base::prepare_classes($classes)]); + } + + /** + * Outputs a box. + * + * @param string $contents The contents of the box + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes An array of other attributes to give the box. + * @return string the HTML to output. + */ + public function box($contents, $classes = 'generalbox', $id = null, $attributes = []) { + return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end(); + } + + /** + * Outputs the opening section of a box. + * + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes An array of other attributes to give the box. + * @return string the HTML to output. + */ + public function box_start($classes = 'generalbox', $id = null, $attributes = []) { + $this->opencontainers->push('box', html_writer::end_tag('div')); + $attributes['id'] = $id; + $attributes['class'] = 'box py-3 ' . renderer_base::prepare_classes($classes); + return html_writer::start_tag('div', $attributes); + } + + /** + * Outputs the closing section of a box. + * + * @return string the HTML to output. + */ + public function box_end() { + return $this->opencontainers->pop('box'); + } + + /** + * Outputs a paragraph. + * + * @param string $contents The contents of the paragraph + * @param string|null $classes A space-separated list of CSS classes + * @param string|null $id An optional ID + * @return string the HTML to output. + */ + public function paragraph(string $contents, ?string $classes = null, ?string $id = null): string { + return html_writer::tag( + 'p', + $contents, + ['id' => $id, 'class' => renderer_base::prepare_classes($classes)] + ); + } + + /** + * Outputs a screen reader only inline text. + * + * @param string $contents The contents of the paragraph + * @return string the HTML to output. + */ + public function sr_text(string $contents): string { + return html_writer::tag( + 'span', + $contents, + ['class' => 'sr-only'] + ) . ' '; + } + + /** + * Outputs a container. + * + * @param string $contents The contents of the box + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes Optional other attributes as array + * @return string the HTML to output. + */ + public function container($contents, $classes = null, $id = null, $attributes = []) { + return $this->container_start($classes, $id, $attributes) . $contents . $this->container_end(); + } + + /** + * Outputs the opening section of a container. + * + * @param string $classes A space-separated list of CSS classes + * @param string $id An optional ID + * @param array $attributes Optional other attributes as array + * @return string the HTML to output. + */ + public function container_start($classes = null, $id = null, $attributes = []) { + $this->opencontainers->push('container', html_writer::end_tag('div')); + $attributes = array_merge(['id' => $id, 'class' => renderer_base::prepare_classes($classes)], $attributes); + return html_writer::start_tag('div', $attributes); + } + + /** + * Outputs the closing section of a container. + * + * @return string the HTML to output. + */ + public function container_end() { + return $this->opencontainers->pop('container'); + } + + /** + * Make nested HTML lists out of the items + * + * The resulting list will look something like this: + * + *
+ * <
- >
+ * <
- >(item contents)+ * <
-
+ * <
- >(item contents)< >
+ * <
>
+ * < - >
+ * if (!$this->page->requires->should_create_one_time_item_now($thing)) {
+ * return '';
+ * }
+ * // Else generate it.
+ *
+ *
+ * @param string $thing identifier for the bit of content. Should be of the form
+ * frankenstyle_things, e.g. core_course_modchooser.
+ * @return bool if true, the caller should generate that bit of output now, otherwise don't.
+ */
+ public function should_create_one_time_item_now($thing) {
+ if ($this->has_one_time_item_been_created($thing)) {
+ return false;
+ }
+
+ $this->set_one_time_item_created($thing);
+ return true;
+ }
+
+ /**
+ * Has a particular bit of HTML that is only required once on this page
+ * (e.g. the contents of the modchooser) already been generated?
+ *
+ * Normally, you can use the {@see should_create_one_time_item_now()} helper
+ * method rather than calling this method directly.
+ *
+ * @param string $thing identifier for the bit of content. Should be of the form
+ * frankenstyle_things, e.g. core_course_modchooser.
+ * @return bool whether that bit of output has been created.
+ */
+ public function has_one_time_item_been_created($thing) {
+ return isset($this->onetimeitemsoutput[$thing]);
+ }
+
+ /**
+ * Indicate that a particular bit of HTML that is only required once on this
+ * page (e.g. the contents of the modchooser) has been generated (or is about to be)?
+ *
+ * Normally, you can use the {@see should_create_one_time_item_now()} helper
+ * method rather than calling this method directly.
+ *
+ * @param string $thing identifier for the bit of content. Should be of the form
+ * frankenstyle_things, e.g. core_course_modchooser.
+ */
+ public function set_one_time_item_created($thing) {
+ if ($this->has_one_time_item_been_created($thing)) {
+ throw new coding_exception($thing . ' is only supposed to be ouput ' .
+ 'once per page, but it seems to be being output again.');
+ }
+ return $this->onetimeitemsoutput[$thing] = true;
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(page_requirements_manager::class, \page_requirements_manager::class);
diff --git a/lib/classes/output/requirements/yui.php b/lib/classes/output/requirements/yui.php
new file mode 100644
index 0000000000000..58a695191c28b
--- /dev/null
+++ b/lib/classes/output/requirements/yui.php
@@ -0,0 +1,379 @@
+.
+
+namespace core\output\requirements;
+
+use cache;
+use core_component;
+use core_minify;
+use core\exception\coding_exception;
+use DirectoryIterator;
+
+/**
+ * This class represents the YUI configuration.
+ *
+ * @copyright 2013 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.5
+ * @package core
+ * @category output
+ */
+class yui {
+ /**
+ * These settings must be public so that when the object is converted to json they are exposed.
+ * Note: Some of these are camelCase because YUI uses camelCase variable names.
+ *
+ * The settings are described and documented in the YUI API at:
+ * - http://yuilibrary.com/yui/docs/api/classes/config.html
+ * - http://yuilibrary.com/yui/docs/api/classes/Loader.html
+ */
+ public $debug = false;
+ public $base;
+ public $comboBase;
+ public $combine;
+ public $filter = null;
+ public $insertBefore = 'firstthemesheet';
+ public $groups = [];
+ public $modules = [];
+ /** @var array The log sources that should be not be logged. */
+ public $logInclude = [];
+ /** @var array Tog sources that should be logged. */
+ public $logExclude = [];
+ /** @var string The minimum log level for YUI logging statements. */
+ public $logLevel;
+
+ /**
+ * @var array List of functions used by the YUI Loader group pattern recognition.
+ */
+ protected $jsconfigfunctions = [];
+
+ /**
+ * Create a new group within the YUI_config system.
+ *
+ * @param string $name The name of the group. This must be unique and
+ * not previously used.
+ * @param array $config The configuration for this group.
+ * @return void
+ */
+ public function add_group($name, $config) {
+ if (isset($this->groups[$name])) {
+ throw new coding_exception(
+ "A YUI configuration group for '{$name}' already exists. " .
+ 'To make changes to this group use YUI_config->update_group().',
+ );
+ }
+ $this->groups[$name] = $config;
+ }
+
+ /**
+ * Update an existing group configuration
+ *
+ * Note, any existing configuration for that group will be wiped out.
+ * This includes module configuration.
+ *
+ * @param string $name The name of the group. This must be unique and
+ * not previously used.
+ * @param array $config The configuration for this group.
+ * @return void
+ */
+ public function update_group($name, $config) {
+ if (!isset($this->groups[$name])) {
+ throw new coding_exception(
+ 'The Moodle YUI module does not exist. ' .
+ 'You must define the moodle module config using YUI_config->add_module_config first.',
+ );
+ }
+ $this->groups[$name] = $config;
+ }
+
+ /**
+ * Set the value of a configuration function used by the YUI Loader's pattern testing.
+ *
+ * Only the body of the function should be passed, and not the whole function wrapper.
+ *
+ * The JS function your write will be passed a single argument 'name' containing the
+ * name of the module being loaded.
+ *
+ * @param string $function String the body of the JavaScript function. This should be used i
+ * @return string the name of the function to use in the group pattern configuration.
+ */
+ public function set_config_function($function) {
+ $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn';
+ if (isset($this->jsconfigfunctions[$configname])) {
+ throw new coding_exception(
+ "A YUI config function with this name already exists. Config function names must be unique.",
+ );
+ }
+ $this->jsconfigfunctions[$configname] = $function;
+ return '@' . $configname . '@';
+ }
+
+ /**
+ * Allow setting of the config function described in {@see set_config_function} from a file.
+ * The contents of this file are then passed to set_config_function.
+ *
+ * When jsrev is positive, the function is minified and stored in a MUC cache for subsequent uses.
+ *
+ * @param string $file The path to the JavaScript function used for YUI configuration.
+ * @return string the name of the function to use in the group pattern configuration.
+ */
+ public function set_config_source($file) {
+ global $CFG;
+ $cache = cache::make('core', 'yuimodules');
+
+ // Attempt to get the metadata from the cache.
+ $keyname = 'configfn_' . $file;
+ $fullpath = $CFG->dirroot . '/' . $file;
+ if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
+ $cache->delete($keyname);
+ $configfn = file_get_contents($fullpath);
+ } else {
+ $configfn = $cache->get($keyname);
+ if ($configfn === false) {
+ require_once($CFG->libdir . '/jslib.php');
+ $configfn = core_minify::js_files([$fullpath]);
+ $cache->set($keyname, $configfn);
+ }
+ }
+ return $this->set_config_function($configfn);
+ }
+
+ /**
+ * Retrieve the list of JavaScript functions for YUI_config groups.
+ *
+ * @return string The complete set of config functions
+ */
+ public function get_config_functions() {
+ $configfunctions = '';
+ foreach ($this->jsconfigfunctions as $functionname => $function) {
+ $configfunctions .= "var {$functionname} = function(me) {";
+ $configfunctions .= $function;
+ $configfunctions .= "};\n";
+ }
+ return $configfunctions;
+ }
+
+ /**
+ * Update the header JavaScript with any required modification for the YUI Loader.
+ *
+ * @param string $js String The JavaScript to manipulate.
+ * @return string the modified JS string.
+ */
+ public function update_header_js($js) {
+ // Update the names of the the configFn variables.
+ // The PHP json_encode function cannot handle literal names so we have to wrap
+ // them in @ and then replace them with literals of the same function name.
+ foreach ($this->jsconfigfunctions as $functionname => $function) {
+ $js = str_replace('"@' . $functionname . '@"', $functionname, $js);
+ }
+ return $js;
+ }
+
+ /**
+ * Add configuration for a specific module.
+ *
+ * @param string $name The name of the module to add configuration for.
+ * @param array $config The configuration for the specified module.
+ * @param string $group The name of the group to add configuration for.
+ * If not specified, then this module is added to the global
+ * configuration.
+ * @return void
+ */
+ public function add_module_config($name, $config, $group = null) {
+ if ($group) {
+ if (!isset($this->groups[$name])) {
+ throw new coding_exception(
+ 'The Moodle YUI module does not exist. ' .
+ 'You must define the moodle module config using YUI_config->add_module_config first.',
+ );
+ }
+ if (!isset($this->groups[$group]['modules'])) {
+ $this->groups[$group]['modules'] = [];
+ }
+ $modules = &$this->groups[$group]['modules'];
+ } else {
+ $modules = &$this->modules;
+ }
+ $modules[$name] = $config;
+ }
+
+ /**
+ * Add the moodle YUI module metadata for the moodle group to the YUI_config instance.
+ *
+ * If js caching is disabled, metadata will not be served causing YUI to calculate
+ * module dependencies as each module is loaded.
+ *
+ * If metadata does not exist it will be created and stored in a MUC entry.
+ *
+ * @return void
+ */
+ public function add_moodle_metadata() {
+ global $CFG;
+ if (!isset($this->groups['moodle'])) {
+ throw new coding_exception(
+ 'The Moodle YUI module does not exist. ' .
+ 'You must define the moodle module config using YUI_config->add_module_config first.',
+ );
+ }
+
+ if (!isset($this->groups['moodle']['modules'])) {
+ $this->groups['moodle']['modules'] = [];
+ }
+
+ $cache = cache::make('core', 'yuimodules');
+ if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
+ $metadata = [];
+ $metadata = $this->get_moodle_metadata();
+ $cache->delete('metadata');
+ } else {
+ // Attempt to get the metadata from the cache.
+ if (!$metadata = $cache->get('metadata')) {
+ $metadata = $this->get_moodle_metadata();
+ $cache->set('metadata', $metadata);
+ }
+ }
+
+ // Merge with any metadata added specific to this page which was added manually.
+ $this->groups['moodle']['modules'] = array_merge(
+ $this->groups['moodle']['modules'],
+ $metadata
+ );
+ }
+
+ /**
+ * Determine the module metadata for all moodle YUI modules.
+ *
+ * This works through all modules capable of serving YUI modules, and attempts to get
+ * metadata for each of those modules.
+ *
+ * @return array of module metadata
+ */
+ private function get_moodle_metadata() {
+ $moodlemodules = [];
+ // Core isn't a plugin type or subsystem - handle it seperately.
+ if ($module = $this->get_moodle_path_metadata(core_component::get_component_directory('core'))) {
+ $moodlemodules = array_merge($moodlemodules, $module);
+ }
+
+ // Handle other core subsystems.
+ $subsystems = core_component::get_core_subsystems();
+ foreach ($subsystems as $subsystem => $path) {
+ if (is_null($path)) {
+ continue;
+ }
+ if ($module = $this->get_moodle_path_metadata($path)) {
+ $moodlemodules = array_merge($moodlemodules, $module);
+ }
+ }
+
+ // And finally the plugins.
+ $plugintypes = core_component::get_plugin_types();
+ foreach ($plugintypes as $plugintype => $pathroot) {
+ $pluginlist = core_component::get_plugin_list($plugintype);
+ foreach ($pluginlist as $plugin => $path) {
+ if ($module = $this->get_moodle_path_metadata($path)) {
+ $moodlemodules = array_merge($moodlemodules, $module);
+ }
+ }
+ }
+
+ return $moodlemodules;
+ }
+
+ /**
+ * Helper function process and return the YUI metadata for all of the modules under the specified path.
+ *
+ * @param string $path the UNC path to the YUI src directory.
+ * @return array the complete array for frankenstyle directory.
+ */
+ private function get_moodle_path_metadata($path) {
+ // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json.
+ $baseyui = $path . '/yui/src';
+ $modules = [];
+ if (is_dir($baseyui)) {
+ $items = new DirectoryIterator($baseyui);
+ foreach ($items as $item) {
+ if ($item->isDot() || !$item->isDir()) {
+ continue;
+ }
+ $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json');
+ if (!is_readable($metafile)) {
+ continue;
+ }
+ $metadata = file_get_contents($metafile);
+ $modules = array_merge($modules, (array) json_decode($metadata));
+ }
+ }
+ return $modules;
+ }
+
+ /**
+ * Define YUI modules which we have been required to patch between releases.
+ *
+ * We must do this because we aggressively cache content on the browser, and we must also override use of the
+ * external CDN which will serve the true authoritative copy of the code without our patches.
+ *
+ * @param string $combobase The local combobase
+ * @param string $yuiversion The current YUI version
+ * @param int $patchlevel The patch level we're working to for YUI
+ * @param array $patchedmodules An array containing the names of the patched modules
+ * @return void
+ */
+ public function define_patched_core_modules($combobase, $yuiversion, $patchlevel, $patchedmodules) {
+ // The version we use is suffixed with a patchlevel so that we can get additional revisions between YUI releases.
+ $subversion = $yuiversion . '_' . $patchlevel;
+
+ if ($this->comboBase == $combobase) {
+ // If we are using the local combobase in the loader, we can add a group and still make use of the combo
+ // loader. We just need to specify a different root which includes a slightly different YUI version number
+ // to include our patchlevel.
+ $patterns = [];
+ $modules = [];
+ foreach ($patchedmodules as $modulename) {
+ // We must define the pattern and module here so that the loader uses our group configuration instead of
+ // the standard module definition. We may lose some metadata provided by upstream but this will be
+ // loaded when the module is loaded anyway.
+ $patterns[$modulename] = [
+ 'group' => 'yui-patched',
+ ];
+ $modules[$modulename] = [];
+ }
+
+ // Actually add the patch group here.
+ $this->add_group('yui-patched', [
+ 'combine' => true,
+ 'root' => $subversion . '/',
+ 'patterns' => $patterns,
+ 'modules' => $modules,
+ ]);
+ } else {
+ // The CDN is in use - we need to instead use the local combobase for this module and override the modules
+ // definition. We cannot use the local base - we must use the combobase because we cannot invalidate the
+ // local base in browser caches.
+ $fullpathbase = $combobase . $subversion . '/';
+ foreach ($patchedmodules as $modulename) {
+ $this->modules[$modulename] = [
+ 'fullpath' => $fullpathbase . $modulename . '/' . $modulename . '-min.js',
+ ];
+ }
+ }
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(yui::class, \YUI_config::class);
diff --git a/lib/classes/output/select_menu.php b/lib/classes/output/select_menu.php
index eb487911d1761..e642c70b6c69c 100644
--- a/lib/classes/output/select_menu.php
+++ b/lib/classes/output/select_menu.php
@@ -18,8 +18,6 @@
namespace core\output;
-use renderer_base;
-
/**
* A single-select combobox widget that is functionally similar to an HTML select element.
*
@@ -28,7 +26,7 @@
* @copyright 2022 Shamim Rezaie
+ * $THEME->layouts = array(
+ * // Most pages - if we encounter an unknown or a missing page type, this one is used.
+ * 'standard' => array(
+ * 'theme' = 'mytheme',
+ * 'file' => 'normal.php',
+ * 'regions' => array('side-pre', 'side-post'),
+ * 'defaultregion' => 'side-post'
+ * ),
+ * // The site home page.
+ * 'home' => array(
+ * 'theme' = 'mytheme',
+ * 'file' => 'home.php',
+ * 'regions' => array('side-pre', 'side-post'),
+ * 'defaultregion' => 'side-post'
+ * ),
+ * // ...
+ * );
+ *
+ *
+ * 'theme' name of the theme where is the layout located
+ * 'file' is the layout file to use for this type of page.
+ * layout files are stored in layout subfolder
+ * 'regions' This lists the regions on the page where blocks may appear. For
+ * each region you list here, your layout file must include a call to
+ * + * echo $OUTPUT->blocks_for_region($regionname); + *+ * or equivalent so that the blocks are actually visible. + * + * 'defaultregion' If the list of regions is non-empty, then you must pick + * one of the one of them as 'default'. This has two meanings. First, this is + * where new blocks are added. Second, if there are any blocks associated with + * the page, but in non-existent regions, they appear here. (Imaging, for example, + * that someone added blocks using a different theme that used different region + * names, and then switched to this theme.) + */ + public $layouts = []; + + /** + * @var string Name of the renderer factory class to use. Must implement the + * {@see renderer_factory} interface. + * + * This is an advanced feature. Moodle output is generated by 'renderers', + * you can customise the HTML that is output by writing custom renderers, + * and then you need to specify 'renderer factory' so that Moodle can find + * your renderers. + * + * There are some renderer factories supplied with Moodle. Please follow these + * links to see what they do. + *
-
+ *
- {@see standard_renderer_factory} - the default. + *
- {@see theme_overridden_renderer_factory} - use this if you want to write + * your own custom renderers in a lib.php file in this theme (or the parent theme). + *
There are no more open containers. This suggests there is a nesting problem.
' . + $this->output_log(), DEBUG_DEVELOPER); + return; + } + + $container = array_pop($this->opencontainers); + if ($container->type != $type) { + debugging('The type of container to be closed (' . $container->type . + ') does not match the type of the next open container (' . $type . + '). This suggests there is a nesting problem.
' . + $this->output_log(), DEBUG_DEVELOPER); + } + if ($this->isdebugging) { + $this->log('Close', $type); + } + return $container->closehtml; + } + + /** + * Close all but the last open container. This is useful in places like error + * handling, where you want to close all the open containers (apart from ) + * before outputting the error message. + * + * @param bool $shouldbenone assert that the stack should be empty now - causes a + * developer debug warning if it isn't. + * @return string the HTML required to close any open containers inside . + */ + public function pop_all_but_last($shouldbenone = false) { + if ($shouldbenone && count($this->opencontainers) != 1) { + debugging('Some HTML tags were opened in the body of the page but not closed.
' . + $this->output_log(), DEBUG_DEVELOPER); + } + $output = ''; + while (count($this->opencontainers) > 1) { + $container = array_pop($this->opencontainers); + $output .= $container->closehtml; + } + return $output; + } + + /** + * You can call this function if you want to throw away an instance of this + * class without properly emptying the stack (for example, in a unit test). + * Calling this method stops the destruct method from outputting a developer + * debug warning. After calling this method, the instance can no longer be used. + */ + public function discard() { + $this->opencontainers = null; + } + + /** + * Adds an entry to the log. + * + * @param string $action The name of the action + * @param string $type The type of action + */ + protected function log($action, $type) { + $this->log[] = '- ' . implode("\n", $this->log) . '
https://moodle.org
" @javascript Scenario: Add and remove auto-link prevention to URLs diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js index 085863073762b..a08c57003f0d1 100644 --- a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js +++ b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js @@ -1,3 +1,3 @@ -define("tiny_recordrtc/base_recorder",["exports","core/str","./common","core/pending","./options","editor_tiny/uploader","core/toast","core/modal_events","core/templates","core/notification","core/prefetch","core/local/modal/alert"],(function(_exports,_str,_common,_pending,_options,_uploader,_toast,ModalEvents,Templates,_notification,_prefetch,_alert){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_pending=_interopRequireDefault(_pending),_uploader=_interopRequireDefault(_uploader),ModalEvents=_interopRequireWildcard(ModalEvents),Templates=_interopRequireWildcard(Templates),_alert=_interopRequireDefault(_alert);return _exports.default=class{constructor(editor,modal){var obj,key,value;value=!1,(key="stopRequested")in(obj=this)?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,this.ready=!1,this.checkAndWarnAboutBrowserCompatibility()&&(this.editor=editor,this.config=(0,_options.getData)(editor).params,this.modal=modal,this.modalRoot=modal.getRoot()[0],this.startStopButton=this.modalRoot.querySelector('button[data-action="startstop"]'),this.uploadButton=this.modalRoot.querySelector('button[data-action="upload"]'),this.setRecordButtonState(!1),this.player=this.configurePlayer(),this.registerEventListeners(),this.ready=!0,this.captureUserMedia(),this.prefetchContent())}isReady(){return this.ready}configurePlayer(){throw new Error("configurePlayer() must be implemented in ".concat(this.constructor.name))}getSupportedTypes(){throw new Error("getSupportedTypes() must be implemented in ".concat(this.constructor.name))}getRecordingOptions(){throw new Error("getRecordingOptions() must be implemented in ".concat(this.constructor.name))}getFileName(prefix){throw new Error("getFileName() must be implemented in ".concat(this.constructor.name))}getMediaConstraints(){throw new Error("getMediaConstraints() must be implemented in ".concat(this.constructor.name))}playOnCapture(){return!1}getTimeLimit(){throw new Error("getTimeLimit() must be implemented in ".concat(this.constructor.name))}getEmbedTemplateName(){throw new Error("getEmbedTemplateName() must be implemented in ".concat(this.constructor.name))}static getModalClass(){throw new Error("getModalClass() must be implemented in ".concat(this.constructor.name))}getParsedRecordingOptions(){const compatTypes=this.getSupportedTypes().reduce(((result,type)=>(result.push(type),result.push(type.replace("=",":")),result)),[]).filter((type=>window.MediaRecorder.isTypeSupported(type))),options=this.getRecordingOptions();return 0!==compatTypes.length&&(options.mimeType=compatTypes[0]),window.console.info("Selected codec ".concat(options.mimeType," from ").concat(compatTypes.length," options."),compatTypes),options}async captureUserMedia(){try{const stream=await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());this.handleCaptureSuccess(stream)}catch(error){this.handleCaptureFailure(error)}}prefetchContent(){(0,_prefetch.prefetchStrings)(_common.component,["uploading","recordagain_title","recordagain_desc","discard_title","discard_desc","confirm_yes","recordinguploaded","maxfilesizehit","maxfilesizehit_title","uploadfailed"]),(0,_prefetch.prefetchTemplates)([this.getEmbedTemplateName(),"tiny_recordrtc/timeremaining"])}async displayAlert(title,content){const pendingPromise=new _pending.default("core/confirm:alert"),modal=await _alert.default.create({title:title,body:content,removeOnClose:!0});return modal.show(),pendingPromise.resolve(),modal}handleCaptureSuccess(stream){this.player.srcObject=stream,this.playOnCapture()&&(this.player.muted=!0,this.player.play()),this.stream=stream,this.setupPlayerSource(),this.setRecordButtonState(!0)}setupPlayerSource(){this.player.srcObject||(this.player.srcObject=this.stream,this.player.muted=!0,this.player.play())}setRecordButtonState(enabled){this.startStopButton.disabled=!enabled}setRecordButtonVisibility(visible){this.getButtonContainer("start-stop").classList.toggle("hide",!visible)}setUploadButtonState(enabled){this.uploadButton.disabled=!enabled}setUploadButtonVisibility(visible){this.getButtonContainer("upload").classList.toggle("hide",!visible)}handleCaptureFailure(error){var subject="gum".concat(error.name.replace("Error","").toLowerCase());this.displayAlert((0,_str.getString)("".concat(subject,"_title"),_common.component),(0,_str.getString)(subject,_common.component))}close(){this.modal.hide()}registerEventListeners(){this.modalRoot.addEventListener("click",this.handleModalClick.bind(this)),this.modal.getRoot().on(ModalEvents.outsideClick,this.outsideClickHandler.bind(this)),this.modal.getRoot().on(ModalEvents.hidden,(()=>{this.cleanupStream(),this.requestRecordingStop()}))}async outsideClickHandler(event){if(this.isRecording())event.preventDefault();else if(this.hasData()){event.preventDefault();try{await(0,_notification.saveCancelPromise)(await(0,_str.getString)("discard_title",_common.component),await(0,_str.getString)("discard_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),this.modal.hide()}catch(error){}}}handleModalClick(event){const button=event.target.closest("button");if(button&&button.dataset.action){const action=button.dataset.action;"startstop"===action&&this.handleRecordingStartStopRequested(),"upload"===action&&this.uploadRecording()}}handleRecordingStartStopRequested(){var _this$mediaRecorder;"recording"===(null===(_this$mediaRecorder=this.mediaRecorder)||void 0===_this$mediaRecorder?void 0:_this$mediaRecorder.state)?this.requestRecordingStop():this.startRecording()}async onMediaStopped(){var _this$getButtonContai;this.blob=new Blob(this.data.chunks,{type:this.mediaRecorder.mimeType}),this.player.srcObject=null,this.player.src=URL.createObjectURL(this.blob),this.setRecordButtonTextFromString("recordagain"),this.player.muted=!1,this.player.controls=!0,null===(_this$getButtonContai=this.getButtonContainer("player"))||void 0===_this$getButtonContai||_this$getButtonContai.classList.toggle("hide",!1),this.setUploadButtonVisibility(!0),this.setUploadButtonState(!0)}async uploadRecording(){if(0===this.data.chunks.length)return void this.displayAlert("norecordingfound");const fileName=this.getFileName((1e3*Math.random()).toString().replace(".",""));try{this.setRecordButtonVisibility(!1),this.setUploadButtonState(!1);const fileURL=await(0,_uploader.default)(this.editor,"media",this.blob,fileName,(progress=>{this.setUploadButtonTextProgress(progress)}));this.insertMedia(fileURL),this.close(),(0,_toast.add)(await(0,_str.getString)("recordinguploaded",_common.component))}catch(error){this.setUploadButtonState(!0),(0,_toast.add)(await(0,_str.getString)("uploadfailed",_common.component,{error:error}),{type:"error"})}}getButtonContainer(purpose){return this.modalRoot.querySelector('[data-purpose="'.concat(purpose,'-container"]'))}static isBrowserCompatible(){return this.checkSecure()&&this.hasUserMedia()}static async display(editor){const ModalClass=this.getModalClass(),modal=await ModalClass.create({templateContext:{},large:!0,removeOnClose:!0});return new this(editor,modal).isReady()&&modal.show(),modal}checkAndWarnAboutBrowserCompatibility(){return this.constructor.checkSecure()?!!this.constructor.hasUserMedia||((0,_str.getStrings)(["nowebrtc_title","nowebrtc"].map((key=>({key:key,component:_common.component})))).then((_ref2=>{let[title,message]=_ref2;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1):((0,_str.getStrings)(["insecurealert_title","insecurealert"].map((key=>({key:key,component:_common.component})))).then((_ref=>{let[title,message]=_ref;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1)}static hasUserMedia(){return navigator.mediaDevices&&window.MediaRecorder}static checkSecure(){return window.isSecureContext}async setStopRecordingButton(){const{html:html,js:js}=await Templates.renderForPromise("tiny_recordrtc/timeremaining",this.getTimeRemaining());Templates.replaceNodeContents(this.startStopButton,html,js),this.buttonTimer=setInterval(this.updateRecordButtonTime.bind(this),500)}updateRecordButtonTime(){const{remaining:remaining,minutes:minutes,seconds:seconds}=this.getTimeRemaining();remaining<0?this.requestRecordingStop():(this.startStopButton.querySelector('[data-type="minutes"]').textContent=minutes,this.startStopButton.querySelector('[data-type="seconds"]').textContent=seconds)}async setRecordButtonTextFromString(string){this.startStopButton.textContent=await(0,_str.getString)(string,_common.component)}async setUploadButtonTextProgress(progress){this.uploadButton.textContent=await(0,_str.getString)("uploading",_common.component,{progress:Math.round(100*progress)/100})}async resetUploadButtonText(){this.uploadButton.textContent=await(0,_str.getString)("upload",_common.component)}clearButtonTimer(){this.buttonTimer&&clearInterval(this.buttonTimer),this.buttonTimer=null}getTimeRemaining(){const now=(new Date).getTime(),remaining=Math.floor(this.getTimeLimit()-(now-this.startTime)/1e3),formatter=new Intl.NumberFormat(navigator.language,{minimumIntegerDigits:2}),seconds=formatter.format(remaining%60);return{remaining:remaining,minutes:formatter.format(Math.floor((remaining-seconds)/60)),seconds:seconds}}getMaxUploadSize(){return this.config.maxrecsize}requestRecordingStop(){this.mediaRecorder&&"inactive"!==this.mediaRecorder.state?this.stopRequested=!0:this.cleanupStream()}stopRecorder(){this.mediaRecorder.stop(),this.player.muted=!1}cleanupStream(){this.stream&&this.stream.getTracks().filter((track=>"ended"!==track.readyState)).forEach((track=>track.stop()))}handleStopped(){this.onMediaStopped(),this.clearButtonTimer()}handleStarted(){this.startTime=(new Date).getTime(),this.setStopRecordingButton()}handleDataAvailable(event){if(this.isRecording()){const newSize=this.data.blobSize+event.data.size;newSize>=this.getMaxUploadSize()?(this.stopRecorder(),this.displayFileLimitHitMessage()):(this.data.chunks.push(event.data),this.data.blobSize=newSize,this.stopRequested&&this.stopRecorder())}}async displayFileLimitHitMessage(){(0,_toast.add)(await(0,_str.getString)("maxfilesizehit",_common.component),{title:await(0,_str.getString)("maxfilesizehit_title",_common.component),type:"error"})}isRecording(){var _this$mediaRecorder2;return"recording"===(null===(_this$mediaRecorder2=this.mediaRecorder)||void 0===_this$mediaRecorder2?void 0:_this$mediaRecorder2.state)}hasData(){var _this$data;return!(null===(_this$data=this.data)||void 0===_this$data||!_this$data.blobSize)}async startRecording(){if(this.mediaRecorder){if(this.isRecording()&&this.mediaRecorder.stop(),this.hasData()){if(!await this.recordAgainConfirmation())return;this.setUploadButtonVisibility(!1),this.stream.active||await this.captureUserMedia()}this.mediaRecorder=null}this.mediaRecorder=new MediaRecorder(this.stream,this.getParsedRecordingOptions()),this.mediaRecorder.addEventListener("dataavailable",this.handleDataAvailable.bind(this)),this.mediaRecorder.addEventListener("stop",this.handleStopped.bind(this)),this.mediaRecorder.addEventListener("start",this.handleStarted.bind(this)),this.data={chunks:[],blobSize:0},this.setupPlayerSource(),this.stopRequested=!1,this.mediaRecorder.start(50)}async recordAgainConfirmation(){try{return await(0,_notification.saveCancelPromise)(await(0,_str.getString)("recordagain_title",_common.component),await(0,_str.getString)("recordagain_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),!0}catch{return!1}}async insertMedia(source){const{html:html}=await Templates.renderForPromise(this.getEmbedTemplateName(),this.getEmbedTemplateContext({source:source}));this.editor.insertContent(html)}getEmbedTemplateContext(templateContext){return templateContext}},_exports.default})); +define("tiny_recordrtc/base_recorder",["exports","core/str","./common","core/pending","./options","editor_tiny/uploader","core/toast","core/modal_events","core/templates","core/notification","core/prefetch","core/local/modal/alert"],(function(_exports,_str,_common,_pending,_options,_uploader,_toast,ModalEvents,Templates,_notification,_prefetch,_alert){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_pending=_interopRequireDefault(_pending),_uploader=_interopRequireDefault(_uploader),ModalEvents=_interopRequireWildcard(ModalEvents),Templates=_interopRequireWildcard(Templates),_alert=_interopRequireDefault(_alert);return _exports.default=class{constructor(editor,modal){_defineProperty(this,"stopRequested",!1),_defineProperty(this,"buttonTimer",null),_defineProperty(this,"pauseTime",null),_defineProperty(this,"startTime",null),this.ready=!1,this.checkAndWarnAboutBrowserCompatibility()&&(this.editor=editor,this.config=(0,_options.getData)(editor).params,this.modal=modal,this.modalRoot=modal.getRoot()[0],this.startStopButton=this.modalRoot.querySelector('button[data-action="startstop"]'),this.uploadButton=this.modalRoot.querySelector('button[data-action="upload"]'),this.pauseResumeButton=this.modalRoot.querySelector('button[data-action="pauseresume"]'),this.setRecordButtonState(!1),this.player=this.configurePlayer(),this.registerEventListeners(),this.ready=!0,this.captureUserMedia(),this.prefetchContent())}isReady(){return this.ready}configurePlayer(){throw new Error("configurePlayer() must be implemented in ".concat(this.constructor.name))}getSupportedTypes(){throw new Error("getSupportedTypes() must be implemented in ".concat(this.constructor.name))}getRecordingOptions(){throw new Error("getRecordingOptions() must be implemented in ".concat(this.constructor.name))}getFileName(prefix){throw new Error("getFileName() must be implemented in ".concat(this.constructor.name))}getMediaConstraints(){throw new Error("getMediaConstraints() must be implemented in ".concat(this.constructor.name))}playOnCapture(){return!1}getTimeLimit(){throw new Error("getTimeLimit() must be implemented in ".concat(this.constructor.name))}getEmbedTemplateName(){throw new Error("getEmbedTemplateName() must be implemented in ".concat(this.constructor.name))}static getModalClass(){throw new Error("getModalClass() must be implemented in ".concat(this.constructor.name))}getParsedRecordingOptions(){const compatTypes=this.getSupportedTypes().reduce(((result,type)=>(result.push(type),result.push(type.replace("=",":")),result)),[]).filter((type=>window.MediaRecorder.isTypeSupported(type))),options=this.getRecordingOptions();return 0!==compatTypes.length&&(options.mimeType=compatTypes[0]),window.console.info("Selected codec ".concat(options.mimeType," from ").concat(compatTypes.length," options."),compatTypes),options}async captureUserMedia(){try{const stream=await navigator.mediaDevices.getUserMedia(this.getMediaConstraints());this.handleCaptureSuccess(stream)}catch(error){this.handleCaptureFailure(error)}}prefetchContent(){(0,_prefetch.prefetchStrings)(_common.component,["uploading","recordagain_title","recordagain_desc","discard_title","discard_desc","confirm_yes","recordinguploaded","maxfilesizehit","maxfilesizehit_title","uploadfailed","pause","resume"]),(0,_prefetch.prefetchTemplates)([this.getEmbedTemplateName(),"tiny_recordrtc/timeremaining"])}async displayAlert(title,content){const pendingPromise=new _pending.default("core/confirm:alert"),modal=await _alert.default.create({title:title,body:content,removeOnClose:!0});return modal.show(),pendingPromise.resolve(),modal}handleCaptureSuccess(stream){this.player.srcObject=stream,this.playOnCapture()&&(this.player.muted=!0,this.player.play()),this.stream=stream,this.setupPlayerSource(),this.setRecordButtonState(!0)}setupPlayerSource(){this.player.srcObject||(this.player.srcObject=this.stream,this.player.muted=!0,this.player.play())}setRecordButtonState(enabled){this.startStopButton.disabled=!enabled}setRecordButtonVisibility(visible){this.getButtonContainer("start-stop").classList.toggle("hide",!visible)}setPauseButtonVisibility(visible){this.pauseResumeButton&&this.pauseResumeButton.classList.toggle("hidden",!visible)}setUploadButtonState(enabled){this.uploadButton.disabled=!enabled}setUploadButtonVisibility(visible){this.getButtonContainer("upload").classList.toggle("hide",!visible)}setPlayerState(state){var _this$getButtonContai;this.player.muted=!state,this.player.controls=state,null===(_this$getButtonContai=this.getButtonContainer("player"))||void 0===_this$getButtonContai||_this$getButtonContai.classList.toggle("hide",!state)}handleCaptureFailure(error){var subject="gum".concat(error.name.replace("Error","").toLowerCase());this.displayAlert((0,_str.getString)("".concat(subject,"_title"),_common.component),(0,_str.getString)(subject,_common.component))}close(){this.modal.hide()}registerEventListeners(){this.modalRoot.addEventListener("click",this.handleModalClick.bind(this)),this.modal.getRoot().on(ModalEvents.outsideClick,this.outsideClickHandler.bind(this)),this.modal.getRoot().on(ModalEvents.hidden,(()=>{this.cleanupStream(),this.requestRecordingStop()}))}async outsideClickHandler(event){if(this.isRecording()||this.isPaused())event.preventDefault();else if(this.hasData()){event.preventDefault();try{await(0,_notification.saveCancelPromise)(await(0,_str.getString)("discard_title",_common.component),await(0,_str.getString)("discard_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),this.modal.hide()}catch(error){}}}handleModalClick(event){const button=event.target.closest("button");if(button&&button.dataset.action){const action=button.dataset.action;"startstop"===action&&this.handleRecordingStartStopRequested(),"upload"===action&&this.uploadRecording(),"pauseresume"===action&&this.handleRecordingPauseResumeRequested()}}handleRecordingStartStopRequested(){this.isRecording()||this.isPaused()?this.requestRecordingStop():this.startRecording()}handleRecordingPauseResumeRequested(){this.isRecording()?this.mediaRecorder.pause():this.isPaused()&&this.mediaRecorder.resume()}async onMediaStopped(){this.blob=new Blob(this.data.chunks,{type:this.mediaRecorder.mimeType}),this.player.srcObject=null,this.player.src=URL.createObjectURL(this.blob),this.setRecordButtonTextFromString("recordagain"),this.setUploadButtonVisibility(!0),this.setPlayerState(!0),this.setUploadButtonState(!0),this.setPauseButtonVisibility(!1),"inactive"===this.mediaRecorder.state&&this.setPauseButtonTextFromString("pause")}async uploadRecording(){if(0===this.data.chunks.length)return void this.displayAlert("norecordingfound");const fileName=this.getFileName((1e3*Math.random()).toString().replace(".",""));try{this.setRecordButtonVisibility(!1),this.setUploadButtonState(!1);const fileURL=await(0,_uploader.default)(this.editor,"media",this.blob,fileName,(progress=>{this.setUploadButtonTextProgress(progress)}));this.insertMedia(fileURL),this.close(),(0,_toast.add)(await(0,_str.getString)("recordinguploaded",_common.component))}catch(error){this.setUploadButtonState(!0),(0,_toast.add)(await(0,_str.getString)("uploadfailed",_common.component,{error:error}),{type:"error"})}}getButtonContainer(purpose){return this.modalRoot.querySelector('[data-purpose="'.concat(purpose,'-container"]'))}static isBrowserCompatible(){return this.checkSecure()&&this.hasUserMedia()}static async display(editor){const ModalClass=this.getModalClass(),modal=await ModalClass.create({templateContext:{isallowedpausing:(0,_options.isPausingAllowed)(editor)},large:!0,removeOnClose:!0});return new this(editor,modal).isReady()&&modal.show(),modal}checkAndWarnAboutBrowserCompatibility(){return this.constructor.checkSecure()?!!this.constructor.hasUserMedia||((0,_str.getStrings)(["nowebrtc_title","nowebrtc"].map((key=>({key:key,component:_common.component})))).then((_ref2=>{let[title,message]=_ref2;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1):((0,_str.getStrings)(["insecurealert_title","insecurealert"].map((key=>({key:key,component:_common.component})))).then((_ref=>{let[title,message]=_ref;return(0,_toast.add)(message,{title:title,type:"error"})})).catch(),!1)}static hasUserMedia(){return navigator.mediaDevices&&window.MediaRecorder}static checkSecure(){return window.isSecureContext}async setStopRecordingButton(){const{html:html,js:js}=await Templates.renderForPromise("tiny_recordrtc/timeremaining",this.getTimeRemaining());Templates.replaceNodeContents(this.startStopButton,html,js),this.startButtonTimer()}updateRecordButtonTime(){const{remaining:remaining,minutes:minutes,seconds:seconds}=this.getTimeRemaining();remaining<0?this.requestRecordingStop():(this.startStopButton.querySelector('[data-type="minutes"]').textContent=minutes,this.startStopButton.querySelector('[data-type="seconds"]').textContent=seconds)}async setRecordButtonTextFromString(string){this.startStopButton.textContent=await(0,_str.getString)(string,_common.component)}async setPauseButtonTextFromString(string){this.pauseResumeButton&&(this.pauseResumeButton.textContent=await(0,_str.getString)(string,_common.component))}async setUploadButtonTextProgress(progress){this.uploadButton.textContent=await(0,_str.getString)("uploading",_common.component,{progress:Math.round(100*progress)/100})}async resetUploadButtonText(){this.uploadButton.textContent=await(0,_str.getString)("upload",_common.component)}clearButtonTimer(){this.buttonTimer&&clearInterval(this.buttonTimer),this.buttonTimer=null,this.pauseTime=null,this.startTime=null}pauseButtonTimer(){this.pauseTime=(new Date).getTime(),this.buttonTimer&&clearInterval(this.buttonTimer)}startButtonTimer(){if(null!==this.pauseTime){const pauseDuration=(new Date).getTime()-this.pauseTime;this.startTime+=pauseDuration,this.pauseTime=null}this.buttonTimer=setInterval(this.updateRecordButtonTime.bind(this),500)}getTimeRemaining(){let now=(new Date).getTime();null!==this.pauseTime&&(now=this.pauseTime);const remaining=Math.floor(this.getTimeLimit()-(now-this.startTime)/1e3),formatter=new Intl.NumberFormat(navigator.language,{minimumIntegerDigits:2}),seconds=formatter.format(remaining%60);return{remaining:remaining,minutes:formatter.format(Math.floor((remaining-seconds)/60)),seconds:seconds}}getMaxUploadSize(){return this.config.maxrecsize}requestRecordingStop(){this.mediaRecorder&&"inactive"!==this.mediaRecorder.state?(this.stopRequested=!0,this.isPaused()&&this.stopRecorder()):this.cleanupStream()}stopRecorder(){this.isPaused()&&(this.pauseTime=null),this.mediaRecorder.stop(),this.player.muted=!1}cleanupStream(){this.stream&&this.stream.getTracks().filter((track=>"ended"!==track.readyState)).forEach((track=>track.stop()))}handleStopped(){this.onMediaStopped(),this.clearButtonTimer()}handleStarted(){this.startTime=(new Date).getTime(),(0,_options.isPausingAllowed)(this.editor)&&!this.isPaused()&&this.setPauseButtonVisibility(!0),this.setStopRecordingButton()}handlePaused(){this.pauseButtonTimer(),this.setPauseButtonTextFromString("resume")}handleResume(){this.startButtonTimer(),this.setPauseButtonTextFromString("pause")}handleDataAvailable(event){if(this.isRecording()||this.isPaused()){const newSize=this.data.blobSize+event.data.size;newSize>=this.getMaxUploadSize()?(this.stopRecorder(),this.displayFileLimitHitMessage()):(this.data.chunks.push(event.data),this.data.blobSize=newSize,this.stopRequested&&this.stopRecorder())}}async displayFileLimitHitMessage(){(0,_toast.add)(await(0,_str.getString)("maxfilesizehit",_common.component),{title:await(0,_str.getString)("maxfilesizehit_title",_common.component),type:"error"})}isRecording(){var _this$mediaRecorder;return"recording"===(null===(_this$mediaRecorder=this.mediaRecorder)||void 0===_this$mediaRecorder?void 0:_this$mediaRecorder.state)}isPaused(){var _this$mediaRecorder2;return"paused"===(null===(_this$mediaRecorder2=this.mediaRecorder)||void 0===_this$mediaRecorder2?void 0:_this$mediaRecorder2.state)}hasData(){var _this$data;return!(null===(_this$data=this.data)||void 0===_this$data||!_this$data.blobSize)}async startRecording(){if(this.mediaRecorder){if((this.isRecording()||this.isPaused())&&this.mediaRecorder.stop(),this.hasData()){if(!await this.recordAgainConfirmation())return;this.setUploadButtonVisibility(!1),this.setPlayerState(!1),this.stream.active||await this.captureUserMedia()}this.mediaRecorder=null}this.mediaRecorder=new MediaRecorder(this.stream,this.getParsedRecordingOptions()),this.mediaRecorder.addEventListener("dataavailable",this.handleDataAvailable.bind(this)),this.mediaRecorder.addEventListener("stop",this.handleStopped.bind(this)),this.mediaRecorder.addEventListener("start",this.handleStarted.bind(this)),this.mediaRecorder.addEventListener("pause",this.handlePaused.bind(this)),this.mediaRecorder.addEventListener("resume",this.handleResume.bind(this)),this.data={chunks:[],blobSize:0},this.setupPlayerSource(),this.stopRequested=!1,this.mediaRecorder.start(50)}async recordAgainConfirmation(){try{return await(0,_notification.saveCancelPromise)(await(0,_str.getString)("recordagain_title",_common.component),await(0,_str.getString)("recordagain_desc",_common.component),await(0,_str.getString)("confirm_yes",_common.component)),!0}catch{return!1}}async insertMedia(source){const{html:html}=await Templates.renderForPromise(this.getEmbedTemplateName(),this.getEmbedTemplateContext({source:source}));this.editor.insertContent(html)}getEmbedTemplateContext(templateContext){return templateContext}},_exports.default})); //# sourceMappingURL=base_recorder.min.js.map \ No newline at end of file diff --git a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map index a9dbd3cebb052..9eb02d8395575 100644 --- a/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map +++ b/lib/editor/tiny/plugins/recordrtc/amd/build/base_recorder.min.js.map @@ -1 +1 @@ -{"version":3,"file":"base_recorder.min.js","sources":["../src/base_recorder.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see
-
+
diff --git a/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache b/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache
index dadd10ab72e83..fd340292987cb 100644
--- a/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache
+++ b/lib/editor/tiny/plugins/recordrtc/templates/screen_recorder.mustache
@@ -21,6 +21,7 @@
Example context (json):
{
+ "isallowedpausing": true
}
}}
{{< core/modal }}
@@ -47,10 +48,15 @@
+ {{#isallowedpausing}}
+
+ {{/isallowedpausing}}
-
+
diff --git a/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache b/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache
index 0c80b8e1ef4f2..2e2b00b9b297d 100644
--- a/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache
+++ b/lib/editor/tiny/plugins/recordrtc/templates/video_recorder.mustache
@@ -21,6 +21,7 @@
Example context (json):
{
+ "isallowedpausing": true
}
}}
{{!
@@ -53,10 +54,15 @@
+ {{#isallowedpausing}}
+
+ {{/isallowedpausing}}
- ";
+ echo "";
echo "\n";
}
diff --git a/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php b/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
index 97b73d21c7aa1..0544004355b55 100644
--- a/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
+++ b/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
@@ -508,8 +508,7 @@ public function getCode()
break;
case 'id_name':
switch ($token[0]) {
- // named arguments...
- case ':':
+ case $token[0] === ':' && $context !== 'instanceof':
if ($lastState === 'closure' && $context === 'root') {
$state = 'closure';
$code .= $id_start.$token;
diff --git a/lib/minify/matthiasmullie-minify/src/CSS.php b/lib/minify/matthiasmullie-minify/src/CSS.php
index 09cedeee3a064..4f56320c47459 100644
--- a/lib/minify/matthiasmullie-minify/src/CSS.php
+++ b/lib/minify/matthiasmullie-minify/src/CSS.php
@@ -106,8 +106,8 @@ protected function moveImportsToTop($content)
/**
* Combine CSS from import statements.
*
- * Import statements will be loaded and their content merged into the original
- * file, to save HTTP requests.
+ * \@import's will be loaded and their content merged into the original file,
+ * to save HTTP requests.
*
* @param string $source The file to combine imports for
* @param string $content The CSS content to combine imports for
@@ -316,7 +316,9 @@ public function execute($path = null, $parents = array())
$css = $this->replace($css);
$css = $this->stripWhitespace($css);
- $css = $this->shortenColors($css);
+ $css = $this->convertLegacyColors($css);
+ $css = $this->cleanupModernColors($css);
+ $css = $this->shortenHEXColors($css);
$css = $this->shortenZeroes($css);
$css = $this->shortenFontWeights($css);
$css = $this->stripEmptyTags($css);
@@ -480,64 +482,153 @@ protected function move(ConverterInterface $converter, $content)
}
/**
- * Shorthand hex color codes.
- * #FF0000 -> #F00.
+ * Shorthand HEX color codes.
+ * #FF0000FF -> #f00 -> red
+ * #FF00FF00 -> transparent.
*
- * @param string $content The CSS content to shorten the hex color codes for
+ * @param string $content The CSS content to shorten the HEX color codes for
*
* @return string
*/
- protected function shortenColors($content)
+ protected function shortenHexColors($content)
{
- $content = preg_replace('/(?<=[: ])#([0-9a-z])\\1([0-9a-z])\\2([0-9a-z])\\3(?:([0-9a-z])\\4)?(?=[; }])/i', '#$1$2$3$4', $content);
+ // shorten repeating patterns within HEX ..
+ $content = preg_replace('/(?<=[: ])#([0-9a-f])\\1([0-9a-f])\\2([0-9a-f])\\3(?:([0-9a-f])\\4)?(?=[; }])/i', '#$1$2$3$4', $content);
- // remove alpha channel if it's pointless...
- $content = preg_replace('/(?<=[: ])#([0-9a-z]{6})ff?(?=[; }])/i', '#$1', $content);
- $content = preg_replace('/(?<=[: ])#([0-9a-z]{3})f?(?=[; }])/i', '#$1', $content);
+ // remove alpha channel if it's pointless ..
+ $content = preg_replace('/(?<=[: ])#([0-9a-f]{6})ff(?=[; }])/i', '#$1', $content);
+ $content = preg_replace('/(?<=[: ])#([0-9a-f]{3})f(?=[; }])/i', '#$1', $content);
+
+ // replace `transparent` with shortcut ..
+ $content = preg_replace('/(?<=[: ])#[0-9a-f]{6}00(?=[; }])/i', '#fff0', $content);
$colors = array(
+ // make these more readable
+ '#00f' => 'blue',
+ '#dc143c' => 'crimson',
+ '#0ff' => 'cyan',
+ '#8b0000' => 'darkred',
+ '#696969' => 'dimgray',
+ '#ff69b4' => 'hotpink',
+ '#0f0' => 'lime',
+ '#fdf5e6' => 'oldlace',
+ '#87ceeb' => 'skyblue',
+ '#d8bfd8' => 'thistle',
// we can shorten some even more by replacing them with their color name
- '#F0FFFF' => 'azure',
- '#F5F5DC' => 'beige',
- '#A52A2A' => 'brown',
- '#FF7F50' => 'coral',
- '#FFD700' => 'gold',
+ '#f0ffff' => 'azure',
+ '#f5f5dc' => 'beige',
+ '#ffe4c4' => 'bisque',
+ '#a52a2a' => 'brown',
+ '#ff7f50' => 'coral',
+ '#ffd700' => 'gold',
'#808080' => 'gray',
'#008000' => 'green',
- '#4B0082' => 'indigo',
- '#FFFFF0' => 'ivory',
- '#F0E68C' => 'khaki',
- '#FAF0E6' => 'linen',
+ '#4b0082' => 'indigo',
+ '#fffff0' => 'ivory',
+ '#f0e68c' => 'khaki',
+ '#faf0e6' => 'linen',
'#800000' => 'maroon',
'#000080' => 'navy',
'#808000' => 'olive',
- '#CD853F' => 'peru',
- '#FFC0CB' => 'pink',
- '#DDA0DD' => 'plum',
+ '#ffa500' => 'orange',
+ '#da70d6' => 'orchid',
+ '#cd853f' => 'peru',
+ '#ffc0cb' => 'pink',
+ '#dda0dd' => 'plum',
'#800080' => 'purple',
- '#F00' => 'red',
- '#FA8072' => 'salmon',
- '#A0522D' => 'sienna',
- '#C0C0C0' => 'silver',
- '#FFFAFA' => 'snow',
- '#D2B48C' => 'tan',
- '#FF6347' => 'tomato',
- '#EE82EE' => 'violet',
- '#F5DEB3' => 'wheat',
+ '#f00' => 'red',
+ '#fa8072' => 'salmon',
+ '#a0522d' => 'sienna',
+ '#c0c0c0' => 'silver',
+ '#fffafa' => 'snow',
+ '#d2b48c' => 'tan',
+ '#008080' => 'teal',
+ '#ff6347' => 'tomato',
+ '#ee82ee' => 'violet',
+ '#f5deb3' => 'wheat',
// or the other way around
- 'WHITE' => '#fff',
- 'BLACK' => '#000',
+ 'black' => '#000',
+ 'fuchsia' => '#f0f',
+ 'magenta' => '#f0f',
+ 'white' => '#fff',
+ 'yellow' => '#ff0',
+ // and also `transparent`
+ 'transparent' => '#fff0',
);
return preg_replace_callback(
'/(?<=[: ])(' . implode('|', array_keys($colors)) . ')(?=[; }])/i',
function ($match) use ($colors) {
- return $colors[strtoupper($match[0])];
+ return $colors[strtolower($match[0])];
+ },
+ $content
+ );
+ }
+
+ /**
+ * Convert RGB|HSL color codes.
+ * rgb(255,0,0,.5) -> rgb(255 0 0 / .5).
+ * rgb(255,0,0) -> #f00.
+ *
+ * @param string $content The CSS content to shorten the RGB color codes for
+ *
+ * @return string
+ */
+ protected function convertLegacyColors($content)
+ {
+ /*
+ https://drafts.csswg.org/css-color/#color-syntax-legacy
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl
+ */
+
+ // convert legacy color syntax
+ $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content);
+ $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*\)/i', '$1($2 $3 $4)', $content);
+ $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content);
+ $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*\)/i', '$1($2 $3 $4)', $content);
+
+ // convert `rgb` to `hex`
+ $dec = '([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])';
+ return preg_replace_callback(
+ "/rgb\($dec $dec $dec\)/i",
+ function ($match) {
+ return sprintf('#%02x%02x%02x', $match[1], $match[2], $match[3]);
},
$content
);
}
+ /**
+ * Cleanup RGB|HSL|HWB|LCH|LAB
+ * rgb(255 0 0 / 1) -> rgb(255 0 0).
+ * rgb(255 0 0 / 0) -> transparent.
+ *
+ * @param string $content The CSS content to cleanup HSL|HWB|LCH|LAB
+ *
+ * @return string
+ */
+ protected function cleanupModernColors($content)
+ {
+ /*
+ https://drafts.csswg.org/css-color/#color-syntax-modern
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hwb
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lch
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lab
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklab
+ */
+ $tag = '(rgb|hsl|hwb|(?:(?:ok)?(?:lch|lab)))';
+
+ // remove alpha channel if it's pointless ..
+ $content = preg_replace('/' . $tag . '\(\s*([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+\/\s+1(?:(?:\.\d?)*|00%)?\s*\)/i', '$1($2 $3 $4)', $content);
+
+ // replace `transparent` with shortcut ..
+ $content = preg_replace('/' . $tag . '\(\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+\/\s+0(?:[\.0%]*)?\s*\)/i', '#fff0', $content);
+
+ return $content;
+ }
+
/**
* Shorten CSS font weights.
*
diff --git a/lib/minify/matthiasmullie-minify/src/JS.php b/lib/minify/matthiasmullie-minify/src/JS.php
index d592b08bb33f5..9cf43a2e742a3 100644
--- a/lib/minify/matthiasmullie-minify/src/JS.php
+++ b/lib/minify/matthiasmullie-minify/src/JS.php
@@ -122,9 +122,6 @@ class JS extends Minify
*/
protected $operatorsAfter = array();
- /**
- * {@inheritdoc}
- */
public function __construct()
{
call_user_func_array(array('\\MatthiasMullie\Minify\\Minify', '__construct'), func_get_args());
diff --git a/lib/minify/matthiasmullie-minify/src/Minify.php b/lib/minify/matthiasmullie-minify/src/Minify.php
index f77478bebb71f..29e6eb8c00af5 100644
--- a/lib/minify/matthiasmullie-minify/src/Minify.php
+++ b/lib/minify/matthiasmullie-minify/src/Minify.php
@@ -270,7 +270,7 @@ protected function stripMultilineComments()
$minifier = $this;
$callback = function ($match) use ($minifier) {
$count = count($minifier->extracted);
- $placeholder = '/*'.$count.'*/';
+ $placeholder = '/*' . $count . '*/';
$minifier->extracted[$placeholder] = $match[0];
return $placeholder;
@@ -494,14 +494,20 @@ protected function canImportFile($path)
$parsed = parse_url($path);
if (
// file is elsewhere
- isset($parsed['host']) ||
+ isset($parsed['host'])
// file responds to queries (may change, or need to bypass cache)
- isset($parsed['query'])
+ || isset($parsed['query'])
) {
return false;
}
- return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path);
+ try {
+ return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path);
+ }
+ // catch openbasedir exceptions which are not caught by @ on is_file()
+ catch (\Exception $e) {
+ return false;
+ }
}
/**
@@ -534,9 +540,9 @@ protected function openFileForWriting($path)
protected function writeToFile($handler, $content, $path = '')
{
if (
- !is_resource($handler) ||
- ($result = @fwrite($handler, $content)) === false ||
- ($result < strlen($content))
+ !is_resource($handler)
+ || ($result = @fwrite($handler, $content)) === false
+ || ($result < strlen($content))
) {
throw new IOException('The file "' . $path . '" could not be written to. Check your disk space and file permissions.');
}
diff --git a/lib/modinfolib.php b/lib/modinfolib.php
index 06ed6cc8ddc65..5c6899cf94d7b 100644
--- a/lib/modinfolib.php
+++ b/lib/modinfolib.php
@@ -93,6 +93,12 @@ class course_modinfo {
*/
private $delegatedsections;
+ /**
+ * Index of sections delegated by course modules, indexed by course module instance.
+ * @var null|section_info[]
+ */
+ private ?array $delegatedbycm = null;
+
/**
* User ID
* @var int
@@ -139,6 +145,7 @@ class course_modinfo {
'cms' => 'get_cms',
'instances' => 'get_instances',
'groups' => 'get_groups_all',
+ 'delegatedbycm' => 'get_sections_delegated_by_cm',
);
/**
@@ -410,6 +417,33 @@ public function has_delegated_sections(): bool {
return !empty($this->delegatedsections);
}
+ /**
+ * Gets data about section delegated by course modules.
+ *
+ * @return section_info[] sections array indexed by course module ID
+ */
+ public function get_sections_delegated_by_cm(): array {
+ if (!is_null($this->delegatedbycm)) {
+ return $this->delegatedbycm;
+ }
+ $this->delegatedbycm = [];
+ foreach ($this->delegatedsections as $componentsections) {
+ foreach ($componentsections as $section) {
+ $delegateinstance = $section->get_component_instance();
+ // We only return sections delegated by course modules. Sections delegated to other
+ // types of components must implement their own methods to get the section.
+ if (!$delegateinstance || !($delegateinstance instanceof \core_courseformat\sectiondelegatemodule)) {
+ continue;
+ }
+ if (!$cm = $delegateinstance->get_cm()) {
+ continue;
+ }
+ $this->delegatedbycm[$cm->id] = $section;
+ }
+ }
+ return $this->delegatedbycm;
+ }
+
/**
* Static cache for generated course_modinfo instances
*
@@ -2171,6 +2205,19 @@ public function get_course_module_record($additionalfields = false) {
return $cmrecord;
}
+ /**
+ * Returns the section delegated by this module, if any.
+ *
+ * @return ?section_info
+ */
+ public function get_delegated_section_info(): ?section_info {
+ $delegatedsections = $this->modinfo->get_sections_delegated_by_cm();
+ if (!array_key_exists($this->id, $delegatedsections)) {
+ return null;
+ }
+ return $delegatedsections[$this->id];
+ }
+
// Set functions
////////////////
@@ -2602,10 +2649,13 @@ private function update_user_visible() {
$this->availableinfo = '';
}
+ $capabilities = [
+ 'moodle/course:manageactivities',
+ 'moodle/course:activityvisibility',
+ 'moodle/course:viewhiddenactivities',
+ ];
$this->uservisibleoncoursepage = $this->uservisible &&
- ($this->visibleoncoursepage ||
- has_capability('moodle/course:manageactivities', $this->get_context(), $userid) ||
- has_capability('moodle/course:activityvisibility', $this->get_context(), $userid));
+ ($this->visibleoncoursepage || has_any_capability($capabilities, $this->get_context(), $userid));
// Activity that is not available, not hidden from course page and has availability
// info is actually visible on the course page (with availability info and without a link).
if (!$this->uservisible && $this->visibleoncoursepage && $this->availableinfo) {
diff --git a/lib/moodlelib.php b/lib/moodlelib.php
index a68bb235f0fc6..c3c1f4471a4b4 100644
--- a/lib/moodlelib.php
+++ b/lib/moodlelib.php
@@ -7128,172 +7128,20 @@ function get_list_of_themes() {
}
/**
- * Factory function for emoticon_manager
+ * Factory function for {@see \core\emoticon_manager}
*
- * @return emoticon_manager singleton
+ * @return \core\emoticon_manager singleton
*/
-function get_emoticon_manager() {
+function get_emoticon_manager(): \core\emoticon_manager {
static $singleton = null;
if (is_null($singleton)) {
- $singleton = new emoticon_manager();
+ $singleton = new \core\emoticon_manager();
}
return $singleton;
}
-/**
- * Provides core support for plugins that have to deal with emoticons (like HTML editor or emoticon filter).
- *
- * Whenever this manager mentiones 'emoticon object', the following data
- * structure is expected: stdClass with properties text, imagename, imagecomponent,
- * altidentifier and altcomponent
- *
- * @see admin_setting_emoticons
- *
- * @copyright 2010 David Mudrak
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class emoticon_manager {
-
- /**
- * Returns the currently enabled emoticons
- *
- * @param boolean $selectable - If true, only return emoticons that should be selectable from a list.
- * @return array of emoticon objects
- */
- public function get_emoticons($selectable = false) {
- global $CFG;
- $notselectable = ['martin', 'egg'];
-
- if (empty($CFG->emoticons)) {
- return array();
- }
-
- $emoticons = $this->decode_stored_config($CFG->emoticons);
-
- if (!is_array($emoticons)) {
- // Something is wrong with the format of stored setting.
- debugging('Invalid format of emoticons setting, please resave the emoticons settings form', DEBUG_NORMAL);
- return array();
- }
- if ($selectable) {
- foreach ($emoticons as $index => $emote) {
- if (in_array($emote->altidentifier, $notselectable)) {
- // Skip this one.
- unset($emoticons[$index]);
- }
- }
- }
-
- return $emoticons;
- }
-
- /**
- * Converts emoticon object into renderable pix_emoticon object
- *
- * @param stdClass $emoticon emoticon object
- * @param array $attributes explicit HTML attributes to set
- * @return pix_emoticon
- */
- public function prepare_renderable_emoticon(stdClass $emoticon, array $attributes = array()) {
- $stringmanager = get_string_manager();
- if ($stringmanager->string_exists($emoticon->altidentifier, $emoticon->altcomponent)) {
- $alt = get_string($emoticon->altidentifier, $emoticon->altcomponent);
- } else {
- $alt = s($emoticon->text);
- }
- return new pix_emoticon($emoticon->imagename, $alt, $emoticon->imagecomponent, $attributes);
- }
-
- /**
- * Encodes the array of emoticon objects into a string storable in config table
- *
- * @see self::decode_stored_config()
- * @param array $emoticons array of emtocion objects
- * @return string
- */
- public function encode_stored_config(array $emoticons) {
- return json_encode($emoticons);
- }
-
- /**
- * Decodes the string into an array of emoticon objects
- *
- * @see self::encode_stored_config()
- * @param string $encoded
- * @return array|null
- */
- public function decode_stored_config($encoded) {
- $decoded = json_decode($encoded);
- if (!is_array($decoded)) {
- return null;
- }
- return $decoded;
- }
-
- /**
- * Returns default set of emoticons supported by Moodle
- *
- * @return array of sdtClasses
- */
- public function default_emoticons() {
- return array(
- $this->prepare_emoticon_object(":-)", 's/smiley', 'smiley'),
- $this->prepare_emoticon_object(":)", 's/smiley', 'smiley'),
- $this->prepare_emoticon_object(":-D", 's/biggrin', 'biggrin'),
- $this->prepare_emoticon_object(";-)", 's/wink', 'wink'),
- $this->prepare_emoticon_object(":-/", 's/mixed', 'mixed'),
- $this->prepare_emoticon_object("V-.", 's/thoughtful', 'thoughtful'),
- $this->prepare_emoticon_object(":-P", 's/tongueout', 'tongueout'),
- $this->prepare_emoticon_object(":-p", 's/tongueout', 'tongueout'),
- $this->prepare_emoticon_object("B-)", 's/cool', 'cool'),
- $this->prepare_emoticon_object("^-)", 's/approve', 'approve'),
- $this->prepare_emoticon_object("8-)", 's/wideeyes', 'wideeyes'),
- $this->prepare_emoticon_object(":o)", 's/clown', 'clown'),
- $this->prepare_emoticon_object(":-(", 's/sad', 'sad'),
- $this->prepare_emoticon_object(":(", 's/sad', 'sad'),
- $this->prepare_emoticon_object("8-.", 's/shy', 'shy'),
- $this->prepare_emoticon_object(":-I", 's/blush', 'blush'),
- $this->prepare_emoticon_object(":-X", 's/kiss', 'kiss'),
- $this->prepare_emoticon_object("8-o", 's/surprise', 'surprise'),
- $this->prepare_emoticon_object("P-|", 's/blackeye', 'blackeye'),
- $this->prepare_emoticon_object("8-[", 's/angry', 'angry'),
- $this->prepare_emoticon_object("(grr)", 's/angry', 'angry'),
- $this->prepare_emoticon_object("xx-P", 's/dead', 'dead'),
- $this->prepare_emoticon_object("|-.", 's/sleepy', 'sleepy'),
- $this->prepare_emoticon_object("}-]", 's/evil', 'evil'),
- $this->prepare_emoticon_object("(h)", 's/heart', 'heart'),
- $this->prepare_emoticon_object("(heart)", 's/heart', 'heart'),
- $this->prepare_emoticon_object("(y)", 's/yes', 'yes', 'core'),
- $this->prepare_emoticon_object("(n)", 's/no', 'no', 'core'),
- $this->prepare_emoticon_object("(martin)", 's/martin', 'martin'),
- $this->prepare_emoticon_object("( )", 's/egg', 'egg'),
- );
- }
-
- /**
- * Helper method preparing the stdClass with the emoticon properties
- *
- * @param string|array $text or array of strings
- * @param string $imagename to be used by {@link pix_emoticon}
- * @param string $altidentifier alternative string identifier, null for no alt
- * @param string $altcomponent where the alternative string is defined
- * @param string $imagecomponent to be used by {@link pix_emoticon}
- * @return stdClass
- */
- protected function prepare_emoticon_object($text, $imagename, $altidentifier = null,
- $altcomponent = 'core_pix', $imagecomponent = 'core') {
- return (object)array(
- 'text' => $text,
- 'imagename' => $imagename,
- 'imagecomponent' => $imagecomponent,
- 'altidentifier' => $altidentifier,
- 'altcomponent' => $altcomponent,
- );
- }
-}
-
// ENVIRONMENT CHECKING.
/**
@@ -9951,9 +9799,11 @@ function check_consecutive_identical_characters($password, $maxchars) {
/**
* Helper function to do partial function binding.
- * so we can use it for preg_replace_callback, for example
- * this works with php functions, user functions, static methods and class methods
- * it returns you a callback that you can pass on like so:
+ *
+ * This is useful for cases such as preg_replace_callback where you may want to partially bind values.
+ *
+ * The use of named arguments is recommended for clarity.
+ * Please note that providing arguments in a different order may have mixed results for built-in functions.
*
* $callback = partial('somefunction', $arg1, $arg2);
* or
@@ -9964,45 +9814,12 @@ function check_consecutive_identical_characters($password, $maxchars) {
*
* and then the arguments that are passed through at calltime are appended to the argument list.
*
- * @param mixed $function a php callback
- * @param mixed $arg1,... $argv arguments to partially bind with
- * @return array Array callback
- */
-function partial() {
- if (!class_exists('partial')) {
- /**
- * Used to manage function binding.
- * @copyright 2009 Penny Leach
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class partial{
- /** @var array */
- public $values = array();
- /** @var string The function to call as a callback. */
- public $func;
- /**
- * Constructor
- * @param string $func
- * @param array $args
- */
- public function __construct($func, $args) {
- $this->values = $args;
- $this->func = $func;
- }
- /**
- * Calls the callback function.
- * @return mixed
- */
- public function method() {
- $args = func_get_args();
- return call_user_func_array($this->func, array_merge($this->values, $args));
- }
- }
- }
- $args = func_get_args();
- $func = array_shift($args);
- $p = new partial($func, $args);
- return array($p, 'method');
+ * @param callable $function a php callback
+ * @param mixed ...$initialargs The arguments to provide for the initial bind
+ * @return callable
+ */
+function partial(callable $callable, ...$initialargs): callable {
+ return fn (...$args) => $callable(...$initialargs, ...$args);
}
/**
@@ -10183,256 +10000,6 @@ function unserialize_object(string $input): stdClass {
return (object) $instance;
}
-/**
- * The lang_string class
- *
- * This special class is used to create an object representation of a string request.
- * It is special because processing doesn't occur until the object is first used.
- * The class was created especially to aid performance in areas where strings were
- * required to be generated but were not necessarily used.
- * As an example the admin tree when generated uses over 1500 strings, of which
- * normally only 1/3 are ever actually printed at any time.
- * The performance advantage is achieved by not actually processing strings that
- * arn't being used, as such reducing the processing required for the page.
- *
- * How to use the lang_string class?
- * There are two methods of using the lang_string class, first through the
- * forth argument of the get_string function, and secondly directly.
- * The following are examples of both.
- * 1. Through get_string calls e.g.
- * $string = get_string($identifier, $component, $a, true);
- * $string = get_string('yes', 'moodle', null, true);
- * 2. Direct instantiation
- * $string = new lang_string($identifier, $component, $a, $lang);
- * $string = new lang_string('yes');
- *
- * How do I use a lang_string object?
- * The lang_string object makes use of a magic __toString method so that you
- * are able to use the object exactly as you would use a string in most cases.
- * This means you are able to collect it into a variable and then directly
- * echo it, or concatenate it into another string, or similar.
- * The other thing you can do is manually get the string by calling the
- * lang_strings out method e.g.
- * $string = new lang_string('yes');
- * $string->out();
- * Also worth noting is that the out method can take one argument, $lang which
- * allows the developer to change the language on the fly.
- *
- * When should I use a lang_string object?
- * The lang_string object is designed to be used in any situation where a
- * string may not be needed, but needs to be generated.
- * The admin tree is a good example of where lang_string objects should be
- * used.
- * A more practical example would be any class that requries strings that may
- * not be printed (after all classes get renderer by renderers and who knows
- * what they will do ;))
- *
- * When should I not use a lang_string object?
- * Don't use lang_strings when you are going to use a string immediately.
- * There is no need as it will be processed immediately and there will be no
- * advantage, and in fact perhaps a negative hit as a class has to be
- * instantiated for a lang_string object, however get_string won't require
- * that.
- *
- * Limitations:
- * 1. You cannot use a lang_string object as an array offset. Doing so will
- * result in PHP throwing an error. (You can use it as an object property!)
- *
- * @package core
- * @category string
- * @copyright 2011 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class lang_string {
-
- /** @var string The strings identifier */
- protected $identifier;
- /** @var string The strings component. Default '' */
- protected $component = '';
- /** @var array|stdClass Any arguments required for the string. Default null */
- protected $a = null;
- /** @var string The language to use when processing the string. Default null */
- protected $lang = null;
-
- /** @var string The processed string (once processed) */
- protected $string = null;
-
- /**
- * A special boolean. If set to true then the object has been woken up and
- * cannot be regenerated. If this is set then $this->string MUST be used.
- * @var bool
- */
- protected $forcedstring = false;
-
- /**
- * Constructs a lang_string object
- *
- * This function should do as little processing as possible to ensure the best
- * performance for strings that won't be used.
- *
- * @param string $identifier The strings identifier
- * @param string $component The strings component
- * @param stdClass|array|mixed $a Any arguments the string requires
- * @param string $lang The language to use when processing the string.
- * @throws coding_exception
- */
- public function __construct($identifier, $component = '', $a = null, $lang = null) {
- if (empty($component)) {
- $component = 'moodle';
- }
-
- $this->identifier = $identifier;
- $this->component = $component;
- $this->lang = $lang;
-
- // We MUST duplicate $a to ensure that it if it changes by reference those
- // changes are not carried across.
- // To do this we always ensure $a or its properties/values are strings
- // and that any properties/values that arn't convertable are forgotten.
- if ($a !== null) {
- if (is_scalar($a)) {
- $this->a = $a;
- } else if ($a instanceof lang_string) {
- $this->a = $a->out();
- } else if (is_object($a) or is_array($a)) {
- $a = (array)$a;
- $this->a = array();
- foreach ($a as $key => $value) {
- // Make sure conversion errors don't get displayed (results in '').
- if (is_array($value)) {
- $this->a[$key] = '';
- } else if (is_object($value)) {
- if (method_exists($value, '__toString')) {
- $this->a[$key] = $value->__toString();
- } else {
- $this->a[$key] = '';
- }
- } else {
- $this->a[$key] = (string)$value;
- }
- }
- }
- }
-
- if (debugging(false, DEBUG_DEVELOPER)) {
- if (clean_param($this->identifier, PARAM_STRINGID) == '') {
- throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of the string identifier. Please check your string definition');
- }
- if (!empty($this->component) && clean_param($this->component, PARAM_COMPONENT) == '') {
- throw new coding_exception('Invalid string compontent. Please check your string definition');
- }
- if (!get_string_manager()->string_exists($this->identifier, $this->component)) {
- debugging('String does not exist. Please check your string definition for '.$this->identifier.'/'.$this->component, DEBUG_DEVELOPER);
- }
- }
- }
-
- /**
- * Processes the string.
- *
- * This function actually processes the string, stores it in the string property
- * and then returns it.
- * You will notice that this function is VERY similar to the get_string method.
- * That is because it is pretty much doing the same thing.
- * However as this function is an upgrade it isn't as tolerant to backwards
- * compatibility.
- *
- * @return string
- * @throws coding_exception
- */
- protected function get_string() {
- global $CFG;
-
- // Check if we need to process the string.
- if ($this->string === null) {
- // Check the quality of the identifier.
- if ($CFG->debugdeveloper && clean_param($this->identifier, PARAM_STRINGID) === '') {
- throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of the string identifier. Please check your string definition', DEBUG_DEVELOPER);
- }
-
- // Process the string.
- $this->string = get_string_manager()->get_string($this->identifier, $this->component, $this->a, $this->lang);
- // Debugging feature lets you display string identifier and component.
- if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
- $this->string .= ' {' . $this->identifier . '/' . $this->component . '}';
- }
- }
- // Return the string.
- return $this->string;
- }
-
- /**
- * Returns the string
- *
- * @param string $lang The langauge to use when processing the string
- * @return string
- */
- public function out($lang = null) {
- if ($lang !== null && $lang != $this->lang && ($this->lang == null && $lang != current_language())) {
- if ($this->forcedstring) {
- debugging('lang_string objects that have been used cannot be printed in another language. ('.$this->lang.' used)', DEBUG_DEVELOPER);
- return $this->get_string();
- }
- $translatedstring = new lang_string($this->identifier, $this->component, $this->a, $lang);
- return $translatedstring->out();
- }
- return $this->get_string();
- }
-
- /**
- * Magic __toString method for printing a string
- *
- * @return string
- */
- public function __toString() {
- return $this->get_string();
- }
-
- /**
- * Magic __set_state method used for var_export
- *
- * @param array $array
- * @return self
- */
- public static function __set_state(array $array): self {
- $tmp = new lang_string($array['identifier'], $array['component'], $array['a'], $array['lang']);
- $tmp->string = $array['string'];
- $tmp->forcedstring = $array['forcedstring'];
- return $tmp;
- }
-
- /**
- * Prepares the lang_string for sleep and stores only the forcedstring and
- * string properties... the string cannot be regenerated so we need to ensure
- * it is generated for this.
- *
- * @return array
- */
- public function __sleep() {
- $this->get_string();
- $this->forcedstring = true;
- return array('forcedstring', 'string', 'lang');
- }
-
- /**
- * Returns the identifier.
- *
- * @return string
- */
- public function get_identifier() {
- return $this->identifier;
- }
-
- /**
- * Returns the component.
- *
- * @return string
- */
- public function get_component() {
- return $this->component;
- }
-}
-
/**
* Get human readable name describing the given callable.
*
diff --git a/lib/outputactions.php b/lib/outputactions.php
index 04bf469af0607..b7c551871da43 100644
--- a/lib/outputactions.php
+++ b/lib/outputactions.php
@@ -14,207 +14,10 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
tags, do not include in title, hence the + // strip tags. + + $ariacontrols = ''; + for ($i = 0; $i < $this->pagesize; $i++) { + $ariacontrols .= $this->uniqueid . '_r' . $i . '_c' . $index . ' '; + } + + $ariacontrols = trim($ariacontrols); + + if (!empty($this->prefs['collapse'][$column])) { + $linkattributes = [ + 'title' => get_string('show') . ' ' . strip_tags($this->headers[$index]), + 'aria-expanded' => 'false', + 'aria-controls' => $ariacontrols, + 'data-action' => 'show', + 'data-column' => $column, + 'role' => 'button', + ]; + return html_writer::link( + $this->baseurl->out(false, [$this->request[TABLE_VAR_SHOW] => $column]), + $OUTPUT->pix_icon('t/switch_plus', null), + $linkattributes + ); + } else if ($this->headers[$index] !== null) { + $linkattributes = [ + 'title' => get_string('hide') . ' ' . strip_tags($this->headers[$index]), + 'aria-expanded' => 'true', + 'aria-controls' => $ariacontrols, + 'data-action' => 'hide', + 'data-column' => $column, + 'role' => 'button', + ]; + return html_writer::link( + $this->baseurl->out(false, [$this->request[TABLE_VAR_HIDE] => $column]), + $OUTPUT->pix_icon('t/switch_minus', null), + $linkattributes + ); + } + } + + /** + * This function is not part of the public api. + */ + public function print_headers() { + global $CFG, $OUTPUT; + + // Set the primary sort column/order where possible, so that sort links/icons are correct. + [ + 'sortby' => $primarysortcolumn, + 'sortorder' => $primarysortorder, + ] = $this->get_primary_sort_order(); + + echo html_writer::start_tag('thead'); + echo html_writer::start_tag('tr'); + foreach ($this->columns as $column => $index) { + $iconhide = ''; + if ($this->is_collapsible) { + $iconhide = $this->show_hide_link($column, $index); + } + switch ($column) { + case 'userpic': + // Do nothing, do not display sortable links. + break; + + default: + if (array_search($column, $this->userfullnamecolumns) !== false) { + // Check the full name display for sortable fields. + if (has_capability('moodle/site:viewfullnames', $this->get_context())) { + $nameformat = $CFG->alternativefullnameformat; + } else { + $nameformat = $CFG->fullnamedisplay; + } + + if ($nameformat == 'language') { + $nameformat = get_string('fullnamedisplay'); + } + + $requirednames = order_in_string(\core_user\fields::get_name_fields(), $nameformat); + + if (!empty($requirednames)) { + if ($this->is_sortable($column)) { + // Done this way for the possibility of more than two sortable full name display fields. + $this->headers[$index] = ''; + foreach ($requirednames as $name) { + $sortname = $this->sort_link( + get_string($name), + $name, + $primarysortcolumn === $name, + $primarysortorder + ); + $this->headers[$index] .= $sortname . ' / '; + } + $helpicon = ''; + if (isset($this->helpforheaders[$index])) { + $helpicon = $OUTPUT->render($this->helpforheaders[$index]); + } + $this->headers[$index] = substr($this->headers[$index], 0, -3) . $helpicon; + } + } + } else if ($this->is_sortable($column)) { + $helpicon = ''; + if (isset($this->helpforheaders[$index])) { + $helpicon = $OUTPUT->render($this->helpforheaders[$index]); + } + $this->headers[$index] = $this->sort_link( + $this->headers[$index], + $column, + $primarysortcolumn == $column, + $primarysortorder + ) . $helpicon; + } + } + + $attributes = [ + 'class' => 'header c' . $index . $this->column_class[$column] . $this->columnsticky[$column], + 'scope' => 'col', + ]; + if ($this->headers[$index] === null) { + $content = ' '; + } else if (!empty($this->prefs['collapse'][$column])) { + $content = $iconhide; + } else { + if (is_array($this->column_style[$column])) { + $attributes['style'] = $this->make_styles_string($this->column_style[$column]); + } + $helpicon = ''; + if (isset($this->helpforheaders[$index]) && !$this->is_sortable($column)) { + $helpicon = $OUTPUT->render($this->helpforheaders[$index]); + } + $content = $this->headers[$index] . $helpicon . html_writer::tag( + 'div', + $iconhide, + ['class' => 'commands'] + ); + } + echo html_writer::tag('th', $content, $attributes); + } + + echo html_writer::end_tag('tr'); + echo html_writer::end_tag('thead'); + } + + /** + * Calculate the preferences for sort order based on user-supplied values and get params. + */ + protected function set_sorting_preferences(): void { + $sortdata = $this->sortdata; + + if ($sortdata === null) { + $sortdata = $this->prefs['sortby']; + + $sortorder = optional_param($this->request[TABLE_VAR_DIR], $this->sort_default_order, PARAM_INT); + $sortby = optional_param($this->request[TABLE_VAR_SORT], '', PARAM_ALPHANUMEXT); + + if (array_key_exists($sortby, $sortdata)) { + // This key already exists somewhere. Change its sortorder and bring it to the top. + unset($sortdata[$sortby]); + } + $sortdata = array_merge([$sortby => $sortorder], $sortdata); + } + + $usernamefields = \core_user\fields::get_name_fields(); + $sortdata = array_filter($sortdata, function ($sortby) use ($usernamefields) { + $isvalidsort = $sortby && $this->is_sortable($sortby); + $isvalidsort = $isvalidsort && empty($this->prefs['collapse'][$sortby]); + $isrealcolumn = isset($this->columns[$sortby]); + $isfullnamefield = $this->contains_fullname_columns() && in_array($sortby, $usernamefields); + + return $isvalidsort && ($isrealcolumn || $isfullnamefield); + }, ARRAY_FILTER_USE_KEY); + + // Finally, make sure that no more than $this->maxsortkeys are present into the array. + $sortdata = array_slice($sortdata, 0, $this->maxsortkeys); + + // If a default order is defined and it is not in the current list of order by columns, add it at the end. + // This prevents results from being returned in a random order if the only order by column contains equal values. + if (!empty($this->sort_default_column) && !array_key_exists($this->sort_default_column, $sortdata)) { + $sortdata = array_merge($sortdata, [$this->sort_default_column => $this->sort_default_order]); + } + + // Apply the sortdata to the preference. + $this->prefs['sortby'] = $sortdata; + } + + /** + * Fill in the preferences for the initials bar. + */ + protected function set_initials_preferences(): void { + $ifirst = $this->ifirst; + $ilast = $this->ilast; + + if ($ifirst === null) { + $ifirst = optional_param($this->request[TABLE_VAR_IFIRST], null, PARAM_RAW); + } + + if ($ilast === null) { + $ilast = optional_param($this->request[TABLE_VAR_ILAST], null, PARAM_RAW); + } + + if (!is_null($ifirst) && ($ifirst === '' || strpos(get_string('alphabet', 'langconfig'), $ifirst) !== false)) { + $this->prefs['i_first'] = $ifirst; + } + + if (!is_null($ilast) && ($ilast === '' || strpos(get_string('alphabet', 'langconfig'), $ilast) !== false)) { + $this->prefs['i_last'] = $ilast; + } + } + + /** + * Set hide and show preferences. + */ + protected function set_hide_show_preferences(): void { + + if ($this->hiddencolumns !== null) { + $this->prefs['collapse'] = array_fill_keys(array_filter($this->hiddencolumns, function ($column) { + return array_key_exists($column, $this->columns); + }), true); + } else { + if ($column = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) { + if (isset($this->columns[$column])) { + $this->prefs['collapse'][$column] = true; + } + } + } + + if ($column = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) { + unset($this->prefs['collapse'][$column]); + } + + foreach (array_keys($this->prefs['collapse']) as $column) { + if (array_key_exists($column, $this->prefs['sortby'])) { + unset($this->prefs['sortby'][$column]); + } + } + } + + /** + * Set the list of hidden columns. + * + * @param array $columns The list of hidden columns. + */ + public function set_hidden_columns(array $columns): void { + $this->hiddencolumns = $columns; + } + + /** + * Initialise table preferences. + */ + protected function initialise_table_preferences(): void { + global $SESSION; + + // Load any existing user preferences. + if ($this->persistent) { + $this->prefs = json_decode(get_user_preferences("flextable_{$this->uniqueid}", ''), true); + $oldprefs = $this->prefs; + } else if (isset($SESSION->flextable[$this->uniqueid])) { + $this->prefs = $SESSION->flextable[$this->uniqueid]; + $oldprefs = $this->prefs; + } + + // Set up default preferences if needed. + if (!$this->prefs || $this->is_resetting_preferences()) { + $this->prefs = [ + 'collapse' => [], + 'sortby' => [], + 'i_first' => '', + 'i_last' => '', + 'textsort' => $this->column_textsort, + ]; + } + + if (!isset($oldprefs)) { + $oldprefs = $this->prefs; + } + + // Save user preferences if they have changed. + if ($this->is_resetting_preferences()) { + $this->sortdata = null; + $this->ifirst = null; + $this->ilast = null; + } + + if ( + ($showcol = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) && + isset($this->columns[$showcol]) + ) { + $this->prefs['collapse'][$showcol] = false; + } else if ( + ($hidecol = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) && + isset($this->columns[$hidecol]) + ) { + $this->prefs['collapse'][$hidecol] = true; + if (array_key_exists($hidecol, $this->prefs['sortby'])) { + unset($this->prefs['sortby'][$hidecol]); + } + } + + $this->set_hide_show_preferences(); + $this->set_sorting_preferences(); + $this->set_initials_preferences(); + + // Now, reduce the width of collapsed columns and remove the width from columns that should be expanded. + foreach (array_keys($this->columns) as $column) { + if (!empty($this->prefs['collapse'][$column])) { + $this->column_style[$column]['width'] = '10px'; + } else { + unset($this->column_style[$column]['width']); + } + } + + if (empty($this->baseurl)) { + debugging('You should set baseurl when using flexible_table.'); + global $PAGE; + $this->baseurl = $PAGE->url; + } + + if ($this->currpage == null) { + $this->currpage = optional_param($this->request[TABLE_VAR_PAGE], 0, PARAM_INT); + } + + $this->save_preferences($oldprefs); + } + + /** + * Save preferences. + * + * @param array $oldprefs Old preferences to compare against. + */ + protected function save_preferences($oldprefs): void { + global $SESSION; + + if ($this->prefs != $oldprefs) { + if ($this->persistent) { + set_user_preference('flextable_' . $this->uniqueid, json_encode($this->prefs)); + } else { + $SESSION->flextable[$this->uniqueid] = $this->prefs; + } + } + unset($oldprefs); + } + + /** + * Set the preferred table sorting attributes. + * + * @param string $sortby The field to sort by. + * @param int $sortorder The sort order. + */ + public function set_sortdata(array $sortdata): void { + $this->sortdata = []; + foreach ($sortdata as $sortitem) { + if (!array_key_exists($sortitem['sortby'], $this->sortdata)) { + $this->sortdata[$sortitem['sortby']] = (int) $sortitem['sortorder']; + } + } + } + + /** + * Get the default per page. + * + * @return int + */ + public function get_default_per_page(): int { + return $this->defaultperpage; + } + + /** + * Set the default per page. + * + * @param int $defaultperpage + */ + public function set_default_per_page(int $defaultperpage): void { + $this->defaultperpage = $defaultperpage; + } + + /** + * Set the preferred first name initial in an initials bar. + * + * @param string $initial The character to set + */ + public function set_first_initial(string $initial): void { + $this->ifirst = $initial; + } + + /** + * Set the preferred last name initial in an initials bar. + * + * @param string $initial The character to set + */ + public function set_last_initial(string $initial): void { + $this->ilast = $initial; + } + + /** + * Set the page number. + * + * @param int $pagenumber The page number. + */ + public function set_page_number(int $pagenumber): void { + $this->currpage = $pagenumber - 1; + } + + /** + * Generate the HTML for the sort icon. This is a helper method used by {@see sort_link()}. + * @param bool $isprimary whether an icon is needed (it is only needed for the primary sort column.) + * @param int $order SORT_ASC or SORT_DESC + * @return string HTML fragment. + */ + protected function sort_icon($isprimary, $order) { + global $OUTPUT; + + if (!$isprimary) { + return ''; + } + + if ($order == SORT_ASC) { + return $OUTPUT->pix_icon('t/sort_asc', get_string('asc')); + } else { + return $OUTPUT->pix_icon('t/sort_desc', get_string('desc')); + } + } + + /** + * Generate the correct tool tip for changing the sort order. This is a + * helper method used by {@see sort_link()}. + * @param bool $isprimary whether the is column is the current primary sort column. + * @param int $order SORT_ASC or SORT_DESC + * @return string the correct title. + */ + protected function sort_order_name($isprimary, $order) { + if ($isprimary && $order != SORT_ASC) { + return get_string('desc'); + } else { + return get_string('asc'); + } + } + + /** + * Generate the HTML for the sort link. This is a helper method used by {@see print_headers()}. + * @param string $text the text for the link. + * @param string $column the column name, may be a fake column like 'firstname' or a real one. + * @param bool $isprimary whether the is column is the current primary sort column. + * @param int $order SORT_ASC or SORT_DESC + * @return string HTML fragment. + */ + protected function sort_link($text, $column, $isprimary, $order) { + // If we are already sorting by this column, switch direction. + if (array_key_exists($column, $this->prefs['sortby'])) { + $sortorder = $this->prefs['sortby'][$column] == SORT_ASC ? SORT_DESC : SORT_ASC; + } else { + $sortorder = $order; + } + + $params = [ + $this->request[TABLE_VAR_SORT] => $column, + $this->request[TABLE_VAR_DIR] => $sortorder, + ]; + + return html_writer::link( + $this->baseurl->out(false, $params), + $text . get_accesshide(get_string('sortby') . ' ' . + $text . ' ' . $this->sort_order_name($isprimary, $order)), + [ + 'data-sortable' => $this->is_sortable($column), + 'data-sortby' => $column, + 'data-sortorder' => $sortorder, + 'role' => 'button', + ] + ) . ' ' . $this->sort_icon($isprimary, $order); + } + + /** + * Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table + * + * @return array + */ + protected function get_primary_sort_order(): array { + if (reset($this->prefs['sortby'])) { + return $this->get_sort_order(); + } + + return [ + 'sortby' => $this->sort_default_column, + 'sortorder' => $this->sort_default_order, + ]; + } + + /** + * Return sorting attributes values. + * + * @return array + */ + protected function get_sort_order(): array { + $sortbys = $this->prefs['sortby']; + $sortby = key($sortbys); + + return [ + 'sortby' => $sortby, + 'sortorder' => $sortbys[$sortby], + ]; + } + + /** + * Get dynamic class component. + * + * @return string + */ + protected function get_component() { + $tableclass = explode("\\", get_class($this)); + return reset($tableclass); + } + + /** + * Get dynamic class handler. + * + * @return string + */ + protected function get_handler() { + $tableclass = explode("\\", get_class($this)); + return end($tableclass); + } + + /** + * Get the dynamic table start wrapper. + * If this is not a dynamic table, then an empty string is returned making this safe to blindly call. + * + * @return string + */ + protected function get_dynamic_table_html_start(): string { + if (is_a($this, dynamic::class)) { + $sortdata = array_map(function ($sortby, $sortorder) { + return [ + 'sortby' => $sortby, + 'sortorder' => $sortorder, + ]; + }, array_keys($this->prefs['sortby']), array_values($this->prefs['sortby'])); + ; + + return html_writer::start_tag('div', [ + 'class' => 'table-dynamic position-relative', + 'data-region' => 'core_table/dynamic', + 'data-table-handler' => $this->get_handler(), + 'data-table-component' => $this->get_component(), + 'data-table-uniqueid' => $this->uniqueid, + 'data-table-filters' => json_encode($this->get_filterset()), + 'data-table-sort-data' => json_encode($sortdata), + 'data-table-first-initial' => $this->prefs['i_first'], + 'data-table-last-initial' => $this->prefs['i_last'], + 'data-table-page-number' => $this->currpage + 1, + 'data-table-page-size' => $this->pagesize, + 'data-table-default-per-page' => $this->get_default_per_page(), + 'data-table-hidden-columns' => json_encode(array_keys($this->prefs['collapse'])), + 'data-table-total-rows' => $this->totalrows, + ]); + } + + return ''; + } + + /** + * Get the dynamic table end wrapper. + * If this is not a dynamic table, then an empty string is returned making this safe to blindly call. + * + * @return string + */ + protected function get_dynamic_table_html_end(): string { + global $PAGE; + + if (is_a($this, dynamic::class)) { + $output = ''; + + $perpageurl = new moodle_url($PAGE->url); + + // Generate "Show all/Show per page" link. + if ($this->pagesize == TABLE_SHOW_ALL_PAGE_SIZE && $this->totalrows > $this->get_default_per_page()) { + $perpagesize = $this->get_default_per_page(); + $perpagestring = get_string('showperpage', '', $this->get_default_per_page()); + } else if ($this->pagesize < $this->totalrows) { + $perpagesize = TABLE_SHOW_ALL_PAGE_SIZE; + $perpagestring = get_string('showall', '', $this->totalrows); + } + if (isset($perpagesize) && isset($perpagestring)) { + $perpageurl->param('perpage', $perpagesize); + $output .= html_writer::link( + $perpageurl, + $perpagestring, + [ + 'data-action' => 'showcount', + 'data-target-page-size' => $perpagesize, + ] + ); + } + + $PAGE->requires->js_call_amd('core_table/dynamic', 'init'); + $output .= html_writer::end_tag('div'); + return $output; + } + + return ''; + } + + /** + * This function is not part of the public api. + */ + public function start_html() { + global $OUTPUT; + + // Render the dynamic table header. + echo $this->get_dynamic_table_html_start(); + + // Render button to allow user to reset table preferences. + echo $this->render_reset_button(); + + // Do we need to print initial bars? + $this->print_initials_bar(); + + // Paging bar. + if ($this->use_pages) { + $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl); + $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE]; + echo $OUTPUT->render($pagingbar); + } + + if (in_array(TABLE_P_TOP, $this->showdownloadbuttonsat)) { + echo $this->download_buttons(); + } + + $this->wrap_html_start(); + // Start of main data table. + + if ($this->responsive) { + echo html_writer::start_tag('div', ['class' => 'no-overflow']); + } + echo html_writer::start_tag('table', $this->attributes) . $this->render_caption(); + } + + /** + * This function set caption for table. + * + * @param string $caption Caption of table. + * @param array|null $captionattributes Caption attributes of table. + */ + public function set_caption(string $caption, ?array $captionattributes): void { + $this->caption = $caption; + $this->captionattributes = $captionattributes; + } + + /** + * This function renders a table caption. + * + * @return string $output Caption of table. + */ + public function render_caption(): string { + if ($this->caption === null) { + return ''; + } + + return html_writer::tag( + 'caption', + $this->caption, + $this->captionattributes, + ); + } + + /** + * This function is not part of the public api. + * @param array $styles CSS-property => value + * @return string values suitably to go in a style="" attribute in HTML. + */ + public function make_styles_string($styles) { + if (empty($styles)) { + return null; + } + + $string = ''; + foreach ($styles as $property => $value) { + $string .= $property . ':' . $value . ';'; + } + return $string; + } + + /** + * Generate the HTML for the table preferences reset button. + * + * @return string HTML fragment, empty string if no need to reset + */ + protected function render_reset_button() { + + if (!$this->can_be_reset()) { + return ''; + } + + $url = $this->baseurl->out(false, [$this->request[TABLE_VAR_RESET] => 1]); + + $html = html_writer::start_div('resettable mdl-right'); + $html .= html_writer::link($url, get_string('resettable'), ['role' => 'button']); + $html .= html_writer::end_div(); + + return $html; + } + + /** + * Are there some table preferences that can be reset? + * + * If true, then the "reset table preferences" widget should be displayed. + * + * @return bool + */ + protected function can_be_reset() { + // Loop through preferences and make sure they are empty or set to the default value. + foreach ($this->prefs as $prefname => $prefval) { + if ($prefname === 'sortby' && !empty($this->sort_default_column)) { + // Check if the actual sorting differs from the default one. + if (empty($prefval) || ($prefval !== [$this->sort_default_column => $this->sort_default_order])) { + return true; + } + } else if ($prefname === 'collapse' && !empty($prefval)) { + // Check if there are some collapsed columns (all are expanded by default). + foreach ($prefval as $columnname => $iscollapsed) { + if ($iscollapsed) { + return true; + } + } + } else if (!empty($prefval)) { + // For all other cases, we just check if some preference is set. + return true; + } + } + + return false; + } + + /** + * Get the context for the table. + * + * Note: This function _must_ be overridden by dynamic tables to ensure that the context is correctly determined + * from the filterset parameters. + * + * @return context + */ + public function get_context(): context { + global $PAGE; + + if (is_a($this, dynamic::class)) { + throw new coding_exception('The get_context function must be defined for a dynamic table'); + } + + return $PAGE->context; + } + + /** + * Set the filterset in the table class. + * + * The use of filtersets is a requirement for dynamic tables, but can be used by other tables too if desired. + * + * @param filterset $filterset The filterset object to get filters and table parameters from + */ + public function set_filterset(filterset $filterset): void { + $this->filterset = $filterset; + + $this->guess_base_url(); + } + + /** + * Get the currently defined filterset. + * + * @return filterset + */ + public function get_filterset(): ?filterset { + return $this->filterset; + } + + /** + * Get the class used as a filterset. + * + * @return string + */ + public static function get_filterset_class(): string { + return static::class . '_filterset'; + } + + /** + * Attempt to guess the base URL. + */ + public function guess_base_url(): void { + if (is_a($this, dynamic::class)) { + throw new coding_exception('The guess_base_url function must be defined for a dynamic table'); + } + } +} +// Alias this class to the old name. +// This file will be autoloaded by the legacyclasses autoload system. +// In future all uses of this class will be corrected and the legacy references will be removed. +class_alias(flexible_table::class, \flexible_table::class); diff --git a/lib/table/classes/output/html_table.php b/lib/table/classes/output/html_table.php new file mode 100644 index 0000000000000..8ec95880ca0aa --- /dev/null +++ b/lib/table/classes/output/html_table.php @@ -0,0 +1,213 @@ +. + +namespace core_table\output; + +/** + * Holds all the information required to render a
+
diff --git a/lib/editor/tiny/plugins/recordrtc/version.php b/lib/editor/tiny/plugins/recordrtc/version.php
index 10d0922a14d16..e83c9049480a3 100644
--- a/lib/editor/tiny/plugins/recordrtc/version.php
+++ b/lib/editor/tiny/plugins/recordrtc/version.php
@@ -24,6 +24,6 @@
defined('MOODLE_INTERNAL') || die();
-$plugin->version = 2024042400;
+$plugin->version = 2024053100;
$plugin->requires = 2024041600;
$plugin->component = 'tiny_recordrtc';
diff --git a/lib/editor/tiny/tests/behat/manage_subplugins.feature b/lib/editor/tiny/tests/behat/manage_subplugins.feature
index 6b0e0c030b93e..09448a88fa7fa 100644
--- a/lib/editor/tiny/tests/behat/manage_subplugins.feature
+++ b/lib/editor/tiny/tests/behat/manage_subplugins.feature
@@ -8,23 +8,11 @@ Feature: An administrator can manage TinyMCE subplugins
Scenario: An administrator can control the enabled state of TinyMCE subplugins using JavaScript
Given I am logged in as "admin"
And I navigate to "Plugins > Text editors > TinyMCE editor > General settings" in site administration
- When I click on "Disable Equation editor" "link"
- Then I should see "Equation editor disabled."
- And "Disable Equation editor" "link" should not exist
- But "Enable Equation editor" "link" should exist
- When I click on "Enable Equation editor" "link"
- Then I should see "Equation editor enabled."
- And "Enable Equation editor" "link" should not exist
- But "Disable Equation editor" "link" should exist
-
- Scenario: An administrator can control the enabled state of TinyMCE subplugins without JavaScript
- Given I am logged in as "admin"
- And I navigate to "Plugins > Text editors > TinyMCE editor > General settings" in site administration
- When I click on "Disable Equation editor" "link"
- Then I should see "Equation editor disabled."
- And "Disable Equation editor" "link" should not exist
- But "Enable Equation editor" "link" should exist
- When I click on "Enable Equation editor" "link"
- Then I should see "Equation editor enabled."
- And "Enable Equation editor" "link" should not exist
- But "Disable Equation editor" "link" should exist
+ When I toggle the "Disable Equation editor" admin switch "off"
+ And I should see "Equation editor disabled."
+ And I reload the page
+ Then I should see "Enable Equation editor"
+ And I toggle the "Enable Equation editor" admin switch "on"
+ And I should see "Equation editor enabled."
+ And I reload the page
+ Then I should see "Disable Equation editor"
diff --git a/lib/external/tests/external_api_test.php b/lib/external/tests/external_api_test.php
index f806785b77971..49bbedae95a5d 100644
--- a/lib/external/tests/external_api_test.php
+++ b/lib/external/tests/external_api_test.php
@@ -332,7 +332,7 @@ public function test_get_context_from_params(): void {
/**
* Test \core_external\external_api::get_context()_from_params parameter validation.
*
- * @covers \core_external\external_api::get_context
+ * @covers \core_external\external_api::get_context_from_params
*/
public function test_get_context_params(): void {
global $USER;
@@ -345,7 +345,7 @@ public function test_get_context_params(): void {
/**
* Test \core_external\external_api::get_context()_from_params parameter validation.
*
- * @covers \core_external\external_api::get_context
+ * @covers \core_external\external_api::get_context_from_params
*/
public function test_get_context_params2(): void {
global $USER;
@@ -357,7 +357,7 @@ public function test_get_context_params2(): void {
/**
* Test \core_external\external_api::get_context()_from_params parameter validation.
- * @covers \core_external\external_api::get_context
+ * @covers \core_external\external_api::get_context_from_params
*/
public function test_get_context_params3(): void {
global $USER;
diff --git a/lib/filestorage/tests/stored_file_test.php b/lib/filestorage/tests/stored_file_test.php
index bd07c47c2834a..76d1606a5f364 100644
--- a/lib/filestorage/tests/stored_file_test.php
+++ b/lib/filestorage/tests/stored_file_test.php
@@ -33,7 +33,6 @@ class stored_file_test extends advanced_testcase {
/**
* Test that the rotate_image() method does not rotate
* an image that is not supposed to be rotated.
- * @covers ::rotate_image()
*/
public function test_rotate_image_does_not_rotate_image(): void {
global $CFG;
@@ -62,7 +61,6 @@ public function test_rotate_image_does_not_rotate_image(): void {
/**
* Test that the rotate_image() method rotates an image
* that is supposed to be rotated.
- * @covers ::rotate_image()
*/
public function test_rotate_image_rotates_image(): void {
global $CFG;
@@ -94,8 +92,6 @@ public function test_rotate_image_rotates_image(): void {
/**
* Ensure that get_content_file_handle returns a valid file handle.
- *
- * @covers ::get_psr_stream
*/
public function test_get_psr_stream(): void {
global $CFG;
diff --git a/lib/form/button.php b/lib/form/button.php
index fdbb4ffe1ea75..b5a44aab17db6 100644
--- a/lib/form/button.php
+++ b/lib/form/button.php
@@ -26,7 +26,6 @@
*/
require_once("HTML/QuickForm/button.php");
-require_once(__DIR__ . '/../outputcomponents.php');
require_once('templatable_form_element.php');
/**
diff --git a/lib/form/templatable_form_element.php b/lib/form/templatable_form_element.php
index 07fb98e2d7f96..e94e5baf5bc2d 100644
--- a/lib/form/templatable_form_element.php
+++ b/lib/form/templatable_form_element.php
@@ -21,18 +21,6 @@
* @copyright 2016 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-defined('MOODLE_INTERNAL') || die();
-
-// Some form elements are used before $CFG is created - do not rely on it here.
-require_once(__DIR__ . '/../outputcomponents.php');
-
-/**
- * templatable_form_element trait.
- *
- * @package core_form
- * @copyright 2016 Damyon Wiese
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
trait templatable_form_element {
/**
diff --git a/lib/installlib.php b/lib/installlib.php
index 8e9c5af1ec8c9..416c7e8b8ea49 100644
--- a/lib/installlib.php
+++ b/lib/installlib.php
@@ -162,7 +162,7 @@ function install_helpbutton($url, $title='') {
echo "";
- echo "
+ {{#isallowedpausing}}
+
+ {{/isallowedpausing}}
";
+ echo "";
echo "\n";
}
diff --git a/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php b/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
index 97b73d21c7aa1..0544004355b55 100644
--- a/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
+++ b/lib/laravel/serializable-closure/src/Support/ReflectionClosure.php
@@ -508,8 +508,7 @@ public function getCode()
break;
case 'id_name':
switch ($token[0]) {
- // named arguments...
- case ':':
+ case $token[0] === ':' && $context !== 'instanceof':
if ($lastState === 'closure' && $context === 'root') {
$state = 'closure';
$code .= $id_start.$token;
diff --git a/lib/minify/matthiasmullie-minify/src/CSS.php b/lib/minify/matthiasmullie-minify/src/CSS.php
index 09cedeee3a064..4f56320c47459 100644
--- a/lib/minify/matthiasmullie-minify/src/CSS.php
+++ b/lib/minify/matthiasmullie-minify/src/CSS.php
@@ -106,8 +106,8 @@ protected function moveImportsToTop($content)
/**
* Combine CSS from import statements.
*
- * Import statements will be loaded and their content merged into the original
- * file, to save HTTP requests.
+ * \@import's will be loaded and their content merged into the original file,
+ * to save HTTP requests.
*
* @param string $source The file to combine imports for
* @param string $content The CSS content to combine imports for
@@ -316,7 +316,9 @@ public function execute($path = null, $parents = array())
$css = $this->replace($css);
$css = $this->stripWhitespace($css);
- $css = $this->shortenColors($css);
+ $css = $this->convertLegacyColors($css);
+ $css = $this->cleanupModernColors($css);
+ $css = $this->shortenHEXColors($css);
$css = $this->shortenZeroes($css);
$css = $this->shortenFontWeights($css);
$css = $this->stripEmptyTags($css);
@@ -480,64 +482,153 @@ protected function move(ConverterInterface $converter, $content)
}
/**
- * Shorthand hex color codes.
- * #FF0000 -> #F00.
+ * Shorthand HEX color codes.
+ * #FF0000FF -> #f00 -> red
+ * #FF00FF00 -> transparent.
*
- * @param string $content The CSS content to shorten the hex color codes for
+ * @param string $content The CSS content to shorten the HEX color codes for
*
* @return string
*/
- protected function shortenColors($content)
+ protected function shortenHexColors($content)
{
- $content = preg_replace('/(?<=[: ])#([0-9a-z])\\1([0-9a-z])\\2([0-9a-z])\\3(?:([0-9a-z])\\4)?(?=[; }])/i', '#$1$2$3$4', $content);
+ // shorten repeating patterns within HEX ..
+ $content = preg_replace('/(?<=[: ])#([0-9a-f])\\1([0-9a-f])\\2([0-9a-f])\\3(?:([0-9a-f])\\4)?(?=[; }])/i', '#$1$2$3$4', $content);
- // remove alpha channel if it's pointless...
- $content = preg_replace('/(?<=[: ])#([0-9a-z]{6})ff?(?=[; }])/i', '#$1', $content);
- $content = preg_replace('/(?<=[: ])#([0-9a-z]{3})f?(?=[; }])/i', '#$1', $content);
+ // remove alpha channel if it's pointless ..
+ $content = preg_replace('/(?<=[: ])#([0-9a-f]{6})ff(?=[; }])/i', '#$1', $content);
+ $content = preg_replace('/(?<=[: ])#([0-9a-f]{3})f(?=[; }])/i', '#$1', $content);
+
+ // replace `transparent` with shortcut ..
+ $content = preg_replace('/(?<=[: ])#[0-9a-f]{6}00(?=[; }])/i', '#fff0', $content);
$colors = array(
+ // make these more readable
+ '#00f' => 'blue',
+ '#dc143c' => 'crimson',
+ '#0ff' => 'cyan',
+ '#8b0000' => 'darkred',
+ '#696969' => 'dimgray',
+ '#ff69b4' => 'hotpink',
+ '#0f0' => 'lime',
+ '#fdf5e6' => 'oldlace',
+ '#87ceeb' => 'skyblue',
+ '#d8bfd8' => 'thistle',
// we can shorten some even more by replacing them with their color name
- '#F0FFFF' => 'azure',
- '#F5F5DC' => 'beige',
- '#A52A2A' => 'brown',
- '#FF7F50' => 'coral',
- '#FFD700' => 'gold',
+ '#f0ffff' => 'azure',
+ '#f5f5dc' => 'beige',
+ '#ffe4c4' => 'bisque',
+ '#a52a2a' => 'brown',
+ '#ff7f50' => 'coral',
+ '#ffd700' => 'gold',
'#808080' => 'gray',
'#008000' => 'green',
- '#4B0082' => 'indigo',
- '#FFFFF0' => 'ivory',
- '#F0E68C' => 'khaki',
- '#FAF0E6' => 'linen',
+ '#4b0082' => 'indigo',
+ '#fffff0' => 'ivory',
+ '#f0e68c' => 'khaki',
+ '#faf0e6' => 'linen',
'#800000' => 'maroon',
'#000080' => 'navy',
'#808000' => 'olive',
- '#CD853F' => 'peru',
- '#FFC0CB' => 'pink',
- '#DDA0DD' => 'plum',
+ '#ffa500' => 'orange',
+ '#da70d6' => 'orchid',
+ '#cd853f' => 'peru',
+ '#ffc0cb' => 'pink',
+ '#dda0dd' => 'plum',
'#800080' => 'purple',
- '#F00' => 'red',
- '#FA8072' => 'salmon',
- '#A0522D' => 'sienna',
- '#C0C0C0' => 'silver',
- '#FFFAFA' => 'snow',
- '#D2B48C' => 'tan',
- '#FF6347' => 'tomato',
- '#EE82EE' => 'violet',
- '#F5DEB3' => 'wheat',
+ '#f00' => 'red',
+ '#fa8072' => 'salmon',
+ '#a0522d' => 'sienna',
+ '#c0c0c0' => 'silver',
+ '#fffafa' => 'snow',
+ '#d2b48c' => 'tan',
+ '#008080' => 'teal',
+ '#ff6347' => 'tomato',
+ '#ee82ee' => 'violet',
+ '#f5deb3' => 'wheat',
// or the other way around
- 'WHITE' => '#fff',
- 'BLACK' => '#000',
+ 'black' => '#000',
+ 'fuchsia' => '#f0f',
+ 'magenta' => '#f0f',
+ 'white' => '#fff',
+ 'yellow' => '#ff0',
+ // and also `transparent`
+ 'transparent' => '#fff0',
);
return preg_replace_callback(
'/(?<=[: ])(' . implode('|', array_keys($colors)) . ')(?=[; }])/i',
function ($match) use ($colors) {
- return $colors[strtoupper($match[0])];
+ return $colors[strtolower($match[0])];
+ },
+ $content
+ );
+ }
+
+ /**
+ * Convert RGB|HSL color codes.
+ * rgb(255,0,0,.5) -> rgb(255 0 0 / .5).
+ * rgb(255,0,0) -> #f00.
+ *
+ * @param string $content The CSS content to shorten the RGB color codes for
+ *
+ * @return string
+ */
+ protected function convertLegacyColors($content)
+ {
+ /*
+ https://drafts.csswg.org/css-color/#color-syntax-legacy
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl
+ */
+
+ // convert legacy color syntax
+ $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content);
+ $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*\)/i', '$1($2 $3 $4)', $content);
+ $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content);
+ $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*\)/i', '$1($2 $3 $4)', $content);
+
+ // convert `rgb` to `hex`
+ $dec = '([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])';
+ return preg_replace_callback(
+ "/rgb\($dec $dec $dec\)/i",
+ function ($match) {
+ return sprintf('#%02x%02x%02x', $match[1], $match[2], $match[3]);
},
$content
);
}
+ /**
+ * Cleanup RGB|HSL|HWB|LCH|LAB
+ * rgb(255 0 0 / 1) -> rgb(255 0 0).
+ * rgb(255 0 0 / 0) -> transparent.
+ *
+ * @param string $content The CSS content to cleanup HSL|HWB|LCH|LAB
+ *
+ * @return string
+ */
+ protected function cleanupModernColors($content)
+ {
+ /*
+ https://drafts.csswg.org/css-color/#color-syntax-modern
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hwb
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lch
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lab
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch
+ https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklab
+ */
+ $tag = '(rgb|hsl|hwb|(?:(?:ok)?(?:lch|lab)))';
+
+ // remove alpha channel if it's pointless ..
+ $content = preg_replace('/' . $tag . '\(\s*([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+\/\s+1(?:(?:\.\d?)*|00%)?\s*\)/i', '$1($2 $3 $4)', $content);
+
+ // replace `transparent` with shortcut ..
+ $content = preg_replace('/' . $tag . '\(\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+\/\s+0(?:[\.0%]*)?\s*\)/i', '#fff0', $content);
+
+ return $content;
+ }
+
/**
* Shorten CSS font weights.
*
diff --git a/lib/minify/matthiasmullie-minify/src/JS.php b/lib/minify/matthiasmullie-minify/src/JS.php
index d592b08bb33f5..9cf43a2e742a3 100644
--- a/lib/minify/matthiasmullie-minify/src/JS.php
+++ b/lib/minify/matthiasmullie-minify/src/JS.php
@@ -122,9 +122,6 @@ class JS extends Minify
*/
protected $operatorsAfter = array();
- /**
- * {@inheritdoc}
- */
public function __construct()
{
call_user_func_array(array('\\MatthiasMullie\Minify\\Minify', '__construct'), func_get_args());
diff --git a/lib/minify/matthiasmullie-minify/src/Minify.php b/lib/minify/matthiasmullie-minify/src/Minify.php
index f77478bebb71f..29e6eb8c00af5 100644
--- a/lib/minify/matthiasmullie-minify/src/Minify.php
+++ b/lib/minify/matthiasmullie-minify/src/Minify.php
@@ -270,7 +270,7 @@ protected function stripMultilineComments()
$minifier = $this;
$callback = function ($match) use ($minifier) {
$count = count($minifier->extracted);
- $placeholder = '/*'.$count.'*/';
+ $placeholder = '/*' . $count . '*/';
$minifier->extracted[$placeholder] = $match[0];
return $placeholder;
@@ -494,14 +494,20 @@ protected function canImportFile($path)
$parsed = parse_url($path);
if (
// file is elsewhere
- isset($parsed['host']) ||
+ isset($parsed['host'])
// file responds to queries (may change, or need to bypass cache)
- isset($parsed['query'])
+ || isset($parsed['query'])
) {
return false;
}
- return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path);
+ try {
+ return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path);
+ }
+ // catch openbasedir exceptions which are not caught by @ on is_file()
+ catch (\Exception $e) {
+ return false;
+ }
}
/**
@@ -534,9 +540,9 @@ protected function openFileForWriting($path)
protected function writeToFile($handler, $content, $path = '')
{
if (
- !is_resource($handler) ||
- ($result = @fwrite($handler, $content)) === false ||
- ($result < strlen($content))
+ !is_resource($handler)
+ || ($result = @fwrite($handler, $content)) === false
+ || ($result < strlen($content))
) {
throw new IOException('The file "' . $path . '" could not be written to. Check your disk space and file permissions.');
}
diff --git a/lib/modinfolib.php b/lib/modinfolib.php
index 06ed6cc8ddc65..5c6899cf94d7b 100644
--- a/lib/modinfolib.php
+++ b/lib/modinfolib.php
@@ -93,6 +93,12 @@ class course_modinfo {
*/
private $delegatedsections;
+ /**
+ * Index of sections delegated by course modules, indexed by course module instance.
+ * @var null|section_info[]
+ */
+ private ?array $delegatedbycm = null;
+
/**
* User ID
* @var int
@@ -139,6 +145,7 @@ class course_modinfo {
'cms' => 'get_cms',
'instances' => 'get_instances',
'groups' => 'get_groups_all',
+ 'delegatedbycm' => 'get_sections_delegated_by_cm',
);
/**
@@ -410,6 +417,33 @@ public function has_delegated_sections(): bool {
return !empty($this->delegatedsections);
}
+ /**
+ * Gets data about section delegated by course modules.
+ *
+ * @return section_info[] sections array indexed by course module ID
+ */
+ public function get_sections_delegated_by_cm(): array {
+ if (!is_null($this->delegatedbycm)) {
+ return $this->delegatedbycm;
+ }
+ $this->delegatedbycm = [];
+ foreach ($this->delegatedsections as $componentsections) {
+ foreach ($componentsections as $section) {
+ $delegateinstance = $section->get_component_instance();
+ // We only return sections delegated by course modules. Sections delegated to other
+ // types of components must implement their own methods to get the section.
+ if (!$delegateinstance || !($delegateinstance instanceof \core_courseformat\sectiondelegatemodule)) {
+ continue;
+ }
+ if (!$cm = $delegateinstance->get_cm()) {
+ continue;
+ }
+ $this->delegatedbycm[$cm->id] = $section;
+ }
+ }
+ return $this->delegatedbycm;
+ }
+
/**
* Static cache for generated course_modinfo instances
*
@@ -2171,6 +2205,19 @@ public function get_course_module_record($additionalfields = false) {
return $cmrecord;
}
+ /**
+ * Returns the section delegated by this module, if any.
+ *
+ * @return ?section_info
+ */
+ public function get_delegated_section_info(): ?section_info {
+ $delegatedsections = $this->modinfo->get_sections_delegated_by_cm();
+ if (!array_key_exists($this->id, $delegatedsections)) {
+ return null;
+ }
+ return $delegatedsections[$this->id];
+ }
+
// Set functions
////////////////
@@ -2602,10 +2649,13 @@ private function update_user_visible() {
$this->availableinfo = '';
}
+ $capabilities = [
+ 'moodle/course:manageactivities',
+ 'moodle/course:activityvisibility',
+ 'moodle/course:viewhiddenactivities',
+ ];
$this->uservisibleoncoursepage = $this->uservisible &&
- ($this->visibleoncoursepage ||
- has_capability('moodle/course:manageactivities', $this->get_context(), $userid) ||
- has_capability('moodle/course:activityvisibility', $this->get_context(), $userid));
+ ($this->visibleoncoursepage || has_any_capability($capabilities, $this->get_context(), $userid));
// Activity that is not available, not hidden from course page and has availability
// info is actually visible on the course page (with availability info and without a link).
if (!$this->uservisible && $this->visibleoncoursepage && $this->availableinfo) {
diff --git a/lib/moodlelib.php b/lib/moodlelib.php
index a68bb235f0fc6..c3c1f4471a4b4 100644
--- a/lib/moodlelib.php
+++ b/lib/moodlelib.php
@@ -7128,172 +7128,20 @@ function get_list_of_themes() {
}
/**
- * Factory function for emoticon_manager
+ * Factory function for {@see \core\emoticon_manager}
*
- * @return emoticon_manager singleton
+ * @return \core\emoticon_manager singleton
*/
-function get_emoticon_manager() {
+function get_emoticon_manager(): \core\emoticon_manager {
static $singleton = null;
if (is_null($singleton)) {
- $singleton = new emoticon_manager();
+ $singleton = new \core\emoticon_manager();
}
return $singleton;
}
-/**
- * Provides core support for plugins that have to deal with emoticons (like HTML editor or emoticon filter).
- *
- * Whenever this manager mentiones 'emoticon object', the following data
- * structure is expected: stdClass with properties text, imagename, imagecomponent,
- * altidentifier and altcomponent
- *
- * @see admin_setting_emoticons
- *
- * @copyright 2010 David Mudrak
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class emoticon_manager {
-
- /**
- * Returns the currently enabled emoticons
- *
- * @param boolean $selectable - If true, only return emoticons that should be selectable from a list.
- * @return array of emoticon objects
- */
- public function get_emoticons($selectable = false) {
- global $CFG;
- $notselectable = ['martin', 'egg'];
-
- if (empty($CFG->emoticons)) {
- return array();
- }
-
- $emoticons = $this->decode_stored_config($CFG->emoticons);
-
- if (!is_array($emoticons)) {
- // Something is wrong with the format of stored setting.
- debugging('Invalid format of emoticons setting, please resave the emoticons settings form', DEBUG_NORMAL);
- return array();
- }
- if ($selectable) {
- foreach ($emoticons as $index => $emote) {
- if (in_array($emote->altidentifier, $notselectable)) {
- // Skip this one.
- unset($emoticons[$index]);
- }
- }
- }
-
- return $emoticons;
- }
-
- /**
- * Converts emoticon object into renderable pix_emoticon object
- *
- * @param stdClass $emoticon emoticon object
- * @param array $attributes explicit HTML attributes to set
- * @return pix_emoticon
- */
- public function prepare_renderable_emoticon(stdClass $emoticon, array $attributes = array()) {
- $stringmanager = get_string_manager();
- if ($stringmanager->string_exists($emoticon->altidentifier, $emoticon->altcomponent)) {
- $alt = get_string($emoticon->altidentifier, $emoticon->altcomponent);
- } else {
- $alt = s($emoticon->text);
- }
- return new pix_emoticon($emoticon->imagename, $alt, $emoticon->imagecomponent, $attributes);
- }
-
- /**
- * Encodes the array of emoticon objects into a string storable in config table
- *
- * @see self::decode_stored_config()
- * @param array $emoticons array of emtocion objects
- * @return string
- */
- public function encode_stored_config(array $emoticons) {
- return json_encode($emoticons);
- }
-
- /**
- * Decodes the string into an array of emoticon objects
- *
- * @see self::encode_stored_config()
- * @param string $encoded
- * @return array|null
- */
- public function decode_stored_config($encoded) {
- $decoded = json_decode($encoded);
- if (!is_array($decoded)) {
- return null;
- }
- return $decoded;
- }
-
- /**
- * Returns default set of emoticons supported by Moodle
- *
- * @return array of sdtClasses
- */
- public function default_emoticons() {
- return array(
- $this->prepare_emoticon_object(":-)", 's/smiley', 'smiley'),
- $this->prepare_emoticon_object(":)", 's/smiley', 'smiley'),
- $this->prepare_emoticon_object(":-D", 's/biggrin', 'biggrin'),
- $this->prepare_emoticon_object(";-)", 's/wink', 'wink'),
- $this->prepare_emoticon_object(":-/", 's/mixed', 'mixed'),
- $this->prepare_emoticon_object("V-.", 's/thoughtful', 'thoughtful'),
- $this->prepare_emoticon_object(":-P", 's/tongueout', 'tongueout'),
- $this->prepare_emoticon_object(":-p", 's/tongueout', 'tongueout'),
- $this->prepare_emoticon_object("B-)", 's/cool', 'cool'),
- $this->prepare_emoticon_object("^-)", 's/approve', 'approve'),
- $this->prepare_emoticon_object("8-)", 's/wideeyes', 'wideeyes'),
- $this->prepare_emoticon_object(":o)", 's/clown', 'clown'),
- $this->prepare_emoticon_object(":-(", 's/sad', 'sad'),
- $this->prepare_emoticon_object(":(", 's/sad', 'sad'),
- $this->prepare_emoticon_object("8-.", 's/shy', 'shy'),
- $this->prepare_emoticon_object(":-I", 's/blush', 'blush'),
- $this->prepare_emoticon_object(":-X", 's/kiss', 'kiss'),
- $this->prepare_emoticon_object("8-o", 's/surprise', 'surprise'),
- $this->prepare_emoticon_object("P-|", 's/blackeye', 'blackeye'),
- $this->prepare_emoticon_object("8-[", 's/angry', 'angry'),
- $this->prepare_emoticon_object("(grr)", 's/angry', 'angry'),
- $this->prepare_emoticon_object("xx-P", 's/dead', 'dead'),
- $this->prepare_emoticon_object("|-.", 's/sleepy', 'sleepy'),
- $this->prepare_emoticon_object("}-]", 's/evil', 'evil'),
- $this->prepare_emoticon_object("(h)", 's/heart', 'heart'),
- $this->prepare_emoticon_object("(heart)", 's/heart', 'heart'),
- $this->prepare_emoticon_object("(y)", 's/yes', 'yes', 'core'),
- $this->prepare_emoticon_object("(n)", 's/no', 'no', 'core'),
- $this->prepare_emoticon_object("(martin)", 's/martin', 'martin'),
- $this->prepare_emoticon_object("( )", 's/egg', 'egg'),
- );
- }
-
- /**
- * Helper method preparing the stdClass with the emoticon properties
- *
- * @param string|array $text or array of strings
- * @param string $imagename to be used by {@link pix_emoticon}
- * @param string $altidentifier alternative string identifier, null for no alt
- * @param string $altcomponent where the alternative string is defined
- * @param string $imagecomponent to be used by {@link pix_emoticon}
- * @return stdClass
- */
- protected function prepare_emoticon_object($text, $imagename, $altidentifier = null,
- $altcomponent = 'core_pix', $imagecomponent = 'core') {
- return (object)array(
- 'text' => $text,
- 'imagename' => $imagename,
- 'imagecomponent' => $imagecomponent,
- 'altidentifier' => $altidentifier,
- 'altcomponent' => $altcomponent,
- );
- }
-}
-
// ENVIRONMENT CHECKING.
/**
@@ -9951,9 +9799,11 @@ function check_consecutive_identical_characters($password, $maxchars) {
/**
* Helper function to do partial function binding.
- * so we can use it for preg_replace_callback, for example
- * this works with php functions, user functions, static methods and class methods
- * it returns you a callback that you can pass on like so:
+ *
+ * This is useful for cases such as preg_replace_callback where you may want to partially bind values.
+ *
+ * The use of named arguments is recommended for clarity.
+ * Please note that providing arguments in a different order may have mixed results for built-in functions.
*
* $callback = partial('somefunction', $arg1, $arg2);
* or
@@ -9964,45 +9814,12 @@ function check_consecutive_identical_characters($password, $maxchars) {
*
* and then the arguments that are passed through at calltime are appended to the argument list.
*
- * @param mixed $function a php callback
- * @param mixed $arg1,... $argv arguments to partially bind with
- * @return array Array callback
- */
-function partial() {
- if (!class_exists('partial')) {
- /**
- * Used to manage function binding.
- * @copyright 2009 Penny Leach
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class partial{
- /** @var array */
- public $values = array();
- /** @var string The function to call as a callback. */
- public $func;
- /**
- * Constructor
- * @param string $func
- * @param array $args
- */
- public function __construct($func, $args) {
- $this->values = $args;
- $this->func = $func;
- }
- /**
- * Calls the callback function.
- * @return mixed
- */
- public function method() {
- $args = func_get_args();
- return call_user_func_array($this->func, array_merge($this->values, $args));
- }
- }
- }
- $args = func_get_args();
- $func = array_shift($args);
- $p = new partial($func, $args);
- return array($p, 'method');
+ * @param callable $function a php callback
+ * @param mixed ...$initialargs The arguments to provide for the initial bind
+ * @return callable
+ */
+function partial(callable $callable, ...$initialargs): callable {
+ return fn (...$args) => $callable(...$initialargs, ...$args);
}
/**
@@ -10183,256 +10000,6 @@ function unserialize_object(string $input): stdClass {
return (object) $instance;
}
-/**
- * The lang_string class
- *
- * This special class is used to create an object representation of a string request.
- * It is special because processing doesn't occur until the object is first used.
- * The class was created especially to aid performance in areas where strings were
- * required to be generated but were not necessarily used.
- * As an example the admin tree when generated uses over 1500 strings, of which
- * normally only 1/3 are ever actually printed at any time.
- * The performance advantage is achieved by not actually processing strings that
- * arn't being used, as such reducing the processing required for the page.
- *
- * How to use the lang_string class?
- * There are two methods of using the lang_string class, first through the
- * forth argument of the get_string function, and secondly directly.
- * The following are examples of both.
- * 1. Through get_string calls e.g.
- * $string = get_string($identifier, $component, $a, true);
- * $string = get_string('yes', 'moodle', null, true);
- * 2. Direct instantiation
- * $string = new lang_string($identifier, $component, $a, $lang);
- * $string = new lang_string('yes');
- *
- * How do I use a lang_string object?
- * The lang_string object makes use of a magic __toString method so that you
- * are able to use the object exactly as you would use a string in most cases.
- * This means you are able to collect it into a variable and then directly
- * echo it, or concatenate it into another string, or similar.
- * The other thing you can do is manually get the string by calling the
- * lang_strings out method e.g.
- * $string = new lang_string('yes');
- * $string->out();
- * Also worth noting is that the out method can take one argument, $lang which
- * allows the developer to change the language on the fly.
- *
- * When should I use a lang_string object?
- * The lang_string object is designed to be used in any situation where a
- * string may not be needed, but needs to be generated.
- * The admin tree is a good example of where lang_string objects should be
- * used.
- * A more practical example would be any class that requries strings that may
- * not be printed (after all classes get renderer by renderers and who knows
- * what they will do ;))
- *
- * When should I not use a lang_string object?
- * Don't use lang_strings when you are going to use a string immediately.
- * There is no need as it will be processed immediately and there will be no
- * advantage, and in fact perhaps a negative hit as a class has to be
- * instantiated for a lang_string object, however get_string won't require
- * that.
- *
- * Limitations:
- * 1. You cannot use a lang_string object as an array offset. Doing so will
- * result in PHP throwing an error. (You can use it as an object property!)
- *
- * @package core
- * @category string
- * @copyright 2011 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class lang_string {
-
- /** @var string The strings identifier */
- protected $identifier;
- /** @var string The strings component. Default '' */
- protected $component = '';
- /** @var array|stdClass Any arguments required for the string. Default null */
- protected $a = null;
- /** @var string The language to use when processing the string. Default null */
- protected $lang = null;
-
- /** @var string The processed string (once processed) */
- protected $string = null;
-
- /**
- * A special boolean. If set to true then the object has been woken up and
- * cannot be regenerated. If this is set then $this->string MUST be used.
- * @var bool
- */
- protected $forcedstring = false;
-
- /**
- * Constructs a lang_string object
- *
- * This function should do as little processing as possible to ensure the best
- * performance for strings that won't be used.
- *
- * @param string $identifier The strings identifier
- * @param string $component The strings component
- * @param stdClass|array|mixed $a Any arguments the string requires
- * @param string $lang The language to use when processing the string.
- * @throws coding_exception
- */
- public function __construct($identifier, $component = '', $a = null, $lang = null) {
- if (empty($component)) {
- $component = 'moodle';
- }
-
- $this->identifier = $identifier;
- $this->component = $component;
- $this->lang = $lang;
-
- // We MUST duplicate $a to ensure that it if it changes by reference those
- // changes are not carried across.
- // To do this we always ensure $a or its properties/values are strings
- // and that any properties/values that arn't convertable are forgotten.
- if ($a !== null) {
- if (is_scalar($a)) {
- $this->a = $a;
- } else if ($a instanceof lang_string) {
- $this->a = $a->out();
- } else if (is_object($a) or is_array($a)) {
- $a = (array)$a;
- $this->a = array();
- foreach ($a as $key => $value) {
- // Make sure conversion errors don't get displayed (results in '').
- if (is_array($value)) {
- $this->a[$key] = '';
- } else if (is_object($value)) {
- if (method_exists($value, '__toString')) {
- $this->a[$key] = $value->__toString();
- } else {
- $this->a[$key] = '';
- }
- } else {
- $this->a[$key] = (string)$value;
- }
- }
- }
- }
-
- if (debugging(false, DEBUG_DEVELOPER)) {
- if (clean_param($this->identifier, PARAM_STRINGID) == '') {
- throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of the string identifier. Please check your string definition');
- }
- if (!empty($this->component) && clean_param($this->component, PARAM_COMPONENT) == '') {
- throw new coding_exception('Invalid string compontent. Please check your string definition');
- }
- if (!get_string_manager()->string_exists($this->identifier, $this->component)) {
- debugging('String does not exist. Please check your string definition for '.$this->identifier.'/'.$this->component, DEBUG_DEVELOPER);
- }
- }
- }
-
- /**
- * Processes the string.
- *
- * This function actually processes the string, stores it in the string property
- * and then returns it.
- * You will notice that this function is VERY similar to the get_string method.
- * That is because it is pretty much doing the same thing.
- * However as this function is an upgrade it isn't as tolerant to backwards
- * compatibility.
- *
- * @return string
- * @throws coding_exception
- */
- protected function get_string() {
- global $CFG;
-
- // Check if we need to process the string.
- if ($this->string === null) {
- // Check the quality of the identifier.
- if ($CFG->debugdeveloper && clean_param($this->identifier, PARAM_STRINGID) === '') {
- throw new coding_exception('Invalid string identifier. Most probably some illegal character is part of the string identifier. Please check your string definition', DEBUG_DEVELOPER);
- }
-
- // Process the string.
- $this->string = get_string_manager()->get_string($this->identifier, $this->component, $this->a, $this->lang);
- // Debugging feature lets you display string identifier and component.
- if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
- $this->string .= ' {' . $this->identifier . '/' . $this->component . '}';
- }
- }
- // Return the string.
- return $this->string;
- }
-
- /**
- * Returns the string
- *
- * @param string $lang The langauge to use when processing the string
- * @return string
- */
- public function out($lang = null) {
- if ($lang !== null && $lang != $this->lang && ($this->lang == null && $lang != current_language())) {
- if ($this->forcedstring) {
- debugging('lang_string objects that have been used cannot be printed in another language. ('.$this->lang.' used)', DEBUG_DEVELOPER);
- return $this->get_string();
- }
- $translatedstring = new lang_string($this->identifier, $this->component, $this->a, $lang);
- return $translatedstring->out();
- }
- return $this->get_string();
- }
-
- /**
- * Magic __toString method for printing a string
- *
- * @return string
- */
- public function __toString() {
- return $this->get_string();
- }
-
- /**
- * Magic __set_state method used for var_export
- *
- * @param array $array
- * @return self
- */
- public static function __set_state(array $array): self {
- $tmp = new lang_string($array['identifier'], $array['component'], $array['a'], $array['lang']);
- $tmp->string = $array['string'];
- $tmp->forcedstring = $array['forcedstring'];
- return $tmp;
- }
-
- /**
- * Prepares the lang_string for sleep and stores only the forcedstring and
- * string properties... the string cannot be regenerated so we need to ensure
- * it is generated for this.
- *
- * @return array
- */
- public function __sleep() {
- $this->get_string();
- $this->forcedstring = true;
- return array('forcedstring', 'string', 'lang');
- }
-
- /**
- * Returns the identifier.
- *
- * @return string
- */
- public function get_identifier() {
- return $this->identifier;
- }
-
- /**
- * Returns the component.
- *
- * @return string
- */
- public function get_component() {
- return $this->component;
- }
-}
-
/**
* Get human readable name describing the given callable.
*
diff --git a/lib/outputactions.php b/lib/outputactions.php
index 04bf469af0607..b7c551871da43 100644
--- a/lib/outputactions.php
+++ b/lib/outputactions.php
@@ -14,207 +14,10 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see
- * if (!$this->page->requires->should_create_one_time_item_now($thing)) {
- * return '';
- * }
- * // Else generate it.
- *
- *
- * @param string $thing identifier for the bit of content. Should be of the form
- * frankenstyle_things, e.g. core_course_modchooser.
- * @return bool if true, the caller should generate that bit of output now, otherwise don't.
- */
- public function should_create_one_time_item_now($thing) {
- if ($this->has_one_time_item_been_created($thing)) {
- return false;
- }
-
- $this->set_one_time_item_created($thing);
- return true;
- }
-
- /**
- * Has a particular bit of HTML that is only required once on this page
- * (e.g. the contents of the modchooser) already been generated?
- *
- * Normally, you can use the {@link should_create_one_time_item_now()} helper
- * method rather than calling this method directly.
- *
- * @param string $thing identifier for the bit of content. Should be of the form
- * frankenstyle_things, e.g. core_course_modchooser.
- * @return bool whether that bit of output has been created.
- */
- public function has_one_time_item_been_created($thing) {
- return isset($this->onetimeitemsoutput[$thing]);
- }
-
- /**
- * Indicate that a particular bit of HTML that is only required once on this
- * page (e.g. the contents of the modchooser) has been generated (or is about to be)?
- *
- * Normally, you can use the {@link should_create_one_time_item_now()} helper
- * method rather than calling this method directly.
- *
- * @param string $thing identifier for the bit of content. Should be of the form
- * frankenstyle_things, e.g. core_course_modchooser.
- */
- public function set_one_time_item_created($thing) {
- if ($this->has_one_time_item_been_created($thing)) {
- throw new coding_exception($thing . ' is only supposed to be ouput ' .
- 'once per page, but it seems to be being output again.');
- }
- return $this->onetimeitemsoutput[$thing] = true;
- }
-}
-
-/**
- * This class represents the YUI configuration.
- *
- * @copyright 2013 Andrew Nicols
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.5
- * @package core
- * @category output
- */
-class YUI_config {
- /**
- * These settings must be public so that when the object is converted to json they are exposed.
- * Note: Some of these are camelCase because YUI uses camelCase variable names.
- *
- * The settings are described and documented in the YUI API at:
- * - http://yuilibrary.com/yui/docs/api/classes/config.html
- * - http://yuilibrary.com/yui/docs/api/classes/Loader.html
- */
- public $debug = false;
- public $base;
- public $comboBase;
- public $combine;
- public $filter = null;
- public $insertBefore = 'firstthemesheet';
- public $groups = array();
- public $modules = array();
- /** @var array The log sources that should be not be logged. */
- public $logInclude = [];
- /** @var array Tog sources that should be logged. */
- public $logExclude = [];
- /** @var string The minimum log level for YUI logging statements. */
- public $logLevel;
-
- /**
- * @var array List of functions used by the YUI Loader group pattern recognition.
- */
- protected $jsconfigfunctions = array();
-
- /**
- * Create a new group within the YUI_config system.
- *
- * @param string $name The name of the group. This must be unique and
- * not previously used.
- * @param array $config The configuration for this group.
- * @return void
- */
- public function add_group($name, $config) {
- if (isset($this->groups[$name])) {
- throw new coding_exception("A YUI configuration group for '{$name}' already exists. To make changes to this group use YUI_config->update_group().");
- }
- $this->groups[$name] = $config;
- }
-
- /**
- * Update an existing group configuration
- *
- * Note, any existing configuration for that group will be wiped out.
- * This includes module configuration.
- *
- * @param string $name The name of the group. This must be unique and
- * not previously used.
- * @param array $config The configuration for this group.
- * @return void
- */
- public function update_group($name, $config) {
- if (!isset($this->groups[$name])) {
- throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
- }
- $this->groups[$name] = $config;
- }
-
- /**
- * Set the value of a configuration function used by the YUI Loader's pattern testing.
- *
- * Only the body of the function should be passed, and not the whole function wrapper.
- *
- * The JS function your write will be passed a single argument 'name' containing the
- * name of the module being loaded.
- *
- * @param $function String the body of the JavaScript function. This should be used i
- * @return string the name of the function to use in the group pattern configuration.
- */
- public function set_config_function($function) {
- $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn';
- if (isset($this->jsconfigfunctions[$configname])) {
- throw new coding_exception("A YUI config function with this name already exists. Config function names must be unique.");
- }
- $this->jsconfigfunctions[$configname] = $function;
- return '@' . $configname . '@';
- }
-
- /**
- * Allow setting of the config function described in {@see set_config_function} from a file.
- * The contents of this file are then passed to set_config_function.
- *
- * When jsrev is positive, the function is minified and stored in a MUC cache for subsequent uses.
- *
- * @param $file The path to the JavaScript function used for YUI configuration.
- * @return string the name of the function to use in the group pattern configuration.
- */
- public function set_config_source($file) {
- global $CFG;
- $cache = cache::make('core', 'yuimodules');
-
- // Attempt to get the metadata from the cache.
- $keyname = 'configfn_' . $file;
- $fullpath = $CFG->dirroot . '/' . $file;
- if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
- $cache->delete($keyname);
- $configfn = file_get_contents($fullpath);
- } else {
- $configfn = $cache->get($keyname);
- if ($configfn === false) {
- require_once($CFG->libdir . '/jslib.php');
- $configfn = core_minify::js_files(array($fullpath));
- $cache->set($keyname, $configfn);
- }
- }
- return $this->set_config_function($configfn);
- }
-
- /**
- * Retrieve the list of JavaScript functions for YUI_config groups.
- *
- * @return string The complete set of config functions
- */
- public function get_config_functions() {
- $configfunctions = '';
- foreach ($this->jsconfigfunctions as $functionname => $function) {
- $configfunctions .= "var {$functionname} = function(me) {";
- $configfunctions .= $function;
- $configfunctions .= "};\n";
- }
- return $configfunctions;
- }
-
- /**
- * Update the header JavaScript with any required modification for the YUI Loader.
- *
- * @param $js String The JavaScript to manipulate.
- * @return string the modified JS string.
- */
- public function update_header_js($js) {
- // Update the names of the the configFn variables.
- // The PHP json_encode function cannot handle literal names so we have to wrap
- // them in @ and then replace them with literals of the same function name.
- foreach ($this->jsconfigfunctions as $functionname => $function) {
- $js = str_replace('"@' . $functionname . '@"', $functionname, $js);
- }
- return $js;
- }
-
- /**
- * Add configuration for a specific module.
- *
- * @param string $name The name of the module to add configuration for.
- * @param array $config The configuration for the specified module.
- * @param string $group The name of the group to add configuration for.
- * If not specified, then this module is added to the global
- * configuration.
- * @return void
- */
- public function add_module_config($name, $config, $group = null) {
- if ($group) {
- if (!isset($this->groups[$name])) {
- throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
- }
- if (!isset($this->groups[$group]['modules'])) {
- $this->groups[$group]['modules'] = array();
- }
- $modules = &$this->groups[$group]['modules'];
- } else {
- $modules = &$this->modules;
- }
- $modules[$name] = $config;
- }
-
- /**
- * Add the moodle YUI module metadata for the moodle group to the YUI_config instance.
- *
- * If js caching is disabled, metadata will not be served causing YUI to calculate
- * module dependencies as each module is loaded.
- *
- * If metadata does not exist it will be created and stored in a MUC entry.
- *
- * @return void
- */
- public function add_moodle_metadata() {
- global $CFG;
- if (!isset($this->groups['moodle'])) {
- throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
- }
-
- if (!isset($this->groups['moodle']['modules'])) {
- $this->groups['moodle']['modules'] = array();
- }
-
- $cache = cache::make('core', 'yuimodules');
- if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
- $metadata = array();
- $metadata = $this->get_moodle_metadata();
- $cache->delete('metadata');
- } else {
- // Attempt to get the metadata from the cache.
- if (!$metadata = $cache->get('metadata')) {
- $metadata = $this->get_moodle_metadata();
- $cache->set('metadata', $metadata);
- }
- }
-
- // Merge with any metadata added specific to this page which was added manually.
- $this->groups['moodle']['modules'] = array_merge($this->groups['moodle']['modules'],
- $metadata);
- }
-
- /**
- * Determine the module metadata for all moodle YUI modules.
- *
- * This works through all modules capable of serving YUI modules, and attempts to get
- * metadata for each of those modules.
- *
- * @return array of module metadata
- */
- private function get_moodle_metadata() {
- $moodlemodules = array();
- // Core isn't a plugin type or subsystem - handle it seperately.
- if ($module = $this->get_moodle_path_metadata(core_component::get_component_directory('core'))) {
- $moodlemodules = array_merge($moodlemodules, $module);
- }
-
- // Handle other core subsystems.
- $subsystems = core_component::get_core_subsystems();
- foreach ($subsystems as $subsystem => $path) {
- if (is_null($path)) {
- continue;
- }
- if ($module = $this->get_moodle_path_metadata($path)) {
- $moodlemodules = array_merge($moodlemodules, $module);
- }
- }
-
- // And finally the plugins.
- $plugintypes = core_component::get_plugin_types();
- foreach ($plugintypes as $plugintype => $pathroot) {
- $pluginlist = core_component::get_plugin_list($plugintype);
- foreach ($pluginlist as $plugin => $path) {
- if ($module = $this->get_moodle_path_metadata($path)) {
- $moodlemodules = array_merge($moodlemodules, $module);
- }
- }
- }
-
- return $moodlemodules;
- }
-
- /**
- * Helper function process and return the YUI metadata for all of the modules under the specified path.
- *
- * @param string $path the UNC path to the YUI src directory.
- * @return array the complete array for frankenstyle directory.
- */
- private function get_moodle_path_metadata($path) {
- // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json.
- $baseyui = $path . '/yui/src';
- $modules = array();
- if (is_dir($baseyui)) {
- $items = new DirectoryIterator($baseyui);
- foreach ($items as $item) {
- if ($item->isDot() or !$item->isDir()) {
- continue;
- }
- $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json');
- if (!is_readable($metafile)) {
- continue;
- }
- $metadata = file_get_contents($metafile);
- $modules = array_merge($modules, (array) json_decode($metadata));
- }
- }
- return $modules;
- }
-
- /**
- * Define YUI modules which we have been required to patch between releases.
- *
- * We must do this because we aggressively cache content on the browser, and we must also override use of the
- * external CDN which will serve the true authoritative copy of the code without our patches.
- *
- * @param string $combobase The local combobase
- * @param string $yuiversion The current YUI version
- * @param int $patchlevel The patch level we're working to for YUI
- * @param array $patchedmodules An array containing the names of the patched modules
- * @return void
- */
- public function define_patched_core_modules($combobase, $yuiversion, $patchlevel, $patchedmodules) {
- // The version we use is suffixed with a patchlevel so that we can get additional revisions between YUI releases.
- $subversion = $yuiversion . '_' . $patchlevel;
-
- if ($this->comboBase == $combobase) {
- // If we are using the local combobase in the loader, we can add a group and still make use of the combo
- // loader. We just need to specify a different root which includes a slightly different YUI version number
- // to include our patchlevel.
- $patterns = array();
- $modules = array();
- foreach ($patchedmodules as $modulename) {
- // We must define the pattern and module here so that the loader uses our group configuration instead of
- // the standard module definition. We may lose some metadata provided by upstream but this will be
- // loaded when the module is loaded anyway.
- $patterns[$modulename] = array(
- 'group' => 'yui-patched',
- );
- $modules[$modulename] = array();
- }
-
- // Actually add the patch group here.
- $this->add_group('yui-patched', array(
- 'combine' => true,
- 'root' => $subversion . '/',
- 'patterns' => $patterns,
- 'modules' => $modules,
- ));
-
- } else {
- // The CDN is in use - we need to instead use the local combobase for this module and override the modules
- // definition. We cannot use the local base - we must use the combobase because we cannot invalidate the
- // local base in browser caches.
- $fullpathbase = $combobase . $subversion . '/';
- foreach ($patchedmodules as $modulename) {
- $this->modules[$modulename] = array(
- 'fullpath' => $fullpathbase . $modulename . '/' . $modulename . '-min.js'
- );
- }
- }
- }
-}
-
-/**
- * Invalidate all server and client side template caches.
- */
-function template_reset_all_caches() {
- global $CFG;
-
- $next = time();
- if (isset($CFG->templaterev) and $next <= $CFG->templaterev and $CFG->templaterev - $next < 60 * 60) {
- // This resolves problems when reset is requested repeatedly within 1s,
- // the < 1h condition prevents accidental switching to future dates
- // because we might not recover from it.
- $next = $CFG->templaterev + 1;
- }
-
- set_config('templaterev', $next);
-}
-
-/**
- * Invalidate all server and client side JS caches.
- */
-function js_reset_all_caches() {
- global $CFG;
-
- $next = time();
- if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) {
- // This resolves problems when reset is requested repeatedly within 1s,
- // the < 1h condition prevents accidental switching to future dates
- // because we might not recover from it.
- $next = $CFG->jsrev+1;
- }
-
- set_config('jsrev', $next);
-}
+// This file is deprecated, but it should never have been manually included by anything outside of lib/outputlib.php.
+// Throwing an exception here should be fine because removing the manual inclusion should have no impact.
+throw new \core\exception\coding_exception(
+ 'This file should not be manually included by any component.',
+);
diff --git a/lib/pagelib.php b/lib/pagelib.php
index cd649a39d7a2f..1c4d00195095f 100644
--- a/lib/pagelib.php
+++ b/lib/pagelib.php
@@ -31,6 +31,7 @@
use core\navigation\views\secondary;
use core\navigation\output\primary as primaryoutput;
use core\output\activity_header;
+use core\output\xhtml_container_stack;
/**
* $PAGE is a central store of information about the current page we are
@@ -1034,9 +1035,6 @@ public function has_navbar() {
* by the get_fragment() web service and not for use elsewhere.
*/
public function start_collecting_javascript_requirements() {
- global $CFG;
- require_once($CFG->libdir.'/outputfragmentrequirementslib.php');
-
// Check that the requirements manager has not already been switched.
if (get_class($this->_requires) == 'fragment_requirements_manager') {
throw new coding_exception('JavaScript collection has already been started.');
diff --git a/lib/psr/http-client/CHANGELOG.md b/lib/psr/http-client/CHANGELOG.md
index e2dc25f519b39..babba7c7b2ea6 100644
--- a/lib/psr/http-client/CHANGELOG.md
+++ b/lib/psr/http-client/CHANGELOG.md
@@ -2,6 +2,14 @@
All notable changes to this project will be documented in this file, in reverse chronological order by release.
+## 1.0.3
+
+Add `source` link in composer.json. No code changes.
+
+## 1.0.2
+
+Allow PSR-7 (psr/http-message) 2.0. No code changes.
+
## 1.0.1
Allow installation with PHP 8. No code changes.
diff --git a/lib/psr/http-client/README.md b/lib/psr/http-client/README.md
index 6876b8403639a..84af5c55d5fea 100644
--- a/lib/psr/http-client/README.md
+++ b/lib/psr/http-client/README.md
@@ -7,6 +7,6 @@ Note that this is not a HTTP Client implementation of its own. It is merely abst
The installable [package][package-url] and [implementations][implementation-url] are listed on Packagist.
-[psr-url]: http://www.php-fig.org/psr/psr-18
+[psr-url]: https://www.php-fig.org/psr/psr-18
[package-url]: https://packagist.org/packages/psr/http-client
[implementation-url]: https://packagist.org/providers/psr/http-client-implementation
diff --git a/lib/psr/http-client/composer.json b/lib/psr/http-client/composer.json
index c195f8ff155ad..6fed350beb874 100644
--- a/lib/psr/http-client/composer.json
+++ b/lib/psr/http-client/composer.json
@@ -7,12 +7,15 @@
"authors": [
{
"name": "PHP-FIG",
- "homepage": "http://www.php-fig.org/"
+ "homepage": "https://www.php-fig.org/"
}
],
+ "support": {
+ "source": "https://github.com/php-fig/http-client"
+ },
"require": {
"php": "^7.0 || ^8.0",
- "psr/http-message": "^1.0"
+ "psr/http-message": "^1.0 || ^2.0"
},
"autoload": {
"psr-4": {
diff --git a/lib/psr/http-client/readme_moodle.txt b/lib/psr/http-client/readme_moodle.txt
new file mode 100644
index 0000000000000..eaa9df3c716a0
--- /dev/null
+++ b/lib/psr/http-client/readme_moodle.txt
@@ -0,0 +1,10 @@
+# PSR-18 HTTP Client
+
+This is a description for including the PSR-18 Interfaces in Moodle
+
+## Installation
+
+1. Visit https://github.com/php-fig/http-client
+2. Download the latest release
+3. Unzip in this folder
+4. Update `thirdpartylibs.xml`
diff --git a/lib/psr/http-message/README.md b/lib/psr/http-message/README.md
index 28185338f7238..2668be6c30bbb 100644
--- a/lib/psr/http-message/README.md
+++ b/lib/psr/http-message/README.md
@@ -10,4 +10,7 @@ interface that describes a HTTP message. See the specification for more details.
Usage
-----
-We'll certainly need some stuff in here.
\ No newline at end of file
+Before reading the usage guide we recommend reading the PSR-7 interfaces method list:
+
+* [`PSR-7 Interfaces Method List`](docs/PSR7-Interfaces.md)
+* [`PSR-7 Usage Guide`](docs/PSR7-Usage.md)
\ No newline at end of file
diff --git a/lib/psr/http-message/composer.json b/lib/psr/http-message/composer.json
index b0d2937a03a5f..c66e5aba40c97 100644
--- a/lib/psr/http-message/composer.json
+++ b/lib/psr/http-message/composer.json
@@ -7,11 +7,11 @@
"authors": [
{
"name": "PHP-FIG",
- "homepage": "http://www.php-fig.org/"
+ "homepage": "https://www.php-fig.org/"
}
],
"require": {
- "php": ">=5.3.0"
+ "php": "^7.2 || ^8.0"
},
"autoload": {
"psr-4": {
@@ -20,7 +20,7 @@
},
"extra": {
"branch-alias": {
- "dev-master": "1.0.x-dev"
+ "dev-master": "2.0.x-dev"
}
}
}
diff --git a/lib/psr/http-message/docs/PSR7-Interfaces.md b/lib/psr/http-message/docs/PSR7-Interfaces.md
new file mode 100644
index 0000000000000..3a7e7dda69534
--- /dev/null
+++ b/lib/psr/http-message/docs/PSR7-Interfaces.md
@@ -0,0 +1,130 @@
+# Interfaces
+
+The purpose of this list is to help in finding the methods when working with PSR-7. This can be considered as a cheatsheet for PSR-7 interfaces.
+
+The interfaces defined in PSR-7 are the following:
+
+| Class Name | Description |
+|---|---|
+| [Psr\Http\Message\MessageInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessagemessageinterface) | Representation of a HTTP message |
+| [Psr\Http\Message\RequestInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessagerequestinterface) | Representation of an outgoing, client-side request. |
+| [Psr\Http\Message\ServerRequestInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageserverrequestinterface) | Representation of an incoming, server-side HTTP request. |
+| [Psr\Http\Message\ResponseInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageresponseinterface) | Representation of an outgoing, server-side response. |
+| [Psr\Http\Message\StreamInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessagestreaminterface) | Describes a data stream |
+| [Psr\Http\Message\UriInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageuriinterface) | Value object representing a URI. |
+| [Psr\Http\Message\UploadedFileInterface](http://www.php-fig.org/psr/psr-7/#psrhttpmessageuploadedfileinterface) | Value object representing a file uploaded through an HTTP request. |
+
+## `Psr\Http\Message\MessageInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getProtocolVersion()` | Retrieve HTTP protocol version | 1.0 or 1.1 |
+| `withProtocolVersion($version)` | Returns new message instance with given HTTP protocol version | |
+| `getHeaders()` | Retrieve all HTTP Headers | [Request Header List](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields), [Response Header List](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Response_fields) |
+| `hasHeader($name)` | Checks if HTTP Header with given name exists | |
+| `getHeader($name)` | Retrieves a array with the values for a single header | |
+| `getHeaderLine($name)` | Retrieves a comma-separated string of the values for a single header | |
+| `withHeader($name, $value)` | Returns new message instance with given HTTP Header | if the header existed in the original instance, replaces the header value from the original message with the value provided when creating the new instance. |
+| `withAddedHeader($name, $value)` | Returns new message instance with appended value to given header | If header already exists value will be appended, if not a new header will be created |
+| `withoutHeader($name)` | Removes HTTP Header with given name| |
+| `getBody()` | Retrieves the HTTP Message Body | Returns object implementing `StreamInterface`|
+| `withBody(StreamInterface $body)` | Returns new message instance with given HTTP Message Body | |
+
+
+## `Psr\Http\Message\RequestInterface` Methods
+
+Same methods as `Psr\Http\Message\MessageInterface` + the following methods:
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getRequestTarget()` | Retrieves the message's request target | origin-form, absolute-form, authority-form, asterisk-form ([RFC7230](https://www.rfc-editor.org/rfc/rfc7230.txt)) |
+| `withRequestTarget($requestTarget)` | Return a new message instance with the specific request-target | |
+| `getMethod()` | Retrieves the HTTP method of the request. | GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE (defined in [RFC7231](https://tools.ietf.org/html/rfc7231)), PATCH (defined in [RFC5789](https://tools.ietf.org/html/rfc5789)) |
+| `withMethod($method)` | Returns a new message instance with the provided HTTP method | |
+| `getUri()` | Retrieves the URI instance | |
+| `withUri(UriInterface $uri, $preserveHost = false)` | Returns a new message instance with the provided URI | |
+
+
+## `Psr\Http\Message\ServerRequestInterface` Methods
+
+Same methods as `Psr\Http\Message\RequestInterface` + the following methods:
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getServerParams() ` | Retrieve server parameters | Typically derived from `$_SERVER` |
+| `getCookieParams()` | Retrieves cookies sent by the client to the server. | Typically derived from `$_COOKIES` |
+| `withCookieParams(array $cookies)` | Returns a new request instance with the specified cookies | |
+| `withQueryParams(array $query)` | Returns a new request instance with the specified query string arguments | |
+| `getUploadedFiles()` | Retrieve normalized file upload data | |
+| `withUploadedFiles(array $uploadedFiles)` | Returns a new request instance with the specified uploaded files | |
+| `getParsedBody()` | Retrieve any parameters provided in the request body | |
+| `withParsedBody($data)` | Returns a new request instance with the specified body parameters | |
+| `getAttributes()` | Retrieve attributes derived from the request | |
+| `getAttribute($name, $default = null)` | Retrieve a single derived request attribute | |
+| `withAttribute($name, $value)` | Returns a new request instance with the specified derived request attribute | |
+| `withoutAttribute($name)` | Returns a new request instance that without the specified derived request attribute | |
+
+## `Psr\Http\Message\ResponseInterface` Methods:
+
+Same methods as `Psr\Http\Message\MessageInterface` + the following methods:
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getStatusCode()` | Gets the response status code. | |
+| `withStatus($code, $reasonPhrase = '')` | Returns a new response instance with the specified status code and, optionally, reason phrase. | |
+| `getReasonPhrase()` | Gets the response reason phrase associated with the status code. | |
+
+## `Psr\Http\Message\StreamInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `__toString()` | Reads all data from the stream into a string, from the beginning to end. | |
+| `close()` | Closes the stream and any underlying resources. | |
+| `detach()` | Separates any underlying resources from the stream. | |
+| `getSize()` | Get the size of the stream if known. | |
+| `eof()` | Returns true if the stream is at the end of the stream.| |
+| `isSeekable()` | Returns whether or not the stream is seekable. | |
+| `seek($offset, $whence = SEEK_SET)` | Seek to a position in the stream. | |
+| `rewind()` | Seek to the beginning of the stream. | |
+| `isWritable()` | Returns whether or not the stream is writable. | |
+| `write($string)` | Write data to the stream. | |
+| `isReadable()` | Returns whether or not the stream is readable. | |
+| `read($length)` | Read data from the stream. | |
+| `getContents()` | Returns the remaining contents in a string | |
+| `getMetadata($key = null)()` | Get stream metadata as an associative array or retrieve a specific key. | |
+
+## `Psr\Http\Message\UriInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getScheme()` | Retrieve the scheme component of the URI. | |
+| `getAuthority()` | Retrieve the authority component of the URI. | |
+| `getUserInfo()` | Retrieve the user information component of the URI. | |
+| `getHost()` | Retrieve the host component of the URI. | |
+| `getPort()` | Retrieve the port component of the URI. | |
+| `getPath()` | Retrieve the path component of the URI. | |
+| `getQuery()` | Retrieve the query string of the URI. | |
+| `getFragment()` | Retrieve the fragment component of the URI. | |
+| `withScheme($scheme)` | Return an instance with the specified scheme. | |
+| `withUserInfo($user, $password = null)` | Return an instance with the specified user information. | |
+| `withHost($host)` | Return an instance with the specified host. | |
+| `withPort($port)` | Return an instance with the specified port. | |
+| `withPath($path)` | Return an instance with the specified path. | |
+| `withQuery($query)` | Return an instance with the specified query string. | |
+| `withFragment($fragment)` | Return an instance with the specified URI fragment. | |
+| `__toString()` | Return the string representation as a URI reference. | |
+
+## `Psr\Http\Message\UploadedFileInterface` Methods
+
+| Method Name | Description | Notes |
+|------------------------------------| ----------- | ----- |
+| `getStream()` | Retrieve a stream representing the uploaded file. | |
+| `moveTo($targetPath)` | Move the uploaded file to a new location. | |
+| `getSize()` | Retrieve the file size. | |
+| `getError()` | Retrieve the error associated with the uploaded file. | |
+| `getClientFilename()` | Retrieve the filename sent by the client. | |
+| `getClientMediaType()` | Retrieve the media type sent by the client. | |
+
+> `RequestInterface`, `ServerRequestInterface`, `ResponseInterface` extend `MessageInterface` because the `Request` and the `Response` are `HTTP Messages`.
+> When using `ServerRequestInterface`, both `RequestInterface` and `Psr\Http\Message\MessageInterface` methods are considered.
+
diff --git a/lib/psr/http-message/docs/PSR7-Usage.md b/lib/psr/http-message/docs/PSR7-Usage.md
new file mode 100644
index 0000000000000..b6d048a341e8c
--- /dev/null
+++ b/lib/psr/http-message/docs/PSR7-Usage.md
@@ -0,0 +1,159 @@
+### PSR-7 Usage
+
+All PSR-7 applications comply with these interfaces
+They were created to establish a standard between middleware implementations.
+
+> `RequestInterface`, `ServerRequestInterface`, `ResponseInterface` extend `MessageInterface` because the `Request` and the `Response` are `HTTP Messages`.
+> When using `ServerRequestInterface`, both `RequestInterface` and `Psr\Http\Message\MessageInterface` methods are considered.
+
+
+The following examples will illustrate how basic operations are done in PSR-7.
+
+##### Examples
+
+
+For this examples to work (at least) a PSR-7 implementation package is required. (eg: zendframework/zend-diactoros, guzzlehttp/psr7, slim/slim, etc)
+All PSR-7 implementations should have the same behaviour.
+
+The following will be assumed:
+`$request` is an object of `Psr\Http\Message\RequestInterface` and
+
+`$response` is an object implementing `Psr\Http\Message\RequestInterface`
+
+
+### Working with HTTP Headers
+
+#### Adding headers to response:
+
+```php
+$response->withHeader('My-Custom-Header', 'My Custom Message');
+```
+
+#### Appending values to headers
+
+```php
+$response->withAddedHeader('My-Custom-Header', 'The second message');
+```
+
+#### Checking if header exists:
+
+```php
+$request->hasHeader('My-Custom-Header'); // will return false
+$response->hasHeader('My-Custom-Header'); // will return true
+```
+
+> Note: My-Custom-Header was only added in the Response
+
+#### Getting comma-separated values from a header (also applies to request)
+
+```php
+// getting value from request headers
+$request->getHeaderLine('Content-Type'); // will return: "text/html; charset=UTF-8"
+// getting value from response headers
+$response->getHeaderLine('My-Custom-Header'); // will return: "My Custom Message; The second message"
+```
+
+#### Getting array of value from a header (also applies to request)
+```php
+// getting value from request headers
+$request->getHeader('Content-Type'); // will return: ["text/html", "charset=UTF-8"]
+// getting value from response headers
+$response->getHeader('My-Custom-Header'); // will return: ["My Custom Message", "The second message"]
+```
+
+#### Removing headers from HTTP Messages
+```php
+// removing a header from Request, removing deprecated "Content-MD5" header
+$request->withoutHeader('Content-MD5');
+
+// removing a header from Response
+// effect: the browser won't know the size of the stream
+// the browser will download the stream till it ends
+$response->withoutHeader('Content-Length');
+```
+
+### Working with HTTP Message Body
+
+When working with the PSR-7 there are two methods of implementation:
+#### 1. Getting the body separately
+
+> This method makes the body handling easier to understand and is useful when repeatedly calling body methods. (You only call `getBody()` once). Using this method mistakes like `$response->write()` are also prevented.
+
+```php
+$body = $response->getBody();
+// operations on body, eg. read, write, seek
+// ...
+// replacing the old body
+$response->withBody($body);
+// this last statement is optional as we working with objects
+// in this case the "new" body is same with the "old" one
+// the $body variable has the same value as the one in $request, only the reference is passed
+```
+
+#### 2. Working directly on response
+
+> This method is useful when only performing few operations as the `$request->getBody()` statement fragment is required
+
+```php
+$response->getBody()->write('hello');
+```
+
+### Getting the body contents
+
+The following snippet gets the contents of a stream contents.
+> Note: Streams must be rewinded, if content was written into streams, it will be ignored when calling `getContents()` because the stream pointer is set to the last character, which is `\0` - meaning end of stream.
+```php
+$body = $response->getBody();
+$body->rewind(); // or $body->seek(0);
+$bodyText = $body->getContents();
+```
+> Note: If `$body->seek(1)` is called before `$body->getContents()`, the first character will be ommited as the starting pointer is set to `1`, not `0`. This is why using `$body->rewind()` is recommended.
+
+### Append to body
+
+```php
+$response->getBody()->write('Hello'); // writing directly
+$body = $request->getBody(); // which is a `StreamInterface`
+$body->write('xxxxx');
+```
+
+### Prepend to body
+Prepending is different when it comes to streams. The content must be copied before writing the content to be prepended.
+The following example will explain the behaviour of streams.
+
+```php
+// assuming our response is initially empty
+$body = $repsonse->getBody();
+// writing the string "abcd"
+$body->write('abcd');
+
+// seeking to start of stream
+$body->seek(0);
+// writing 'ef'
+$body->write('ef'); // at this point the stream contains "efcd"
+```
+
+#### Prepending by rewriting separately
+
+```php
+// assuming our response body stream only contains: "abcd"
+$body = $response->getBody();
+$body->rewind();
+$contents = $body->getContents(); // abcd
+// seeking the stream to beginning
+$body->rewind();
+$body->write('ef'); // stream contains "efcd"
+$body->write($contents); // stream contains "efabcd"
+```
+
+> Note: `getContents()` seeks the stream while reading it, therefore if the second `rewind()` method call was not present the stream would have resulted in `abcdefabcd` because the `write()` method appends to stream if not preceeded by `rewind()` or `seek(0)`.
+
+#### Prepending by using contents as a string
+```php
+$body = $response->getBody();
+$body->rewind();
+$contents = $body->getContents(); // efabcd
+$contents = 'ef'.$contents;
+$body->rewind();
+$body->write($contents);
+```
diff --git a/lib/psr/http-message/readme_moodle.txt b/lib/psr/http-message/readme_moodle.txt
new file mode 100644
index 0000000000000..622d300aa9d89
--- /dev/null
+++ b/lib/psr/http-message/readme_moodle.txt
@@ -0,0 +1,10 @@
+# PSR-7 HTTP Message
+
+This is a description for including the PSR-7 Interfaces in Moodle
+
+## Installation
+
+1. Visit https://github.com/php-fig/http-message
+2. Download the latest release
+3. Unzip in this folder
+4. Update `thirdpartylibs.xml`
diff --git a/lib/psr/http-message/src/MessageInterface.php b/lib/psr/http-message/src/MessageInterface.php
index dd46e5ec81eef..a83c98518d549 100644
--- a/lib/psr/http-message/src/MessageInterface.php
+++ b/lib/psr/http-message/src/MessageInterface.php
@@ -23,7 +23,7 @@ interface MessageInterface
*
* @return string HTTP protocol version.
*/
- public function getProtocolVersion();
+ public function getProtocolVersion(): string;
/**
* Return an instance with the specified HTTP protocol version.
@@ -38,7 +38,7 @@ public function getProtocolVersion();
* @param string $version HTTP protocol version
* @return static
*/
- public function withProtocolVersion($version);
+ public function withProtocolVersion(string $version): MessageInterface;
/**
* Retrieves all message header values.
@@ -65,7 +65,7 @@ public function withProtocolVersion($version);
* key MUST be a header name, and each value MUST be an array of strings
* for that header.
*/
- public function getHeaders();
+ public function getHeaders(): array;
/**
* Checks if a header exists by the given case-insensitive name.
@@ -75,7 +75,7 @@ public function getHeaders();
* name using a case-insensitive string comparison. Returns false if
* no matching header name is found in the message.
*/
- public function hasHeader($name);
+ public function hasHeader(string $name): bool;
/**
* Retrieves a message header value by the given case-insensitive name.
@@ -91,7 +91,7 @@ public function hasHeader($name);
* header. If the header does not appear in the message, this method MUST
* return an empty array.
*/
- public function getHeader($name);
+ public function getHeader(string $name): array;
/**
* Retrieves a comma-separated string of the values for a single header.
@@ -112,7 +112,7 @@ public function getHeader($name);
* concatenated together using a comma. If the header does not appear in
* the message, this method MUST return an empty string.
*/
- public function getHeaderLine($name);
+ public function getHeaderLine(string $name): string;
/**
* Return an instance with the provided value replacing the specified header.
@@ -129,7 +129,7 @@ public function getHeaderLine($name);
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
- public function withHeader($name, $value);
+ public function withHeader(string $name, $value): MessageInterface;
/**
* Return an instance with the specified header appended with the given value.
@@ -147,7 +147,7 @@ public function withHeader($name, $value);
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
- public function withAddedHeader($name, $value);
+ public function withAddedHeader(string $name, $value): MessageInterface;
/**
* Return an instance without the specified header.
@@ -161,14 +161,14 @@ public function withAddedHeader($name, $value);
* @param string $name Case-insensitive header field name to remove.
* @return static
*/
- public function withoutHeader($name);
+ public function withoutHeader(string $name): MessageInterface;
/**
* Gets the body of the message.
*
* @return StreamInterface Returns the body as a stream.
*/
- public function getBody();
+ public function getBody(): StreamInterface;
/**
* Return an instance with the specified message body.
@@ -183,5 +183,5 @@ public function getBody();
* @return static
* @throws \InvalidArgumentException When the body is not valid.
*/
- public function withBody(StreamInterface $body);
+ public function withBody(StreamInterface $body): MessageInterface;
}
diff --git a/lib/psr/http-message/src/RequestInterface.php b/lib/psr/http-message/src/RequestInterface.php
index a96d4fd636679..33f85e559d024 100644
--- a/lib/psr/http-message/src/RequestInterface.php
+++ b/lib/psr/http-message/src/RequestInterface.php
@@ -39,7 +39,7 @@ interface RequestInterface extends MessageInterface
*
* @return string
*/
- public function getRequestTarget();
+ public function getRequestTarget(): string;
/**
* Return an instance with the specific request-target.
@@ -55,17 +55,18 @@ public function getRequestTarget();
*
* @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
* request-target forms allowed in request messages)
- * @param mixed $requestTarget
+ * @param string $requestTarget
* @return static
*/
- public function withRequestTarget($requestTarget);
+ public function withRequestTarget(string $requestTarget): RequestInterface;
+
/**
* Retrieves the HTTP method of the request.
*
* @return string Returns the request method.
*/
- public function getMethod();
+ public function getMethod(): string;
/**
* Return an instance with the provided HTTP method.
@@ -82,7 +83,7 @@ public function getMethod();
* @return static
* @throws \InvalidArgumentException for invalid HTTP methods.
*/
- public function withMethod($method);
+ public function withMethod(string $method): RequestInterface;
/**
* Retrieves the URI instance.
@@ -93,7 +94,7 @@ public function withMethod($method);
* @return UriInterface Returns a UriInterface instance
* representing the URI of the request.
*/
- public function getUri();
+ public function getUri(): UriInterface;
/**
* Returns an instance with the provided URI.
@@ -125,5 +126,5 @@ public function getUri();
* @param bool $preserveHost Preserve the original state of the Host header.
* @return static
*/
- public function withUri(UriInterface $uri, $preserveHost = false);
+ public function withUri(UriInterface $uri, bool $preserveHost = false): RequestInterface;
}
diff --git a/lib/psr/http-message/src/ResponseInterface.php b/lib/psr/http-message/src/ResponseInterface.php
index c306514e6bbdf..e9299a91443f2 100644
--- a/lib/psr/http-message/src/ResponseInterface.php
+++ b/lib/psr/http-message/src/ResponseInterface.php
@@ -27,7 +27,7 @@ interface ResponseInterface extends MessageInterface
*
* @return int Status code.
*/
- public function getStatusCode();
+ public function getStatusCode(): int;
/**
* Return an instance with the specified status code and, optionally, reason phrase.
@@ -49,7 +49,7 @@ public function getStatusCode();
* @return static
* @throws \InvalidArgumentException For invalid status code arguments.
*/
- public function withStatus($code, $reasonPhrase = '');
+ public function withStatus(int $code, string $reasonPhrase = ''): ResponseInterface;
/**
* Gets the response reason phrase associated with the status code.
@@ -64,5 +64,5 @@ public function withStatus($code, $reasonPhrase = '');
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
* @return string Reason phrase; must return an empty string if none present.
*/
- public function getReasonPhrase();
+ public function getReasonPhrase(): string;
}
diff --git a/lib/psr/http-message/src/ServerRequestInterface.php b/lib/psr/http-message/src/ServerRequestInterface.php
index 02512340ad853..8625d0e100d93 100644
--- a/lib/psr/http-message/src/ServerRequestInterface.php
+++ b/lib/psr/http-message/src/ServerRequestInterface.php
@@ -51,7 +51,7 @@ interface ServerRequestInterface extends RequestInterface
*
* @return array
*/
- public function getServerParams();
+ public function getServerParams(): array;
/**
* Retrieve cookies.
@@ -63,7 +63,7 @@ public function getServerParams();
*
* @return array
*/
- public function getCookieParams();
+ public function getCookieParams(): array;
/**
* Return an instance with the specified cookies.
@@ -82,7 +82,7 @@ public function getCookieParams();
* @param array $cookies Array of key/value pairs representing cookies.
* @return static
*/
- public function withCookieParams(array $cookies);
+ public function withCookieParams(array $cookies): ServerRequestInterface;
/**
* Retrieve query string arguments.
@@ -96,7 +96,7 @@ public function withCookieParams(array $cookies);
*
* @return array
*/
- public function getQueryParams();
+ public function getQueryParams(): array;
/**
* Return an instance with the specified query string arguments.
@@ -120,7 +120,7 @@ public function getQueryParams();
* $_GET.
* @return static
*/
- public function withQueryParams(array $query);
+ public function withQueryParams(array $query): ServerRequestInterface;
/**
* Retrieve normalized file upload data.
@@ -134,7 +134,7 @@ public function withQueryParams(array $query);
* @return array An array tree of UploadedFileInterface instances; an empty
* array MUST be returned if no data is present.
*/
- public function getUploadedFiles();
+ public function getUploadedFiles(): array;
/**
* Create a new instance with the specified uploaded files.
@@ -147,7 +147,7 @@ public function getUploadedFiles();
* @return static
* @throws \InvalidArgumentException if an invalid structure is provided.
*/
- public function withUploadedFiles(array $uploadedFiles);
+ public function withUploadedFiles(array $uploadedFiles): ServerRequestInterface;
/**
* Retrieve any parameters provided in the request body.
@@ -194,7 +194,7 @@ public function getParsedBody();
* @throws \InvalidArgumentException if an unsupported argument type is
* provided.
*/
- public function withParsedBody($data);
+ public function withParsedBody($data): ServerRequestInterface;
/**
* Retrieve attributes derived from the request.
@@ -207,7 +207,7 @@ public function withParsedBody($data);
*
* @return array Attributes derived from the request.
*/
- public function getAttributes();
+ public function getAttributes(): array;
/**
* Retrieve a single derived request attribute.
@@ -224,7 +224,7 @@ public function getAttributes();
* @param mixed $default Default value to return if the attribute does not exist.
* @return mixed
*/
- public function getAttribute($name, $default = null);
+ public function getAttribute(string $name, $default = null);
/**
* Return an instance with the specified derived request attribute.
@@ -241,7 +241,7 @@ public function getAttribute($name, $default = null);
* @param mixed $value The value of the attribute.
* @return static
*/
- public function withAttribute($name, $value);
+ public function withAttribute(string $name, $value): ServerRequestInterface;
/**
* Return an instance that removes the specified derived request attribute.
@@ -257,5 +257,5 @@ public function withAttribute($name, $value);
* @param string $name The attribute name.
* @return static
*/
- public function withoutAttribute($name);
+ public function withoutAttribute(string $name): ServerRequestInterface;
}
diff --git a/lib/psr/http-message/src/StreamInterface.php b/lib/psr/http-message/src/StreamInterface.php
index f68f391269b47..a62aabb8288b8 100644
--- a/lib/psr/http-message/src/StreamInterface.php
+++ b/lib/psr/http-message/src/StreamInterface.php
@@ -25,14 +25,14 @@ interface StreamInterface
* @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
* @return string
*/
- public function __toString();
+ public function __toString(): string;
/**
* Closes the stream and any underlying resources.
*
* @return void
*/
- public function close();
+ public function close(): void;
/**
* Separates any underlying resources from the stream.
@@ -48,7 +48,7 @@ public function detach();
*
* @return int|null Returns the size in bytes if known, or null if unknown.
*/
- public function getSize();
+ public function getSize(): ?int;
/**
* Returns the current position of the file read/write pointer
@@ -56,21 +56,21 @@ public function getSize();
* @return int Position of the file pointer
* @throws \RuntimeException on error.
*/
- public function tell();
+ public function tell(): int;
/**
* Returns true if the stream is at the end of the stream.
*
* @return bool
*/
- public function eof();
+ public function eof(): bool;
/**
* Returns whether or not the stream is seekable.
*
* @return bool
*/
- public function isSeekable();
+ public function isSeekable(): bool;
/**
* Seek to a position in the stream.
@@ -84,7 +84,7 @@ public function isSeekable();
* SEEK_END: Set position to end-of-stream plus offset.
* @throws \RuntimeException on failure.
*/
- public function seek($offset, $whence = SEEK_SET);
+ public function seek(int $offset, int $whence = SEEK_SET): void;
/**
* Seek to the beginning of the stream.
@@ -96,14 +96,14 @@ public function seek($offset, $whence = SEEK_SET);
* @link http://www.php.net/manual/en/function.fseek.php
* @throws \RuntimeException on failure.
*/
- public function rewind();
+ public function rewind(): void;
/**
* Returns whether or not the stream is writable.
*
* @return bool
*/
- public function isWritable();
+ public function isWritable(): bool;
/**
* Write data to the stream.
@@ -112,14 +112,14 @@ public function isWritable();
* @return int Returns the number of bytes written to the stream.
* @throws \RuntimeException on failure.
*/
- public function write($string);
+ public function write(string $string): int;
/**
* Returns whether or not the stream is readable.
*
* @return bool
*/
- public function isReadable();
+ public function isReadable(): bool;
/**
* Read data from the stream.
@@ -131,7 +131,7 @@ public function isReadable();
* if no bytes are available.
* @throws \RuntimeException if an error occurs.
*/
- public function read($length);
+ public function read(int $length): string;
/**
* Returns the remaining contents in a string
@@ -140,7 +140,7 @@ public function read($length);
* @throws \RuntimeException if unable to read or an error occurs while
* reading.
*/
- public function getContents();
+ public function getContents(): string;
/**
* Get stream metadata as an associative array or retrieve a specific key.
@@ -149,10 +149,10 @@ public function getContents();
* stream_get_meta_data() function.
*
* @link http://php.net/manual/en/function.stream-get-meta-data.php
- * @param string $key Specific metadata to retrieve.
+ * @param string|null $key Specific metadata to retrieve.
* @return array|mixed|null Returns an associative array if no key is
* provided. Returns a specific key value if a key is provided and the
* value is found, or null if the key is not found.
*/
- public function getMetadata($key = null);
+ public function getMetadata(?string $key = null);
}
diff --git a/lib/psr/http-message/src/UploadedFileInterface.php b/lib/psr/http-message/src/UploadedFileInterface.php
index f8a6901e01447..dd19d653819f1 100644
--- a/lib/psr/http-message/src/UploadedFileInterface.php
+++ b/lib/psr/http-message/src/UploadedFileInterface.php
@@ -28,7 +28,7 @@ interface UploadedFileInterface
* @throws \RuntimeException in cases when no stream is available or can be
* created.
*/
- public function getStream();
+ public function getStream(): StreamInterface;
/**
* Move the uploaded file to a new location.
@@ -62,7 +62,7 @@ public function getStream();
* @throws \RuntimeException on any error during the move operation, or on
* the second or subsequent call to the method.
*/
- public function moveTo($targetPath);
+ public function moveTo(string $targetPath): void;
/**
* Retrieve the file size.
@@ -73,7 +73,7 @@ public function moveTo($targetPath);
*
* @return int|null The file size in bytes or null if unknown.
*/
- public function getSize();
+ public function getSize(): ?int;
/**
* Retrieve the error associated with the uploaded file.
@@ -89,7 +89,7 @@ public function getSize();
* @see http://php.net/manual/en/features.file-upload.errors.php
* @return int One of PHP's UPLOAD_ERR_XXX constants.
*/
- public function getError();
+ public function getError(): int;
/**
* Retrieve the filename sent by the client.
@@ -104,7 +104,7 @@ public function getError();
* @return string|null The filename sent by the client or null if none
* was provided.
*/
- public function getClientFilename();
+ public function getClientFilename(): ?string;
/**
* Retrieve the media type sent by the client.
@@ -119,5 +119,5 @@ public function getClientFilename();
* @return string|null The media type sent by the client or null if none
* was provided.
*/
- public function getClientMediaType();
+ public function getClientMediaType(): ?string;
}
diff --git a/lib/psr/http-message/src/UriInterface.php b/lib/psr/http-message/src/UriInterface.php
index 9d7ab9eae8f29..15e2cf2862850 100644
--- a/lib/psr/http-message/src/UriInterface.php
+++ b/lib/psr/http-message/src/UriInterface.php
@@ -1,4 +1,5 @@
=8.0.2"
+ "php": ">=8.1"
},
"autoload": {
"files": [
@@ -25,7 +25,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
- "dev-main": "3.0-dev"
+ "dev-main": "3.5-dev"
},
"thanks": {
"name": "symfony/contracts",
diff --git a/lib/table/UPGRADING.md b/lib/table/UPGRADING.md
new file mode 100644
index 0000000000000..e9eb81afec2e4
--- /dev/null
+++ b/lib/table/UPGRADING.md
@@ -0,0 +1,11 @@
+# core_table (subsystem) Upgrade notes
+
+## 4.5dev
+
+### Added
+
+- A new `$reponsive` property (defaulting to `true`) has been added to the `core_table\flexible_table` class.
+ This property allows you to control whether the table is rendered as a responsive table.
+
+ For more information see [MDL-80748](https://tracker.moodle.org/browse/MDL-80748)
+
diff --git a/lib/table/classes/base_export_format.php b/lib/table/classes/base_export_format.php
new file mode 100644
index 0000000000000..35653e4c444f8
--- /dev/null
+++ b/lib/table/classes/base_export_format.php
@@ -0,0 +1,102 @@
+.
+
+namespace core_table;
+
+use flexible_table;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once("{$CFG->libdir}/tablelib.php");
+
+/**
+ * The table base export format.
+ *
+ * @package core_table
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class base_export_format {
+ /**
+ * @var flexible_table or child class reference pointing to table class object from which to export data.
+ */
+ public $table;
+
+ /**
+ * @var bool output started. Keeps track of whether any output has been started yet.
+ */
+ public $documentstarted = false;
+
+ /**
+ * Constructor.
+ *
+ * @param flexible_table $table
+ */
+ public function __construct(&$table) {
+ $this->table =& $table;
+ }
+
+ public function set_table(&$table) {
+ $this->table =& $table;
+ }
+
+ public function add_data($row) {
+ return false;
+ }
+
+ public function add_seperator() {
+ return false;
+ }
+
+ public function document_started() {
+ return $this->documentstarted;
+ }
+
+ /**
+ * Format the text.
+ *
+ * Given text in a variety of format codings, this function returns
+ * the text as safe HTML or as plain text dependent on what is appropriate
+ * for the download format. The default removes all tags.
+ *
+ * @param string $text
+ * @param int $format
+ * @param null|array $options
+ * @param null|int $courseid
+ */
+ public function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid = null) {
+ // Use some whitespace to indicate where there was some line spacing.
+ $text = str_replace(['', "\n", "\r"], ' ', $text);
+ return html_entity_decode(strip_tags($text), ENT_COMPAT);
+ }
+
+ /**
+ * Format a row of data, removing HTML tags and entities from each of the cells
+ *
+ * @param array $row
+ * @return array
+ */
+ public function format_data(array $row): array {
+ return array_map([$this, 'format_text'], $row);
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(base_export_format::class, \table_default_export_format_parent::class);
diff --git a/lib/table/classes/dataformat_export_format.php b/lib/table/classes/dataformat_export_format.php
new file mode 100644
index 0000000000000..fcc84a4a8b5fc
--- /dev/null
+++ b/lib/table/classes/dataformat_export_format.php
@@ -0,0 +1,156 @@
+.
+
+namespace core_table;
+
+use core\exception\coding_exception;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once("{$CFG->libdir}/tablelib.php");
+
+use core\dataformat;
+
+/**
+ * Dataformat exporter
+ *
+ * @package core_table
+ * @subpackage tablelib
+ * @copyright 2016 Brendan Heywood (brendan@catalyst-au.net)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class dataformat_export_format extends base_export_format {
+ /** @var \core\dataformat\base $dataformat */
+ protected $dataformat;
+
+ /** @var int $rownum */
+ protected $rownum = 0;
+
+ /** @var array $columns */
+ protected $columns;
+
+ /**
+ * Constructor
+ *
+ * @param string $table An sql table
+ * @param string $dataformat type of dataformat for export
+ */
+ public function __construct(&$table, $dataformat) {
+ parent::__construct($table);
+
+ if (ob_get_length()) {
+ throw new coding_exception("Output can not be buffered before instantiating table_dataformat_export_format");
+ }
+
+ $this->dataformat = dataformat::get_format_instance($dataformat);
+
+ // The dataformat export time to first byte could take a while to generate...
+ set_time_limit(0);
+
+ // Close the session so that the users other tabs in the same session are not blocked.
+ \core\session\manager::write_close();
+ }
+
+ /**
+ * Whether the current dataformat supports export of HTML
+ *
+ * @return bool
+ */
+ public function supports_html(): bool {
+ return $this->dataformat->supports_html();
+ }
+
+ /**
+ * Start document
+ *
+ * @param string $filename
+ * @param string $sheettitle
+ */
+ public function start_document($filename, $sheettitle) {
+ $this->documentstarted = true;
+ $this->dataformat->set_filename($filename);
+ $this->dataformat->send_http_headers();
+ $this->dataformat->set_sheettitle($sheettitle);
+ $this->dataformat->start_output();
+ }
+
+ /**
+ * Start export
+ *
+ * @param string $sheettitle optional spreadsheet worksheet title
+ */
+ public function start_table($sheettitle) {
+ $this->dataformat->set_sheettitle($sheettitle);
+ }
+
+ /**
+ * Output headers
+ *
+ * @param array $headers
+ */
+ public function output_headers($headers) {
+ $this->columns = $this->format_data($headers);
+ if (method_exists($this->dataformat, 'write_header')) {
+ error_log('The function write_header() does not support multiple sheets. In order to support multiple sheets you ' .
+ 'must implement start_output() and start_sheet() and remove write_header() in your dataformat.');
+ $this->dataformat->write_header($this->columns);
+ } else {
+ $this->dataformat->start_sheet($this->columns);
+ }
+ }
+
+ /**
+ * Add a row of data
+ *
+ * @param array $row One record of data
+ */
+ public function add_data($row) {
+ if (!$this->supports_html()) {
+ $row = $this->format_data($row);
+ }
+
+ $this->dataformat->write_record($row, $this->rownum++);
+ return true;
+ }
+
+ /**
+ * Finish export
+ */
+ public function finish_table() {
+ if (method_exists($this->dataformat, 'write_footer')) {
+ error_log('The function write_footer() does not support multiple sheets. In order to support multiple sheets you ' .
+ 'must implement close_sheet() and close_output() and remove write_footer() in your dataformat.');
+ $this->dataformat->write_footer($this->columns);
+ } else {
+ $this->dataformat->close_sheet($this->columns);
+ }
+ }
+
+ /**
+ * Finish download
+ */
+ public function finish_document() {
+ $this->dataformat->close_output();
+ exit();
+ }
+}
+
+// Alias this class to the old name.
+// This file will be autoloaded by the legacyclasses autoload system.
+// In future all uses of this class will be corrected and the legacy references will be removed.
+class_alias(dataformat_export_format::class, \table_dataformat_export_format::class);
diff --git a/lib/table/classes/flexible_table.php b/lib/table/classes/flexible_table.php
new file mode 100644
index 0000000000000..967006d1ef7a9
--- /dev/null
+++ b/lib/table/classes/flexible_table.php
@@ -0,0 +1,2031 @@
+.
+
+namespace core_table;
+
+use core\context;
+use core_table\local\filter\filterset;
+use core\exception\coding_exception;
+use core\output\renderable;
+use html_writer;
+use moodle_url;
+use paging_bar;
+use stdClass;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once("{$CFG->libdir}/tablelib.php");
+
+// phpcs:disable moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+/**
+ * Flexible table implementation.
+ *
+ * @package core_table
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class flexible_table {
+ public $attributes = [];
+ public $baseurl = null;
+
+ /** @var string The caption of table */
+ public $caption;
+
+ /** @var array The caption attributes of table */
+ public $captionattributes;
+
+ public $column_class = [];
+ public $column_nosort = ['userpic'];
+ public $column_style = [];
+ public $column_suppress = [];
+ public $columns = [];
+ public $currentrow = 0;
+ public $currpage = 0;
+
+ /**
+ * Which download plugin to use. Default '' means none - print html table with paging.
+ * Property set by is_downloading which typically passes in cleaned data from $
+ * @var string
+ */
+ public $download = '';
+
+ /**
+ * Whether data is downloadable from table. Determines whether to display download buttons. Set by method downloadable().
+ * @var bool
+ */
+ public $downloadable = false;
+
+ /** @var dataformat_export_format */
+ public $exportclass = null;
+
+ public $headers = [];
+ public $is_collapsible = false;
+ public $is_sortable = false;
+ public $maxsortkeys = 2;
+ public $pagesize = 30;
+ public $request = [];
+
+ /** @var bool Stores if setup has already been called on this flixible table. */
+ public $setup = false;
+
+ /** @var int[] Array of positions in which to display download controls. */
+ public $showdownloadbuttonsat = [TABLE_P_TOP];
+
+ public $sort_default_column = null;
+ public $sort_default_order = SORT_ASC;
+
+ /** @var bool Has start output been called yet? */
+ public $started_output = false;
+
+ public $totalrows = 0;
+ public $uniqueid = null;
+ public $use_initials = false;
+ public $use_pages = false;
+
+ /** @var string Key of field returned by db query that is the id field of the user table or equivalent. */
+ public $useridfield = 'id';
+
+ /** @var bool Whether to make the table to be scrolled horizontally with ease. Make table responsive across all viewports. */
+ public bool $responsive = true;
+
+ /** @var array The sticky attribute of each table column. */
+ protected $columnsticky = [];
+
+ /** @var string $filename */
+ protected $filename;
+
+ /**
+ * The currently applied filerset. This is required for dynamic tables, but can be used by other tables too if desired.
+ * @var filterset
+ */
+ protected $filterset = null;
+
+ /** @var string A column which should be considered as a header column. */
+ protected $headercolumn = null;
+
+ /** @var string For create header with help icon. */
+ private $helpforheaders = [];
+
+ /** @var array List of hidden columns. */
+ protected $hiddencolumns;
+
+ /** @var string The manually set first name initial preference */
+ protected $ifirst;
+
+ /** @var string The manually set last name initial preference */
+ protected $ilast;
+
+ /** @var bool Whether the table preferences is resetting. */
+ protected $resetting;
+
+ /** @var string */
+ protected $sheettitle;
+
+ /** @var array The fields to sort. */
+ protected $sortdata;
+
+ /** @var string[] Columns that are expected to contain a users fullname. */
+ protected $userfullnamecolumns = ['fullname'];
+
+ private $column_textsort = [];
+
+ /** @var array[] Attributes for each column */
+ private $columnsattributes = [];
+
+ /** @var int The default per page size for the table. */
+ private $defaultperpage = 30;
+
+ /** @var bool Whether to store table properties in the user_preferences table. */
+ private $persistent = false;
+
+ /** @var array For storing user-customised table properties in the user_preferences db table. */
+ private $prefs = [];
+
+ /**
+ * Constructor
+ * @param string $uniqueid all tables have to have a unique id, this is used
+ * as a key when storing table properties like sort order in the session.
+ */
+ public function __construct($uniqueid) {
+ $this->uniqueid = $uniqueid;
+ $this->request = [
+ TABLE_VAR_SORT => 'tsort',
+ TABLE_VAR_HIDE => 'thide',
+ TABLE_VAR_SHOW => 'tshow',
+ TABLE_VAR_IFIRST => 'tifirst',
+ TABLE_VAR_ILAST => 'tilast',
+ TABLE_VAR_PAGE => 'page',
+ TABLE_VAR_RESET => 'treset',
+ TABLE_VAR_DIR => 'tdir',
+ ];
+ }
+
+ /**
+ * Call this to pass the download type. Use :
+ * $download = optional_param('download', '', PARAM_ALPHA);
+ * To get the download type. We assume that if you call this function with
+ * params that this table's data is downloadable, so we call is_downloadable
+ * for you (even if the param is '', which means no download this time.
+ * Also you can call this method with no params to get the current set
+ * download type.
+ * @param string|null $download type of dataformat for export.
+ * @param string $filename filename for downloads without file extension.
+ * @param string $sheettitle title for downloaded data.
+ * @return string download dataformat type.
+ */
+ public function is_downloading($download = null, $filename = '', $sheettitle = '') {
+ if ($download !== null) {
+ $this->sheettitle = $sheettitle;
+ $this->is_downloadable(true);
+ $this->download = $download;
+ $this->filename = clean_filename($filename);
+ $this->export_class_instance();
+ }
+ return $this->download;
+ }
+
+ /**
+ * Get, and optionally set, the export class.
+ * @param dataformat_export_format $exportclass (optional) if passed, set the table to use this export class.
+ * @return dataformat_export_format the export class in use (after any set).
+ */
+ public function export_class_instance($exportclass = null) {
+ if (!is_null($exportclass)) {
+ $this->started_output = true;
+ $this->exportclass = $exportclass;
+ $this->exportclass->table = $this;
+ } else if (is_null($this->exportclass) && !empty($this->download)) {
+ $this->exportclass = new dataformat_export_format($this, $this->download);
+ if (!$this->exportclass->document_started()) {
+ $this->exportclass->start_document($this->filename, $this->sheettitle);
+ }
+ }
+ return $this->exportclass;
+ }
+
+ /**
+ * Probably don't need to call this directly. Calling is_downloading with a
+ * param automatically sets table as downloadable.
+ *
+ * @param bool $downloadable optional param to set whether data from
+ * table is downloadable. If ommitted this function can be used to get
+ * current state of table.
+ * @return bool whether table data is set to be downloadable.
+ */
+ public function is_downloadable($downloadable = null) {
+ if ($downloadable !== null) {
+ $this->downloadable = $downloadable;
+ }
+ return $this->downloadable;
+ }
+
+ /**
+ * Call with boolean true to store table layout changes in the user_preferences table.
+ * Note: user_preferences.value has a maximum length of 1333 characters.
+ * Call with no parameter to get current state of table persistence.
+ *
+ * @param bool $persistent Optional parameter to set table layout persistence.
+ * @return bool Whether or not the table layout preferences will persist.
+ */
+ public function is_persistent($persistent = null) {
+ if ($persistent == true) {
+ $this->persistent = true;
+ }
+ return $this->persistent;
+ }
+
+ /**
+ * Where to show download buttons.
+ * @param array $showat array of postions in which to show download buttons.
+ * Containing TABLE_P_TOP and/or TABLE_P_BOTTOM
+ */
+ public function show_download_buttons_at($showat) {
+ $this->showdownloadbuttonsat = $showat;
+ }
+
+ /**
+ * Sets the is_sortable variable to the given boolean, sort_default_column to
+ * the given string, and the sort_default_order to the given integer.
+ * @param bool $bool
+ * @param string $defaultcolumn
+ * @param int $defaultorder
+ * @return void
+ */
+ public function sortable($bool, $defaultcolumn = null, $defaultorder = SORT_ASC) {
+ $this->is_sortable = $bool;
+ $this->sort_default_column = $defaultcolumn;
+ $this->sort_default_order = $defaultorder;
+ }
+
+ /**
+ * Use text sorting functions for this column (required for text columns with Oracle).
+ * Be warned that you cannot use this with column aliases. You can only do this
+ * with real columns. See MDL-40481 for an example.
+ * @param string column name
+ */
+ public function text_sorting($column) {
+ $this->column_textsort[] = $column;
+ }
+
+ /**
+ * Do not sort using this column
+ * @param string column name
+ */
+ public function no_sorting($column) {
+ $this->column_nosort[] = $column;
+ }
+
+ /**
+ * Is the column sortable?
+ * @param string column name, null means table
+ * @return bool
+ */
+ public function is_sortable($column = null) {
+ if (empty($column)) {
+ return $this->is_sortable;
+ }
+ if (!$this->is_sortable) {
+ return false;
+ }
+ return !in_array($column, $this->column_nosort);
+ }
+
+ /**
+ * Sets the is_collapsible variable to the given boolean.
+ * @param bool $bool
+ * @return void
+ */
+ public function collapsible($bool) {
+ $this->is_collapsible = $bool;
+ }
+
+ /**
+ * Sets the use_pages variable to the given boolean.
+ * @param bool $bool
+ * @return void
+ */
+ public function pageable($bool) {
+ $this->use_pages = $bool;
+ }
+
+ /**
+ * Sets the use_initials variable to the given boolean.
+ * @param bool $bool
+ * @return void
+ */
+ public function initialbars($bool) {
+ $this->use_initials = $bool;
+ }
+
+ /**
+ * Sets the pagesize variable to the given integer, the totalrows variable
+ * to the given integer, and the use_pages variable to true.
+ * @param int $perpage
+ * @param int $total
+ * @return void
+ */
+ public function pagesize($perpage, $total) {
+ $this->pagesize = $perpage;
+ $this->totalrows = $total;
+ $this->use_pages = true;
+ }
+
+ /**
+ * Assigns each given variable in the array to the corresponding index
+ * in the request class variable.
+ * @param array $variables
+ * @return void
+ */
+ public function set_control_variables($variables) {
+ foreach ($variables as $what => $variable) {
+ if (isset($this->request[$what])) {
+ $this->request[$what] = $variable;
+ }
+ }
+ }
+
+ /**
+ * Gives the given $value to the $attribute index of $this->attributes.
+ * @param string $attribute
+ * @param mixed $value
+ * @return void
+ */
+ public function set_attribute($attribute, $value) {
+ $this->attributes[$attribute] = $value;
+ }
+
+ /**
+ * What this method does is set the column so that if the same data appears in
+ * consecutive rows, then it is not repeated.
+ *
+ * For example, in the quiz overview report, the fullname column is set to be suppressed, so
+ * that when one student has made multiple attempts, their name is only printed in the row
+ * for their first attempt.
+ * @param int $column the index of a column.
+ */
+ public function column_suppress($column) {
+ if (isset($this->column_suppress[$column])) {
+ $this->column_suppress[$column] = true;
+ }
+ }
+
+ /**
+ * Sets the given $column index to the given $classname in $this->column_class.
+ * @param int $column
+ * @param string $classname
+ * @return void
+ */
+ public function column_class($column, $classname) {
+ if (isset($this->column_class[$column])) {
+ $this->column_class[$column] = ' ' . $classname; // This space needed so that classnames don't run together in the HTML.
+ }
+ }
+
+ /**
+ * Sets the given $column index and $property index to the given $value in $this->column_style.
+ * @param int $column
+ * @param string $property
+ * @param mixed $value
+ * @return void
+ */
+ public function column_style($column, $property, $value) {
+ if (isset($this->column_style[$column])) {
+ $this->column_style[$column][$property] = $value;
+ }
+ }
+
+ /**
+ * Sets a sticky attribute to a column.
+ * @param string $column Column name
+ * @param bool $sticky
+ */
+ public function column_sticky(string $column, bool $sticky = true): void {
+ if (isset($this->columnsticky[$column])) {
+ $this->columnsticky[$column] = $sticky == true ? ' sticky-column' : '';
+ }
+ }
+
+ /**
+ * Sets the given $attributes to $this->columnsattributes.
+ * Column attributes will be added to every cell in the column.
+ *
+ * @param array[] $attributes e.g. ['c0_firstname' => ['data-foo' => 'bar']]
+ */
+ public function set_columnsattributes(array $attributes): void {
+ $this->columnsattributes = $attributes;
+ }
+
+ /**
+ * Sets all columns' $propertys to the given $value in $this->column_style.
+ * @param int $property
+ * @param string $value
+ * @return void
+ */
+ public function column_style_all($property, $value) {
+ foreach (array_keys($this->columns) as $column) {
+ $this->column_style[$column][$property] = $value;
+ }
+ }
+
+ /**
+ * Sets $this->baseurl.
+ * @param moodle_url|string $url the url with params needed to call up this page
+ */
+ public function define_baseurl($url) {
+ $this->baseurl = new moodle_url($url);
+ }
+
+ /**
+ * Define the columns for the table.
+ *
+ * @param array $columns an array of identifying names for columns. If
+ * columns are sorted then column names must correspond to a field in sql.
+ */
+ public function define_columns($columns) {
+ $this->columns = [];
+ $this->column_style = [];
+ $this->column_class = [];
+ $this->columnsticky = [];
+ $this->columnsattributes = [];
+ $colnum = 0;
+
+ foreach ($columns as $column) {
+ $this->columns[$column] = $colnum++;
+ $this->column_style[$column] = [];
+ $this->column_class[$column] = '';
+ $this->columnsticky[$column] = '';
+ $this->columnsattributes[$column] = [];
+ $this->column_suppress[$column] = false;
+ }
+ }
+
+ /**
+ * Define the headers for the table, replacing any existing header configuration.
+ *
+ * @param array $headers numerical keyed array of displayed string titles
+ * for each column.
+ */
+ public function define_headers($headers) {
+ $this->headers = $headers;
+ }
+
+ /**
+ * Mark a specific column as being a table header using the column name defined in define_columns.
+ *
+ * Note: Only one column can be a header, and it will be rendered using a th tag.
+ *
+ * @param string $column
+ */
+ public function define_header_column(string $column) {
+ $this->headercolumn = $column;
+ }
+
+ /**
+ * Defines a help icon for the header
+ *
+ * Always use this function if you need to create header with sorting and help icon.
+ *
+ * @param renderable[] $helpicons An array of renderable objects to be used as help icons
+ */
+ public function define_help_for_headers($helpicons) {
+ $this->helpforheaders = $helpicons;
+ }
+
+ /**
+ * Mark the table preferences to be reset.
+ */
+ public function mark_table_to_reset(): void {
+ $this->resetting = true;
+ }
+
+ /**
+ * Is the table marked for reset preferences?
+ *
+ * @return bool True if the table is marked to reset, false otherwise.
+ */
+ protected function is_resetting_preferences(): bool {
+ if ($this->resetting === null) {
+ $this->resetting = optional_param($this->request[TABLE_VAR_RESET], false, PARAM_BOOL);
+ }
+
+ return $this->resetting;
+ }
+
+ /**
+ * Must be called after table is defined. Use methods above first. Cannot
+ * use functions below till after calling this method.
+ */
+ public function setup() {
+ if (empty($this->columns) || empty($this->uniqueid)) {
+ return false;
+ }
+
+ $this->initialise_table_preferences();
+
+ if (empty($this->baseurl)) {
+ debugging('You should set baseurl when using flexible_table.');
+ global $PAGE;
+ $this->baseurl = $PAGE->url;
+ }
+
+ if ($this->currpage == null) {
+ $this->currpage = optional_param($this->request[TABLE_VAR_PAGE], 0, PARAM_INT);
+ }
+
+ $this->setup = true;
+
+ // Always introduce the "flexible" class for the table if not specified.
+ if (empty($this->attributes)) {
+ $this->attributes['class'] = 'flexible table table-striped table-hover';
+ } else if (!isset($this->attributes['class'])) {
+ $this->attributes['class'] = 'flexible table table-striped table-hover';
+ } else if (!in_array('flexible', explode(' ', $this->attributes['class']))) {
+ $this->attributes['class'] = trim('flexible table table-striped table-hover ' . $this->attributes['class']);
+ }
+ }
+
+ /**
+ * Get the order by clause from the session or user preferences, for the table with id $uniqueid.
+ * @param string $uniqueid the identifier for a table.
+ * @return string SQL fragment that can be used in an ORDER BY clause.
+ */
+ public static function get_sort_for_table($uniqueid) {
+ global $SESSION;
+ if (isset($SESSION->flextable[$uniqueid])) {
+ $prefs = $SESSION->flextable[$uniqueid];
+ } else if (!$prefs = json_decode(get_user_preferences("flextable_{$uniqueid}", ''), true)) {
+ return '';
+ }
+
+ if (empty($prefs['sortby'])) {
+ return '';
+ }
+ if (empty($prefs['textsort'])) {
+ $prefs['textsort'] = [];
+ }
+
+ return self::construct_order_by($prefs['sortby'], $prefs['textsort']);
+ }
+
+ /**
+ * Prepare an an order by clause from the list of columns to be sorted.
+ *
+ * @param array $cols column name => SORT_ASC or SORT_DESC
+ * @return string SQL fragment that can be used in an ORDER BY clause.
+ */
+ public static function construct_order_by($cols, $textsortcols = []) {
+ global $DB;
+ $bits = [];
+
+ foreach ($cols as $column => $order) {
+ if (in_array($column, $textsortcols)) {
+ $column = $DB->sql_order_by_text($column);
+ }
+ if ($order == SORT_ASC) {
+ $bits[] = $DB->sql_order_by_null($column);
+ } else {
+ $bits[] = $DB->sql_order_by_null($column, SORT_DESC);
+ }
+ }
+
+ return implode(', ', $bits);
+ }
+
+ /**
+ * Get the SQL Sort clause for the table.
+ *
+ * @return string SQL fragment that can be used in an ORDER BY clause.
+ */
+ public function get_sql_sort() {
+ return self::construct_order_by($this->get_sort_columns(), $this->column_textsort);
+ }
+
+ /**
+ * Whether the current table contains any fullname columns
+ *
+ * @return bool
+ */
+ private function contains_fullname_columns(): bool {
+ $fullnamecolumns = array_intersect_key($this->columns, array_flip($this->userfullnamecolumns));
+
+ return !empty($fullnamecolumns);
+ }
+
+ /**
+ * Get the columns to sort by, in the form required by {@see construct_order_by()}.
+ * @return array column name => SORT_... constant.
+ */
+ public function get_sort_columns() {
+ if (!$this->setup) {
+ throw new coding_exception('Cannot call get_sort_columns until you have called setup.');
+ }
+
+ if (empty($this->prefs['sortby'])) {
+ return [];
+ }
+ foreach ($this->prefs['sortby'] as $column => $notused) {
+ if (isset($this->columns[$column])) {
+ continue; // This column is OK.
+ }
+ if (in_array($column, \core_user\fields::get_name_fields()) && $this->contains_fullname_columns()) {
+ continue; // This column is OK.
+ }
+ // This column is not OK.
+ unset($this->prefs['sortby'][$column]);
+ }
+
+ return $this->prefs['sortby'];
+ }
+
+ /**
+ * Get the starting row number for this page.
+ *
+ * @return int the offset for LIMIT clause of SQL
+ */
+ public function get_page_start() {
+ if (!$this->use_pages) {
+ return '';
+ }
+ return $this->currpage * $this->pagesize;
+ }
+
+ /**
+ * @return int the pagesize for LIMIT clause of SQL
+ */
+ public function get_page_size() {
+ if (!$this->use_pages) {
+ return '';
+ }
+ return $this->pagesize;
+ }
+
+ /**
+ * @return array sql to add to where statement.
+ */
+ public function get_sql_where() {
+ global $DB;
+
+ $conditions = [];
+ $params = [];
+
+ if ($this->contains_fullname_columns()) {
+ static $i = 0;
+ $i++;
+
+ if (!empty($this->prefs['i_first'])) {
+ $conditions[] = $DB->sql_like('firstname', ':ifirstc' . $i, false, false);
+ $params['ifirstc' . $i] = $this->prefs['i_first'] . '%';
+ }
+ if (!empty($this->prefs['i_last'])) {
+ $conditions[] = $DB->sql_like('lastname', ':ilastc' . $i, false, false);
+ $params['ilastc' . $i] = $this->prefs['i_last'] . '%';
+ }
+ }
+
+ return [implode(" AND ", $conditions), $params];
+ }
+
+ /**
+ * Add a row of data to the table. This function takes an array or object with
+ * column names as keys or property names.
+ *
+ * It ignores any elements with keys that are not defined as columns. It
+ * puts in empty strings into the row when there is no element in the passed
+ * array corresponding to a column in the table. It puts the row elements in
+ * the proper order (internally row table data is stored by in arrays with
+ * a numerical index corresponding to the column number).
+ *
+ * @param object|array $rowwithkeys array keys or object property names are column names,
+ * as defined in call to define_columns.
+ * @param string $classname CSS class name to add to this row's tr tag.
+ */
+ public function add_data_keyed($rowwithkeys, $classname = '') {
+ $this->add_data($this->get_row_from_keyed($rowwithkeys), $classname);
+ }
+
+ /**
+ * Add a number of rows to the table at once. And optionally finish output after they have been added.
+ *
+ * @param (object|array|null)[] $rowstoadd Array of rows to add to table, a null value in array adds a separator row. Or a
+ * object or array is added to table. We expect properties for the row array as would be
+ * passed to add_data_keyed.
+ * @param bool $finish
+ */
+ public function format_and_add_array_of_rows($rowstoadd, $finish = true) {
+ foreach ($rowstoadd as $row) {
+ if (is_null($row)) {
+ $this->add_separator();
+ } else {
+ $this->add_data_keyed($this->format_row($row));
+ }
+ }
+ if ($finish) {
+ $this->finish_output(!$this->is_downloading());
+ }
+ }
+
+ /**
+ * Add a seperator line to table.
+ */
+ public function add_separator() {
+ if (!$this->setup) {
+ return false;
+ }
+ $this->add_data(null);
+ }
+
+ /**
+ * This method actually directly echoes the row passed to it now or adds it
+ * to the download. If this is the first row and start_output has not
+ * already been called this method also calls start_output to open the table
+ * or send headers for the downloaded.
+ * Can be used as before. print_html now calls finish_html to close table.
+ *
+ * @param array $row a numerically keyed row of data to add to the table.
+ * @param string $classname CSS class name to add to this row's tr tag.
+ * @return bool success.
+ */
+ public function add_data($row, $classname = '') {
+ if (!$this->setup) {
+ return false;
+ }
+ if (!$this->started_output) {
+ $this->start_output();
+ }
+ if ($this->exportclass !== null) {
+ if ($row === null) {
+ $this->exportclass->add_seperator();
+ } else {
+ $this->exportclass->add_data($row);
+ }
+ } else {
+ $this->print_row($row, $classname);
+ }
+ return true;
+ }
+
+ /**
+ * You should call this to finish outputting the table data after adding
+ * data to the table with add_data or add_data_keyed.
+ *
+ */
+ public function finish_output($closeexportclassdoc = true) {
+ if ($this->exportclass !== null) {
+ $this->exportclass->finish_table();
+ if ($closeexportclassdoc) {
+ $this->exportclass->finish_document();
+ }
+ } else {
+ $this->finish_html();
+ }
+ }
+
+ /**
+ * Hook that can be overridden in child classes to wrap a table in a form
+ * for example. Called only when there is data to display and not
+ * downloading.
+ */
+ public function wrap_html_start() {
+ }
+
+ /**
+ * Hook that can be overridden in child classes to wrap a table in a form
+ * for example. Called only when there is data to display and not
+ * downloading.
+ */
+ public function wrap_html_finish() {
+ }
+
+ /**
+ * Call appropriate methods on this table class to perform any processing on values before displaying in table.
+ * Takes raw data from the database and process it into human readable format, perhaps also adding html linking when
+ * displaying table as html, adding a div wrap, etc.
+ *
+ * See for example col_fullname below which will be called for a column whose name is 'fullname'.
+ *
+ * @param array|object $row row of data from db used to make one row of the table.
+ * @return array one row for the table, added using add_data_keyed method.
+ */
+ public function format_row($row) {
+ if (is_array($row)) {
+ $row = (object)$row;
+ }
+ $formattedrow = [];
+ foreach (array_keys($this->columns) as $column) {
+ $colmethodname = 'col_' . $column;
+ if (method_exists($this, $colmethodname)) {
+ $formattedcolumn = $this->$colmethodname($row);
+ } else {
+ $formattedcolumn = $this->other_cols($column, $row);
+ if ($formattedcolumn === null) {
+ $formattedcolumn = $row->$column;
+ }
+ }
+ $formattedrow[$column] = $formattedcolumn;
+ }
+ return $formattedrow;
+ }
+
+ /**
+ * Fullname is treated as a special columname in tablelib and should always
+ * be treated the same as the fullname of a user.
+ * @uses $this->useridfield if the userid field is not expected to be id
+ * then you need to override $this->useridfield to point at the correct
+ * field for the user id.
+ *
+ * @param object $row the data from the db containing all fields from the
+ * users table necessary to construct the full name of the user in
+ * current language.
+ * @return string contents of cell in column 'fullname', for this row.
+ */
+ public function col_fullname($row) {
+ global $COURSE;
+
+ $name = fullname($row, has_capability('moodle/site:viewfullnames', $this->get_context()));
+ if ($this->download) {
+ return $name;
+ }
+
+ $userid = $row->{$this->useridfield};
+ if ($COURSE->id == SITEID) {
+ $profileurl = new moodle_url('/user/profile.php', ['id' => $userid]);
+ } else {
+ $profileurl = new moodle_url(
+ '/user/view.php',
+ ['id' => $userid, 'course' => $COURSE->id]
+ );
+ }
+ return html_writer::link($profileurl, $name);
+ }
+
+ /**
+ * You can override this method in a child class. See the description of
+ * build_table which calls this method.
+ */
+ public function other_cols($column, $row) {
+ if (
+ isset($row->$column) && ($column === 'email' || $column === 'idnumber') &&
+ (!$this->is_downloading() || $this->export_class_instance()->supports_html())
+ ) {
+ // Columns email and idnumber may potentially contain malicious characters, escape them by default.
+ // This function will not be executed if the child class implements col_email() or col_idnumber().
+ return s($row->$column);
+ }
+ return null;
+ }
+
+ /**
+ * Used from col_* functions when text is to be displayed. Does the
+ * right thing - either converts text to html or strips any html tags
+ * depending on if we are downloading and what is the download type. Params
+ * are the same as format_text function in weblib.php but some default
+ * options are changed.
+ */
+ public function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseid = null) {
+ if (!$this->is_downloading()) {
+ if (is_null($options)) {
+ $options = new stdClass();
+ }
+ // Some sensible defaults.
+ if (!isset($options->para)) {
+ $options->para = false;
+ }
+ if (!isset($options->newlines)) {
+ $options->newlines = false;
+ }
+ if (!isset($options->filter)) {
+ $options->filter = false;
+ }
+ return format_text($text, $format, $options);
+ } else {
+ $eci = $this->export_class_instance();
+ return $eci->format_text($text, $format, $options, $courseid);
+ }
+ }
+ /**
+ * This method is deprecated although the old api is still supported.
+ * @deprecated 1.9.2 - Jun 2, 2008
+ */
+ public function print_html() {
+ if (!$this->setup) {
+ return false;
+ }
+ $this->finish_html();
+ }
+
+ /**
+ * This function is not part of the public api.
+ * @return string initial of first name we are currently filtering by
+ */
+ public function get_initial_first() {
+ if (!$this->use_initials) {
+ return null;
+ }
+
+ return $this->prefs['i_first'];
+ }
+
+ /**
+ * This function is not part of the public api.
+ * @return string initial of last name we are currently filtering by
+ */
+ public function get_initial_last() {
+ if (!$this->use_initials) {
+ return null;
+ }
+
+ return $this->prefs['i_last'];
+ }
+
+ /**
+ * Helper function, used by {@see print_initials_bar()} to output one initial bar.
+ * @param array $alpha of letters in the alphabet.
+ * @param string $current the currently selected letter.
+ * @param string $class class name to add to this initial bar.
+ * @param string $title the name to put in front of this initial bar.
+ * @param string $urlvar URL parameter name for this initial.
+ *
+ * @deprecated since Moodle 3.3
+ */
+ protected function print_one_initials_bar($alpha, $current, $class, $title, $urlvar) {
+
+ debugging('Method print_one_initials_bar() is no longer used and has been deprecated, ' .
+ 'to print initials bar call print_initials_bar()', DEBUG_DEVELOPER);
+
+ echo html_writer::start_tag('div', ['class' => 'initialbar ' . $class]) .
+ $title . ' : ';
+ if ($current) {
+ echo html_writer::link($this->baseurl->out(false, [$urlvar => '']), get_string('all'));
+ } else {
+ echo html_writer::tag('strong', get_string('all'));
+ }
+
+ foreach ($alpha as $letter) {
+ if ($letter === $current) {
+ echo html_writer::tag('strong', $letter);
+ } else {
+ echo html_writer::link($this->baseurl->out(false, [$urlvar => $letter]), $letter);
+ }
+ }
+
+ echo html_writer::end_tag('div');
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function print_initials_bar() {
+ global $OUTPUT;
+
+ $ifirst = $this->get_initial_first();
+ $ilast = $this->get_initial_last();
+ if (is_null($ifirst)) {
+ $ifirst = '';
+ }
+ if (is_null($ilast)) {
+ $ilast = '';
+ }
+
+ if ((!empty($ifirst) || !empty($ilast) || $this->use_initials) && $this->contains_fullname_columns()) {
+ $prefixfirst = $this->request[TABLE_VAR_IFIRST];
+ $prefixlast = $this->request[TABLE_VAR_ILAST];
+ echo $OUTPUT->initials_bar($ifirst, 'firstinitial', get_string('firstname'), $prefixfirst, $this->baseurl);
+ echo $OUTPUT->initials_bar($ilast, 'lastinitial', get_string('lastname'), $prefixlast, $this->baseurl);
+ }
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function print_nothing_to_display() {
+ global $OUTPUT;
+
+ // Render the dynamic table header.
+ echo $this->get_dynamic_table_html_start();
+
+ // Render button to allow user to reset table preferences.
+ echo $this->render_reset_button();
+
+ $this->print_initials_bar();
+
+ echo $OUTPUT->notification(get_string('nothingtodisplay'), 'info', false);
+
+ // Render the dynamic table footer.
+ echo $this->get_dynamic_table_html_end();
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function get_row_from_keyed($rowwithkeys) {
+ if (is_object($rowwithkeys)) {
+ $rowwithkeys = (array)$rowwithkeys;
+ }
+ $row = [];
+ foreach (array_keys($this->columns) as $column) {
+ if (isset($rowwithkeys[$column])) {
+ $row[] = $rowwithkeys[$column];
+ } else {
+ $row[] = '';
+ }
+ }
+ return $row;
+ }
+
+ /**
+ * Get the html for the download buttons
+ *
+ * Usually only use internally
+ */
+ public function download_buttons() {
+ global $OUTPUT;
+
+ if ($this->is_downloadable() && !$this->is_downloading()) {
+ return $OUTPUT->download_dataformat_selector(
+ get_string('downloadas', 'table'),
+ $this->baseurl->out_omit_querystring(),
+ 'download',
+ $this->baseurl->params()
+ );
+ } else {
+ return '';
+ }
+ }
+
+ /**
+ * This function is not part of the public api.
+ * You don't normally need to call this. It is called automatically when
+ * needed when you start adding data to the table.
+ *
+ */
+ public function start_output() {
+ $this->started_output = true;
+ if ($this->exportclass !== null) {
+ $this->exportclass->start_table($this->sheettitle);
+ $this->exportclass->output_headers($this->headers);
+ } else {
+ $this->start_html();
+ $this->print_headers();
+ echo html_writer::start_tag('tbody');
+ }
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function print_row($row, $classname = '') {
+ echo $this->get_row_html($row, $classname);
+ }
+
+ /**
+ * Generate html code for the passed row.
+ *
+ * @param array $row Row data.
+ * @param string $classname classes to add.
+ *
+ * @return string $html html code for the row passed.
+ */
+ public function get_row_html($row, $classname = '') {
+ static $suppresslastrow = null;
+ $rowclasses = [];
+
+ if ($classname) {
+ $rowclasses[] = $classname;
+ }
+
+ $rowid = $this->uniqueid . '_r' . $this->currentrow;
+ $html = '';
+
+ $html .= html_writer::start_tag('tr', ['class' => implode(' ', $rowclasses), 'id' => $rowid]);
+
+ // If we have a separator, print it.
+ if ($row === null) {
+ $colcount = count($this->columns);
+ $html .= html_writer::tag('td', html_writer::tag(
+ 'div',
+ '',
+ ['class' => 'tabledivider']
+ ), ['colspan' => $colcount]);
+ } else {
+ $html .= $this->get_row_cells_html($rowid, $row, $suppresslastrow);
+ }
+
+ $html .= html_writer::end_tag('tr');
+
+ $suppressenabled = array_sum($this->column_suppress);
+ if ($suppressenabled) {
+ $suppresslastrow = $row;
+ }
+ $this->currentrow++;
+ return $html;
+ }
+
+ /**
+ * Generate html code for the row cells.
+ *
+ * @param string $rowid
+ * @param array $row
+ * @param array|null $suppresslastrow
+ * @return string
+ */
+ public function get_row_cells_html(string $rowid, array $row, ?array $suppresslastrow): string {
+ $html = '';
+ $colbyindex = array_flip($this->columns);
+ foreach ($row as $index => $data) {
+ $column = $colbyindex[$index];
+
+ $columnattributes = $this->columnsattributes[$column] ?? [];
+ if (isset($columnattributes['class'])) {
+ $this->column_class($column, $columnattributes['class']);
+ unset($columnattributes['class']);
+ }
+
+ $attributes = [
+ 'class' => "cell c{$index}" . $this->column_class[$column] . $this->columnsticky[$column],
+ 'id' => "{$rowid}_c{$index}",
+ 'style' => $this->make_styles_string($this->column_style[$column]),
+ ];
+
+ $celltype = 'td';
+ if ($this->headercolumn && $column == $this->headercolumn) {
+ $celltype = 'th';
+ $attributes['scope'] = 'row';
+ }
+
+ $attributes += $columnattributes;
+
+ if (empty($this->prefs['collapse'][$column])) {
+ if ($this->column_suppress[$column] && $suppresslastrow !== null && $suppresslastrow[$index] === $data) {
+ $content = ' ';
+ } else {
+ $content = $data;
+ }
+ } else {
+ $content = ' ';
+ }
+
+ $html .= html_writer::tag($celltype, $content, $attributes);
+ }
+ return $html;
+ }
+
+ /**
+ * This function is not part of the public api.
+ */
+ public function finish_html() {
+ global $OUTPUT, $PAGE;
+
+ if (!$this->started_output) {
+ // No data has been added to the table.
+ $this->print_nothing_to_display();
+ } else {
+ // Print empty rows to fill the table to the current pagesize.
+ // This is done so the header aria-controls attributes do not point to
+ // non existant elements.
+ $emptyrow = array_fill(0, count($this->columns), '');
+ while ($this->currentrow < $this->pagesize) {
+ $this->print_row($emptyrow, 'emptyrow');
+ }
+
+ echo html_writer::end_tag('tbody');
+ echo html_writer::end_tag('table');
+ if ($this->responsive) {
+ echo html_writer::end_tag('div');
+ }
+ $this->wrap_html_finish();
+
+ // Paging bar.
+ if (in_array(TABLE_P_BOTTOM, $this->showdownloadbuttonsat)) {
+ echo $this->download_buttons();
+ }
+
+ if ($this->use_pages) {
+ $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
+ $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
+ echo $OUTPUT->render($pagingbar);
+ }
+
+ // Render the dynamic table footer.
+ echo $this->get_dynamic_table_html_end();
+ }
+ }
+
+ /**
+ * Generate the HTML for the collapse/uncollapse icon. This is a helper method
+ * used by {@see print_headers()}.
+ * @param string $column the column name, index into various names.
+ * @param int $index numerical index of the column.
+ * @return string HTML fragment.
+ */
+ protected function show_hide_link($column, $index) {
+ global $OUTPUT;
+ // Some headers contain tags, do not include in title, hence the + // strip tags. + + $ariacontrols = ''; + for ($i = 0; $i < $this->pagesize; $i++) { + $ariacontrols .= $this->uniqueid . '_r' . $i . '_c' . $index . ' '; + } + + $ariacontrols = trim($ariacontrols); + + if (!empty($this->prefs['collapse'][$column])) { + $linkattributes = [ + 'title' => get_string('show') . ' ' . strip_tags($this->headers[$index]), + 'aria-expanded' => 'false', + 'aria-controls' => $ariacontrols, + 'data-action' => 'show', + 'data-column' => $column, + 'role' => 'button', + ]; + return html_writer::link( + $this->baseurl->out(false, [$this->request[TABLE_VAR_SHOW] => $column]), + $OUTPUT->pix_icon('t/switch_plus', null), + $linkattributes + ); + } else if ($this->headers[$index] !== null) { + $linkattributes = [ + 'title' => get_string('hide') . ' ' . strip_tags($this->headers[$index]), + 'aria-expanded' => 'true', + 'aria-controls' => $ariacontrols, + 'data-action' => 'hide', + 'data-column' => $column, + 'role' => 'button', + ]; + return html_writer::link( + $this->baseurl->out(false, [$this->request[TABLE_VAR_HIDE] => $column]), + $OUTPUT->pix_icon('t/switch_minus', null), + $linkattributes + ); + } + } + + /** + * This function is not part of the public api. + */ + public function print_headers() { + global $CFG, $OUTPUT; + + // Set the primary sort column/order where possible, so that sort links/icons are correct. + [ + 'sortby' => $primarysortcolumn, + 'sortorder' => $primarysortorder, + ] = $this->get_primary_sort_order(); + + echo html_writer::start_tag('thead'); + echo html_writer::start_tag('tr'); + foreach ($this->columns as $column => $index) { + $iconhide = ''; + if ($this->is_collapsible) { + $iconhide = $this->show_hide_link($column, $index); + } + switch ($column) { + case 'userpic': + // Do nothing, do not display sortable links. + break; + + default: + if (array_search($column, $this->userfullnamecolumns) !== false) { + // Check the full name display for sortable fields. + if (has_capability('moodle/site:viewfullnames', $this->get_context())) { + $nameformat = $CFG->alternativefullnameformat; + } else { + $nameformat = $CFG->fullnamedisplay; + } + + if ($nameformat == 'language') { + $nameformat = get_string('fullnamedisplay'); + } + + $requirednames = order_in_string(\core_user\fields::get_name_fields(), $nameformat); + + if (!empty($requirednames)) { + if ($this->is_sortable($column)) { + // Done this way for the possibility of more than two sortable full name display fields. + $this->headers[$index] = ''; + foreach ($requirednames as $name) { + $sortname = $this->sort_link( + get_string($name), + $name, + $primarysortcolumn === $name, + $primarysortorder + ); + $this->headers[$index] .= $sortname . ' / '; + } + $helpicon = ''; + if (isset($this->helpforheaders[$index])) { + $helpicon = $OUTPUT->render($this->helpforheaders[$index]); + } + $this->headers[$index] = substr($this->headers[$index], 0, -3) . $helpicon; + } + } + } else if ($this->is_sortable($column)) { + $helpicon = ''; + if (isset($this->helpforheaders[$index])) { + $helpicon = $OUTPUT->render($this->helpforheaders[$index]); + } + $this->headers[$index] = $this->sort_link( + $this->headers[$index], + $column, + $primarysortcolumn == $column, + $primarysortorder + ) . $helpicon; + } + } + + $attributes = [ + 'class' => 'header c' . $index . $this->column_class[$column] . $this->columnsticky[$column], + 'scope' => 'col', + ]; + if ($this->headers[$index] === null) { + $content = ' '; + } else if (!empty($this->prefs['collapse'][$column])) { + $content = $iconhide; + } else { + if (is_array($this->column_style[$column])) { + $attributes['style'] = $this->make_styles_string($this->column_style[$column]); + } + $helpicon = ''; + if (isset($this->helpforheaders[$index]) && !$this->is_sortable($column)) { + $helpicon = $OUTPUT->render($this->helpforheaders[$index]); + } + $content = $this->headers[$index] . $helpicon . html_writer::tag( + 'div', + $iconhide, + ['class' => 'commands'] + ); + } + echo html_writer::tag('th', $content, $attributes); + } + + echo html_writer::end_tag('tr'); + echo html_writer::end_tag('thead'); + } + + /** + * Calculate the preferences for sort order based on user-supplied values and get params. + */ + protected function set_sorting_preferences(): void { + $sortdata = $this->sortdata; + + if ($sortdata === null) { + $sortdata = $this->prefs['sortby']; + + $sortorder = optional_param($this->request[TABLE_VAR_DIR], $this->sort_default_order, PARAM_INT); + $sortby = optional_param($this->request[TABLE_VAR_SORT], '', PARAM_ALPHANUMEXT); + + if (array_key_exists($sortby, $sortdata)) { + // This key already exists somewhere. Change its sortorder and bring it to the top. + unset($sortdata[$sortby]); + } + $sortdata = array_merge([$sortby => $sortorder], $sortdata); + } + + $usernamefields = \core_user\fields::get_name_fields(); + $sortdata = array_filter($sortdata, function ($sortby) use ($usernamefields) { + $isvalidsort = $sortby && $this->is_sortable($sortby); + $isvalidsort = $isvalidsort && empty($this->prefs['collapse'][$sortby]); + $isrealcolumn = isset($this->columns[$sortby]); + $isfullnamefield = $this->contains_fullname_columns() && in_array($sortby, $usernamefields); + + return $isvalidsort && ($isrealcolumn || $isfullnamefield); + }, ARRAY_FILTER_USE_KEY); + + // Finally, make sure that no more than $this->maxsortkeys are present into the array. + $sortdata = array_slice($sortdata, 0, $this->maxsortkeys); + + // If a default order is defined and it is not in the current list of order by columns, add it at the end. + // This prevents results from being returned in a random order if the only order by column contains equal values. + if (!empty($this->sort_default_column) && !array_key_exists($this->sort_default_column, $sortdata)) { + $sortdata = array_merge($sortdata, [$this->sort_default_column => $this->sort_default_order]); + } + + // Apply the sortdata to the preference. + $this->prefs['sortby'] = $sortdata; + } + + /** + * Fill in the preferences for the initials bar. + */ + protected function set_initials_preferences(): void { + $ifirst = $this->ifirst; + $ilast = $this->ilast; + + if ($ifirst === null) { + $ifirst = optional_param($this->request[TABLE_VAR_IFIRST], null, PARAM_RAW); + } + + if ($ilast === null) { + $ilast = optional_param($this->request[TABLE_VAR_ILAST], null, PARAM_RAW); + } + + if (!is_null($ifirst) && ($ifirst === '' || strpos(get_string('alphabet', 'langconfig'), $ifirst) !== false)) { + $this->prefs['i_first'] = $ifirst; + } + + if (!is_null($ilast) && ($ilast === '' || strpos(get_string('alphabet', 'langconfig'), $ilast) !== false)) { + $this->prefs['i_last'] = $ilast; + } + } + + /** + * Set hide and show preferences. + */ + protected function set_hide_show_preferences(): void { + + if ($this->hiddencolumns !== null) { + $this->prefs['collapse'] = array_fill_keys(array_filter($this->hiddencolumns, function ($column) { + return array_key_exists($column, $this->columns); + }), true); + } else { + if ($column = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) { + if (isset($this->columns[$column])) { + $this->prefs['collapse'][$column] = true; + } + } + } + + if ($column = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) { + unset($this->prefs['collapse'][$column]); + } + + foreach (array_keys($this->prefs['collapse']) as $column) { + if (array_key_exists($column, $this->prefs['sortby'])) { + unset($this->prefs['sortby'][$column]); + } + } + } + + /** + * Set the list of hidden columns. + * + * @param array $columns The list of hidden columns. + */ + public function set_hidden_columns(array $columns): void { + $this->hiddencolumns = $columns; + } + + /** + * Initialise table preferences. + */ + protected function initialise_table_preferences(): void { + global $SESSION; + + // Load any existing user preferences. + if ($this->persistent) { + $this->prefs = json_decode(get_user_preferences("flextable_{$this->uniqueid}", ''), true); + $oldprefs = $this->prefs; + } else if (isset($SESSION->flextable[$this->uniqueid])) { + $this->prefs = $SESSION->flextable[$this->uniqueid]; + $oldprefs = $this->prefs; + } + + // Set up default preferences if needed. + if (!$this->prefs || $this->is_resetting_preferences()) { + $this->prefs = [ + 'collapse' => [], + 'sortby' => [], + 'i_first' => '', + 'i_last' => '', + 'textsort' => $this->column_textsort, + ]; + } + + if (!isset($oldprefs)) { + $oldprefs = $this->prefs; + } + + // Save user preferences if they have changed. + if ($this->is_resetting_preferences()) { + $this->sortdata = null; + $this->ifirst = null; + $this->ilast = null; + } + + if ( + ($showcol = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) && + isset($this->columns[$showcol]) + ) { + $this->prefs['collapse'][$showcol] = false; + } else if ( + ($hidecol = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) && + isset($this->columns[$hidecol]) + ) { + $this->prefs['collapse'][$hidecol] = true; + if (array_key_exists($hidecol, $this->prefs['sortby'])) { + unset($this->prefs['sortby'][$hidecol]); + } + } + + $this->set_hide_show_preferences(); + $this->set_sorting_preferences(); + $this->set_initials_preferences(); + + // Now, reduce the width of collapsed columns and remove the width from columns that should be expanded. + foreach (array_keys($this->columns) as $column) { + if (!empty($this->prefs['collapse'][$column])) { + $this->column_style[$column]['width'] = '10px'; + } else { + unset($this->column_style[$column]['width']); + } + } + + if (empty($this->baseurl)) { + debugging('You should set baseurl when using flexible_table.'); + global $PAGE; + $this->baseurl = $PAGE->url; + } + + if ($this->currpage == null) { + $this->currpage = optional_param($this->request[TABLE_VAR_PAGE], 0, PARAM_INT); + } + + $this->save_preferences($oldprefs); + } + + /** + * Save preferences. + * + * @param array $oldprefs Old preferences to compare against. + */ + protected function save_preferences($oldprefs): void { + global $SESSION; + + if ($this->prefs != $oldprefs) { + if ($this->persistent) { + set_user_preference('flextable_' . $this->uniqueid, json_encode($this->prefs)); + } else { + $SESSION->flextable[$this->uniqueid] = $this->prefs; + } + } + unset($oldprefs); + } + + /** + * Set the preferred table sorting attributes. + * + * @param string $sortby The field to sort by. + * @param int $sortorder The sort order. + */ + public function set_sortdata(array $sortdata): void { + $this->sortdata = []; + foreach ($sortdata as $sortitem) { + if (!array_key_exists($sortitem['sortby'], $this->sortdata)) { + $this->sortdata[$sortitem['sortby']] = (int) $sortitem['sortorder']; + } + } + } + + /** + * Get the default per page. + * + * @return int + */ + public function get_default_per_page(): int { + return $this->defaultperpage; + } + + /** + * Set the default per page. + * + * @param int $defaultperpage + */ + public function set_default_per_page(int $defaultperpage): void { + $this->defaultperpage = $defaultperpage; + } + + /** + * Set the preferred first name initial in an initials bar. + * + * @param string $initial The character to set + */ + public function set_first_initial(string $initial): void { + $this->ifirst = $initial; + } + + /** + * Set the preferred last name initial in an initials bar. + * + * @param string $initial The character to set + */ + public function set_last_initial(string $initial): void { + $this->ilast = $initial; + } + + /** + * Set the page number. + * + * @param int $pagenumber The page number. + */ + public function set_page_number(int $pagenumber): void { + $this->currpage = $pagenumber - 1; + } + + /** + * Generate the HTML for the sort icon. This is a helper method used by {@see sort_link()}. + * @param bool $isprimary whether an icon is needed (it is only needed for the primary sort column.) + * @param int $order SORT_ASC or SORT_DESC + * @return string HTML fragment. + */ + protected function sort_icon($isprimary, $order) { + global $OUTPUT; + + if (!$isprimary) { + return ''; + } + + if ($order == SORT_ASC) { + return $OUTPUT->pix_icon('t/sort_asc', get_string('asc')); + } else { + return $OUTPUT->pix_icon('t/sort_desc', get_string('desc')); + } + } + + /** + * Generate the correct tool tip for changing the sort order. This is a + * helper method used by {@see sort_link()}. + * @param bool $isprimary whether the is column is the current primary sort column. + * @param int $order SORT_ASC or SORT_DESC + * @return string the correct title. + */ + protected function sort_order_name($isprimary, $order) { + if ($isprimary && $order != SORT_ASC) { + return get_string('desc'); + } else { + return get_string('asc'); + } + } + + /** + * Generate the HTML for the sort link. This is a helper method used by {@see print_headers()}. + * @param string $text the text for the link. + * @param string $column the column name, may be a fake column like 'firstname' or a real one. + * @param bool $isprimary whether the is column is the current primary sort column. + * @param int $order SORT_ASC or SORT_DESC + * @return string HTML fragment. + */ + protected function sort_link($text, $column, $isprimary, $order) { + // If we are already sorting by this column, switch direction. + if (array_key_exists($column, $this->prefs['sortby'])) { + $sortorder = $this->prefs['sortby'][$column] == SORT_ASC ? SORT_DESC : SORT_ASC; + } else { + $sortorder = $order; + } + + $params = [ + $this->request[TABLE_VAR_SORT] => $column, + $this->request[TABLE_VAR_DIR] => $sortorder, + ]; + + return html_writer::link( + $this->baseurl->out(false, $params), + $text . get_accesshide(get_string('sortby') . ' ' . + $text . ' ' . $this->sort_order_name($isprimary, $order)), + [ + 'data-sortable' => $this->is_sortable($column), + 'data-sortby' => $column, + 'data-sortorder' => $sortorder, + 'role' => 'button', + ] + ) . ' ' . $this->sort_icon($isprimary, $order); + } + + /** + * Return primary sorting column/order, either the first preferred "sortby" value or defaults defined for the table + * + * @return array + */ + protected function get_primary_sort_order(): array { + if (reset($this->prefs['sortby'])) { + return $this->get_sort_order(); + } + + return [ + 'sortby' => $this->sort_default_column, + 'sortorder' => $this->sort_default_order, + ]; + } + + /** + * Return sorting attributes values. + * + * @return array + */ + protected function get_sort_order(): array { + $sortbys = $this->prefs['sortby']; + $sortby = key($sortbys); + + return [ + 'sortby' => $sortby, + 'sortorder' => $sortbys[$sortby], + ]; + } + + /** + * Get dynamic class component. + * + * @return string + */ + protected function get_component() { + $tableclass = explode("\\", get_class($this)); + return reset($tableclass); + } + + /** + * Get dynamic class handler. + * + * @return string + */ + protected function get_handler() { + $tableclass = explode("\\", get_class($this)); + return end($tableclass); + } + + /** + * Get the dynamic table start wrapper. + * If this is not a dynamic table, then an empty string is returned making this safe to blindly call. + * + * @return string + */ + protected function get_dynamic_table_html_start(): string { + if (is_a($this, dynamic::class)) { + $sortdata = array_map(function ($sortby, $sortorder) { + return [ + 'sortby' => $sortby, + 'sortorder' => $sortorder, + ]; + }, array_keys($this->prefs['sortby']), array_values($this->prefs['sortby'])); + ; + + return html_writer::start_tag('div', [ + 'class' => 'table-dynamic position-relative', + 'data-region' => 'core_table/dynamic', + 'data-table-handler' => $this->get_handler(), + 'data-table-component' => $this->get_component(), + 'data-table-uniqueid' => $this->uniqueid, + 'data-table-filters' => json_encode($this->get_filterset()), + 'data-table-sort-data' => json_encode($sortdata), + 'data-table-first-initial' => $this->prefs['i_first'], + 'data-table-last-initial' => $this->prefs['i_last'], + 'data-table-page-number' => $this->currpage + 1, + 'data-table-page-size' => $this->pagesize, + 'data-table-default-per-page' => $this->get_default_per_page(), + 'data-table-hidden-columns' => json_encode(array_keys($this->prefs['collapse'])), + 'data-table-total-rows' => $this->totalrows, + ]); + } + + return ''; + } + + /** + * Get the dynamic table end wrapper. + * If this is not a dynamic table, then an empty string is returned making this safe to blindly call. + * + * @return string + */ + protected function get_dynamic_table_html_end(): string { + global $PAGE; + + if (is_a($this, dynamic::class)) { + $output = ''; + + $perpageurl = new moodle_url($PAGE->url); + + // Generate "Show all/Show per page" link. + if ($this->pagesize == TABLE_SHOW_ALL_PAGE_SIZE && $this->totalrows > $this->get_default_per_page()) { + $perpagesize = $this->get_default_per_page(); + $perpagestring = get_string('showperpage', '', $this->get_default_per_page()); + } else if ($this->pagesize < $this->totalrows) { + $perpagesize = TABLE_SHOW_ALL_PAGE_SIZE; + $perpagestring = get_string('showall', '', $this->totalrows); + } + if (isset($perpagesize) && isset($perpagestring)) { + $perpageurl->param('perpage', $perpagesize); + $output .= html_writer::link( + $perpageurl, + $perpagestring, + [ + 'data-action' => 'showcount', + 'data-target-page-size' => $perpagesize, + ] + ); + } + + $PAGE->requires->js_call_amd('core_table/dynamic', 'init'); + $output .= html_writer::end_tag('div'); + return $output; + } + + return ''; + } + + /** + * This function is not part of the public api. + */ + public function start_html() { + global $OUTPUT; + + // Render the dynamic table header. + echo $this->get_dynamic_table_html_start(); + + // Render button to allow user to reset table preferences. + echo $this->render_reset_button(); + + // Do we need to print initial bars? + $this->print_initials_bar(); + + // Paging bar. + if ($this->use_pages) { + $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl); + $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE]; + echo $OUTPUT->render($pagingbar); + } + + if (in_array(TABLE_P_TOP, $this->showdownloadbuttonsat)) { + echo $this->download_buttons(); + } + + $this->wrap_html_start(); + // Start of main data table. + + if ($this->responsive) { + echo html_writer::start_tag('div', ['class' => 'no-overflow']); + } + echo html_writer::start_tag('table', $this->attributes) . $this->render_caption(); + } + + /** + * This function set caption for table. + * + * @param string $caption Caption of table. + * @param array|null $captionattributes Caption attributes of table. + */ + public function set_caption(string $caption, ?array $captionattributes): void { + $this->caption = $caption; + $this->captionattributes = $captionattributes; + } + + /** + * This function renders a table caption. + * + * @return string $output Caption of table. + */ + public function render_caption(): string { + if ($this->caption === null) { + return ''; + } + + return html_writer::tag( + 'caption', + $this->caption, + $this->captionattributes, + ); + } + + /** + * This function is not part of the public api. + * @param array $styles CSS-property => value + * @return string values suitably to go in a style="" attribute in HTML. + */ + public function make_styles_string($styles) { + if (empty($styles)) { + return null; + } + + $string = ''; + foreach ($styles as $property => $value) { + $string .= $property . ':' . $value . ';'; + } + return $string; + } + + /** + * Generate the HTML for the table preferences reset button. + * + * @return string HTML fragment, empty string if no need to reset + */ + protected function render_reset_button() { + + if (!$this->can_be_reset()) { + return ''; + } + + $url = $this->baseurl->out(false, [$this->request[TABLE_VAR_RESET] => 1]); + + $html = html_writer::start_div('resettable mdl-right'); + $html .= html_writer::link($url, get_string('resettable'), ['role' => 'button']); + $html .= html_writer::end_div(); + + return $html; + } + + /** + * Are there some table preferences that can be reset? + * + * If true, then the "reset table preferences" widget should be displayed. + * + * @return bool + */ + protected function can_be_reset() { + // Loop through preferences and make sure they are empty or set to the default value. + foreach ($this->prefs as $prefname => $prefval) { + if ($prefname === 'sortby' && !empty($this->sort_default_column)) { + // Check if the actual sorting differs from the default one. + if (empty($prefval) || ($prefval !== [$this->sort_default_column => $this->sort_default_order])) { + return true; + } + } else if ($prefname === 'collapse' && !empty($prefval)) { + // Check if there are some collapsed columns (all are expanded by default). + foreach ($prefval as $columnname => $iscollapsed) { + if ($iscollapsed) { + return true; + } + } + } else if (!empty($prefval)) { + // For all other cases, we just check if some preference is set. + return true; + } + } + + return false; + } + + /** + * Get the context for the table. + * + * Note: This function _must_ be overridden by dynamic tables to ensure that the context is correctly determined + * from the filterset parameters. + * + * @return context + */ + public function get_context(): context { + global $PAGE; + + if (is_a($this, dynamic::class)) { + throw new coding_exception('The get_context function must be defined for a dynamic table'); + } + + return $PAGE->context; + } + + /** + * Set the filterset in the table class. + * + * The use of filtersets is a requirement for dynamic tables, but can be used by other tables too if desired. + * + * @param filterset $filterset The filterset object to get filters and table parameters from + */ + public function set_filterset(filterset $filterset): void { + $this->filterset = $filterset; + + $this->guess_base_url(); + } + + /** + * Get the currently defined filterset. + * + * @return filterset + */ + public function get_filterset(): ?filterset { + return $this->filterset; + } + + /** + * Get the class used as a filterset. + * + * @return string + */ + public static function get_filterset_class(): string { + return static::class . '_filterset'; + } + + /** + * Attempt to guess the base URL. + */ + public function guess_base_url(): void { + if (is_a($this, dynamic::class)) { + throw new coding_exception('The guess_base_url function must be defined for a dynamic table'); + } + } +} +// Alias this class to the old name. +// This file will be autoloaded by the legacyclasses autoload system. +// In future all uses of this class will be corrected and the legacy references will be removed. +class_alias(flexible_table::class, \flexible_table::class); diff --git a/lib/table/classes/output/html_table.php b/lib/table/classes/output/html_table.php new file mode 100644 index 0000000000000..8ec95880ca0aa --- /dev/null +++ b/lib/table/classes/output/html_table.php @@ -0,0 +1,213 @@ +. + +namespace core_table\output; + +/** + * Holds all the information required to render a