From 96df2b49d785cfd46bc0d51cd01e3e198cd1e419 Mon Sep 17 00:00:00 2001
From: erseco <info@ernesto.es>
Date: Fri, 19 Jun 2026 12:53:14 +0100
Subject: [PATCH] fix(teacher-mode): reveal via core ?exe-teacher URL param,
 drop CSS injection
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

eXeLearning packages hide teacher-only content by default and expose a
teacher-layer selector through the package's own ?exe-teacher=1 URL parameter
(upstream exelearning#1772). view.php now appends that parameter to the content
iframe src when the per-activity teachermodevisible setting is on — for every
viewer, with no role gate — instead of injecting CSS into the package to hide
the selector.

- Remove classes/local/ui/teacher_mode_hider.php and the
  exelearning_require_teacher_mode_hider() lib.php helper.
- view.php: append exe-teacher=1 on the content pluginfile URL when the
  teachermodevisible setting is on.
- Homogenize the teachermodevisible label/help ("Show teacher layer selector")
  across en/es/ca/eu/gl, and refresh the install.xml/upgrade/mod_form comments.
- Update behat scenarios (teacher and student see the param when on; neither
  when off) and drop the obsolete hider unit test.
---
 classes/local/ui/teacher_mode_hider.php | 62 -------------------------
 db/install.xml                          |  2 +-
 db/upgrade.php                          | 12 +++--
 lang/ca/exelearning.php                 |  4 +-
 lang/en/exelearning.php                 |  4 +-
 lang/es/exelearning.php                 |  2 +-
 lang/eu/exelearning.php                 |  4 +-
 lang/gl/exelearning.php                 |  4 +-
 lib.php                                 | 13 ------
 mod_form.php                            |  6 ++-
 tests/behat/mod_exelearning.feature     | 27 +++++++++++
 tests/lib_callbacks_test.php            | 10 ----
 view.php                                | 20 +++++---
 13 files changed, 61 insertions(+), 109 deletions(-)
 delete mode 100644 classes/local/ui/teacher_mode_hider.php

diff --git a/classes/local/ui/teacher_mode_hider.php b/classes/local/ui/teacher_mode_hider.php
deleted file mode 100644
index 7dd9cb3..0000000
--- a/classes/local/ui/teacher_mode_hider.php
+++ /dev/null
@@ -1,62 +0,0 @@
-<?php
-// This file is part of Moodle - http://moodle.org/
-//
-// Moodle is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// Moodle is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
-
-/**
- * Teacher-mode toggle hider for the package iframe (mod_exeweb parity).
- *
- * Extracted from lib.php (DEC-0054). The behaviour is unchanged: it queues the
- * same parent-page JS that injects a <style> into the same-origin iframe content
- * document; lib.php keeps a thin delegator.
- *
- * @package    mod_exelearning
- * @copyright  2026 ATE (Área de Tecnología Educativa)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace mod_exelearning\local\ui;
-
-/**
- * Queues the iframe teacher-mode toggle hider on the current page.
- */
-final class teacher_mode_hider {
-    /**
-     * Hide eXeLearning's teacher-mode toggle (#teacher-mode-toggler-wrapper) inside
-     * the package iframe (mod_exeweb parity). Queues parent-page JS that injects a
-     * <style> into the iframe's content document once it loads. The iframe is
-     * same-origin (served via pluginfile.php), so this DOM access is allowed.
-     *
-     * @param string $iframeid The id attribute of the package iframe.
-     * @return void
-     */
-    public static function require_for_iframe(string $iframeid): void {
-        global $PAGE;
-
-        $iframeidjson = json_encode($iframeid);
-        $cssjson = json_encode('#teacher-mode-toggler-wrapper { visibility: hidden !important; }');
-
-        $js = "(function(){"
-            . "var iframe=document.getElementById(" . $iframeidjson . ");"
-            . "if(!iframe){return;}"
-            . "var css=" . $cssjson . ";"
-            . "var inject=function(){try{if(!iframe.contentDocument){return;}"
-            . "var d=iframe.contentDocument;var st=d.createElement('style');st.textContent=css;"
-            . "(d.head||d.documentElement).appendChild(st);}catch(e){}};"
-            . "iframe.addEventListener('load', inject);inject();"
-            . "})();";
-
-        $PAGE->requires->js_init_code($js);
-    }
-}
diff --git a/db/install.xml b/db/install.xml
index 44538b9..3bbe9c8 100644
--- a/db/install.xml
+++ b/db/install.xml
@@ -24,7 +24,7 @@
         <FIELD NAME="gradeenabled"  TYPE="int"  LENGTH="2"   NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Master grading switch (DEC-0029): 1=activity is graded (detect iDevices, gradebook columns, reports); 0=not graded (no grade items, no reports, behaves like a plain resource)."/>
         <FIELD NAME="maxattempt"    TYPE="int"  LENGTH="10"  NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="Max attempts per user (DEC-0007 phase 2): 0=unlimited."/>
         <FIELD NAME="reviewmode"    TYPE="int"  LENGTH="4"   NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Student attempt review (DEC-0007 phase 2): 0=never, 1=always, 2=after completion."/>
-        <FIELD NAME="teachermodevisible" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="If 1, show eXeLearning's in-package teacher-mode toggle (#teacher-mode-toggler-wrapper); if 0 (default) inject CSS to hide it (mod_exeweb parity)."/>
+        <FIELD NAME="teachermodevisible" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="If 1, append the eXeLearning package's ?exe-teacher=1 URL parameter so its teacher-layer selector is available; if 0 (default) the package is served unchanged with teacher content hidden."/>
         <FIELD NAME="timecreated"   TYPE="int"  LENGTH="10"  NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="timemodified"  TYPE="int"  LENGTH="10"  NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="usermodified"  TYPE="int"  LENGTH="10"  NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
diff --git a/db/upgrade.php b/db/upgrade.php
index 8045869..b30d14a 100644
--- a/db/upgrade.php
+++ b/db/upgrade.php
@@ -273,11 +273,13 @@ function xmldb_exelearning_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2026052900, 'exelearning');
     }
 
-    // Stage 8 (2026052901): teachermodevisible changes meaning. It used to gate
-    // the Moodle "Try as a student" preview banner; now it controls eXeLearning's
-    // in-package teacher-mode toggle (#teacher-mode-toggler-wrapper), hidden by
-    // default via injected CSS (mod_exeweb parity). Lower the default 1 -> 0 and
-    // reset existing rows to the new default so the toggle is hidden by default.
+    // Stage 8 (2026052901): teachermodevisible changes meaning and defaults to 0.
+    // It used to gate the Moodle "Try as a student" preview banner; it now controls
+    // whether the eXeLearning teacher-layer selector is shown in the embedded package
+    // (default off = no selector, teacher content hidden). When on, the plugin appends
+    // the package's own ?exe-teacher=1 URL parameter (set in view.php) so the selector
+    // is available to every viewer; the plugin no longer injects CSS into the package.
+    // Lower the default 1 -> 0 and reset existing rows to the new default.
     if ($oldversion < 2026052901) {
         $instance = new xmldb_table('exelearning');
 
diff --git a/lang/ca/exelearning.php b/lang/ca/exelearning.php
index 63bc553..b6194ab 100644
--- a/lang/ca/exelearning.php
+++ b/lang/ca/exelearning.php
@@ -398,8 +398,8 @@
 $string['stylesuploaded'] = '~Estils pujats';
 $string['stylesuploaded_empty'] = '~Encara no hi ha estils pujats.';
 $string['stylesuploaded_hint'] = '~Activeu o desactiveu els estils pujats. Desmarqueu-los per amagar-los de l\'editor; elimineu-los per esborrar-los definitivament.';
-$string['teachermodevisible'] = '~Mostra el selector de capa docent d\'eXeLearning';
-$string['teachermodevisible_help'] = '~Els paquets eXeLearning poden incloure un selector de «capa docent» que revela el contingut marcat només per a professors. Quan aquest ajust està desactivat (per defecte), aquest selector s\'amaga a la vista de l\'activitat injectant CSS al paquet, de manera que els estudiants mai no el veuen. Activeu-lo perquè el selector aparegui al recurs.';
+$string['teachermodevisible'] = 'Mostrar el selector de capa docent';
+$string['teachermodevisible_help'] = 'Si es desactiva, el selector de capa docent s\'ocultarà al contingut eXeLearning incrustat.';
 $string['unsavedchanges'] = 'Teniu canvis sense desar. Esteu segurs que voleu tancar?';
 $string['updateavailable'] = 'Actualització disponible';
 $string['viewattemptsreport'] = '~Visualitza l\'informe d\'intents';
diff --git a/lang/en/exelearning.php b/lang/en/exelearning.php
index a85447d..b125c09 100644
--- a/lang/en/exelearning.php
+++ b/lang/en/exelearning.php
@@ -394,8 +394,8 @@
 $string['stylesuploaded'] = 'Uploaded styles';
 $string['stylesuploaded_empty'] = 'No uploaded styles yet.';
 $string['stylesuploaded_hint'] = 'Enable or disable uploaded styles. Uncheck to hide a style from the editor; delete to remove it permanently.';
-$string['teachermodevisible']      = 'Show eXeLearning teacher-mode toggle';
-$string['teachermodevisible_help'] = 'eXeLearning packages can include a "teacher mode" toggle that reveals content marked for teachers only. When this setting is disabled (the default), that toggle is hidden in the activity view by injecting CSS into the package, so students never see it. Enable it to let the toggle appear in the resource.';
+$string['teachermodevisible']      = 'Show teacher layer selector';
+$string['teachermodevisible_help'] = 'If disabled, the teacher layer selector is hidden in the embedded eXeLearning content.';
 $string['unsavedchanges'] = 'You have unsaved changes. Are you sure you want to close?';
 $string['updateavailable'] = 'Update available';
 $string['viewattemptsreport'] = 'View attempts report';
diff --git a/lang/es/exelearning.php b/lang/es/exelearning.php
index 4b12c48..c25d263 100644
--- a/lang/es/exelearning.php
+++ b/lang/es/exelearning.php
@@ -399,7 +399,7 @@
 $string['stylesuploaded_empty'] = 'Todavía no hay estilos subidos.';
 $string['stylesuploaded_hint'] = 'Activa o desactiva los estilos subidos. Desmárcalos para ocultarlos del editor; elimínalos para borrarlos definitivamente.';
 $string['teachermodevisible'] = 'Mostrar el selector de capa docente';
-$string['teachermodevisible_help'] = '~Los paquetes eXeLearning pueden incluir un selector de «capa docente» que revela el contenido marcado solo para profesores. Cuando este ajuste está desactivado (por defecto), ese selector se oculta en la vista de la actividad inyectando CSS en el paquete, de modo que los estudiantes nunca lo ven. Actívelo para que el selector aparezca en el recurso.';
+$string['teachermodevisible_help'] = 'Si se desactiva, se ocultará el selector de capa docente en el contenido eXeLearning embebido.';
 $string['unsavedchanges'] = 'Tiene cambios sin guardar. ¿Está seguro de que desea cerrar?';
 $string['updateavailable'] = 'Actualización disponible';
 $string['viewattemptsreport'] = '~Ver informe de intentos';
diff --git a/lang/eu/exelearning.php b/lang/eu/exelearning.php
index 0bc5b75..b44df00 100644
--- a/lang/eu/exelearning.php
+++ b/lang/eu/exelearning.php
@@ -398,8 +398,8 @@
 $string['stylesuploaded'] = '~Igotako estiloak';
 $string['stylesuploaded_empty'] = '~Oraindik ez dago igotako estilorik.';
 $string['stylesuploaded_hint'] = '~Gaitu edo desgaitu igotako estiloak. Desmarkatu editoretik ezkutatzeko; ezabatu betiko kentzeko.';
-$string['teachermodevisible'] = '~Erakutsi eXeLearning irakasle-modu hautagailua';
-$string['teachermodevisible_help'] = '~eXeLearning paketeek «irakasle-modua» hautagailu bat eduki dezakete, irakasleentzat soilik markatutako edukia agertzen duena. Ezarpen hau desgaituta dagoenean (lehenetsia), hautagailu hori jardueraren ikuspegian ezkutatzen da paketean CSS txertatuz, ikasleek inoiz ez dezaten ikus. Gaitu ezazu hautagailua baliabidean ager dadin.';
+$string['teachermodevisible'] = 'Erakutsi irakasle-geruza hautatzailea';
+$string['teachermodevisible_help'] = 'Desaktibatuta badago, irakasle-geruza hautatzailea ezkutatuko da eXeLearning eduki txertatuan.';
 $string['unsavedchanges'] = 'Gorde gabeko aldaketak dituzu. Ziur zaude itxi nahi duzula?';
 $string['updateavailable'] = 'Eguneraketa eskuragarri';
 $string['viewattemptsreport'] = '~Ikusi saialdien txostena';
diff --git a/lang/gl/exelearning.php b/lang/gl/exelearning.php
index 97e615e..927f1b0 100644
--- a/lang/gl/exelearning.php
+++ b/lang/gl/exelearning.php
@@ -398,8 +398,8 @@
 $string['stylesuploaded'] = '~Estilos subidos';
 $string['stylesuploaded_empty'] = '~Aínda non hai estilos subidos.';
 $string['stylesuploaded_hint'] = '~Active ou desactive os estilos subidos. Desmárqueos para ocultalos do editor; elimíneos para borralos definitivamente.';
-$string['teachermodevisible'] = '~Amosar o selector de capa docente de eXeLearning';
-$string['teachermodevisible_help'] = '~Os paquetes eXeLearning poden incluír un selector de «capa docente» que revela o contido marcado só para profesores. Cando este axuste está desactivado (por defecto), ese selector ocúltase na vista da actividade inxectando CSS no paquete, de xeito que os estudantes nunca o ven. Actíveo para que o selector apareza no recurso.';
+$string['teachermodevisible'] = 'Amosar o selector de capa docente';
+$string['teachermodevisible_help'] = 'Se se desactiva, ocultarase o selector de capa docente no contido eXeLearning embebido.';
 $string['unsavedchanges'] = 'Ten cambios sen gardar. Está seguro de que desexa pechar?';
 $string['updateavailable'] = 'Actualización dispoñible';
 $string['viewattemptsreport'] = '~Ver informe de intentos';
diff --git a/lib.php b/lib.php
index d985294..5bd9e19 100644
--- a/lib.php
+++ b/lib.php
@@ -728,19 +728,6 @@ function exelearning_extract_stored_package(int $contextid, int $revision): void
     \mod_exelearning\local\package_manager::extract_stored($contextid, $revision);
 }
 
-/**
- * Hide eXeLearning's teacher-mode toggle (#teacher-mode-toggler-wrapper) inside
- * the package iframe (mod_exeweb parity). Queues parent-page JS that injects a
- * <style> into the iframe's content document once it loads. The iframe is
- * same-origin (served via pluginfile.php), so this DOM access is allowed.
- *
- * @param string $iframeid The id attribute of the package iframe.
- * @return void
- */
-function exelearning_require_teacher_mode_hider(string $iframeid): void {
-    \mod_exelearning\local\ui\teacher_mode_hider::require_for_iframe($iframeid);
-}
-
 /**
  * Injects SCORM wrapper script tags into the <head> of index.html and all
  * html/<slug>.html pages of the extracted package.
diff --git a/mod_form.php b/mod_form.php
index c825538..f41c23c 100644
--- a/mod_form.php
+++ b/mod_form.php
@@ -226,8 +226,10 @@ public function definition() {
             $mform->disabledIf($gradefield, 'gradeenabled', 'notchecked');
         }
 
-        // Appearance: whether to show the teacher preview/grading toggle in the
-        // activity view (mod_exeweb parity). Default on.
+        // Appearance: whether to show the eXeLearning teacher-layer selector in the
+        // embedded package. The package hides teacher-only content by default; when this
+        // is on the plugin appends the package's supported ?exe-teacher=1 URL parameter so
+        // the selector is available to every viewer. Default off.
         $mform->addElement(
             'header',
             'appearancesection',
diff --git a/tests/behat/mod_exelearning.feature b/tests/behat/mod_exelearning.feature
index 78ae35f..926164d 100644
--- a/tests/behat/mod_exelearning.feature
+++ b/tests/behat/mod_exelearning.feature
@@ -142,3 +142,30 @@ Feature: View a mod_exelearning activity and its attempts report
     And I am on the "Evaluable unit" "exelearning activity" page logged in as teacher1
     When I follow "View attempts report"
     Then I should see "Download report data as"
+
+  # Teacher-layer selector (upstream exelearning#1772, server-rendered, no @javascript):
+  # eXeLearning packages hide teacher-only content by default and expose a selector to
+  # show it via the package's own ?exe-teacher=1 URL parameter. The plugin appends that
+  # parameter to the iframe src whenever the per-activity "Show teacher layer selector"
+  # setting (teachermodevisible) is on — for any viewer. The iframe src is server-rendered,
+  # so the non-JS driver can assert on it directly.
+  Scenario: A teacher sees the exe-teacher parameter when the setting is on
+    Given the following "activities" exist:
+      | activity    | name           | course | idnumber | teachermodevisible |
+      | exelearning | Teacher reveal | C1     | exetr    | 1                  |
+    And I am on the "Teacher reveal" "exelearning activity" page logged in as teacher1
+    Then the "src" attribute of "iframe#exelearningobject" "css_element" should contain "exe-teacher=1"
+
+  Scenario: A teacher does not see the exe-teacher parameter when the reveal is off
+    Given the following "activities" exist:
+      | activity    | name             | course | idnumber | teachermodevisible |
+      | exelearning | Teacher noreveal | C1     | exetn    | 0                  |
+    And I am on the "Teacher noreveal" "exelearning activity" page logged in as teacher1
+    Then the "src" attribute of "iframe#exelearningobject" "css_element" should not contain "exe-teacher"
+
+  Scenario: A student also sees the exe-teacher parameter when the setting is on
+    Given the following "activities" exist:
+      | activity    | name               | course | idnumber | teachermodevisible |
+      | exelearning | Teacher student vw | C1     | exets    | 1                  |
+    And I am on the "Teacher student vw" "exelearning activity" page logged in as student1
+    Then the "src" attribute of "iframe#exelearningobject" "css_element" should contain "exe-teacher=1"
diff --git a/tests/lib_callbacks_test.php b/tests/lib_callbacks_test.php
index e3a2a13..27a8272 100644
--- a/tests/lib_callbacks_test.php
+++ b/tests/lib_callbacks_test.php
@@ -32,13 +32,11 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @covers     ::exelearning_view
  * @covers     ::exelearning_get_grade_item_names
- * @covers     ::exelearning_require_teacher_mode_hider
  * @covers     ::exelearning_pluginfile
  * @covers     ::exelearning_extend_settings_navigation
  * @covers     ::exelearning_navigation_before_key
  * @covers     ::exelearning_update_instance
  * @covers     \mod_exelearning\local\urls
- * @covers     \mod_exelearning\local\ui\teacher_mode_hider
  */
 final class lib_callbacks_test extends advanced_testcase {
     /**
@@ -89,14 +87,6 @@ public function test_get_grade_item_names(): void {
         $this->assertSame('Item #99', $names[12]);
     }
 
-    /**
-     * exelearning_require_teacher_mode_hider() enqueues page JS without error.
-     */
-    public function test_require_teacher_mode_hider(): void {
-        $this->resetAfterTest();
-        $this->assertNull(exelearning_require_teacher_mode_hider('exelearningobject'));
-    }
-
     /**
      * exelearning_pluginfile() gates the package area behind manageactivities, so
      * a plain student cannot download the source package.
diff --git a/view.php b/view.php
index 0aabf91..e76f3df 100644
--- a/view.php
+++ b/view.php
@@ -225,6 +225,15 @@
         '/',
         'index.html'
     );
+    // Make the in-package teacher-layer selector available via the package's own URL
+    // parameter (eXeLearning core hides teacher content by default and exposes a
+    // selector to show it with ?exe-teacher=1; see upstream exelearning#1772). This
+    // replaces the former CSS injection that hid the selector (mod_exeweb parity): the
+    // plugin no longer mutates the package. The per-activity teachermodevisible setting
+    // alone controls it — when on, the selector is offered to every viewer; no role gate.
+    if (!empty($exelearning->teachermodevisible)) {
+        $iframeurl->param('exe-teacher', '1');
+    }
     // Deep-link from the gradebook (issue #13 #4, DEC-0023): grade.php maps a
     // clicked grade item's itemnumber to its iDevice objectid and forwards it
     // here. Exported iDevices render as <article id="<odeIdeviceId>">, so a URL
@@ -488,13 +497,10 @@
         'style'  => 'border: 1px solid var(--bs-border-color, #dee2e6); border-radius: .5rem;',
     ]);
 
-    // Hide eXeLearning's teacher-mode toggle inside the package (mod_exeweb
-    // parity): when teachermodevisible=0, inject CSS into the iframe content to
-    // hide #teacher-mode-toggler-wrapper. The iframe is same-origin (served via
-    // pluginfile.php) so the parent can reach its content document.
-    if (empty($exelearning->teachermodevisible)) {
-        exelearning_require_teacher_mode_hider('exelearningobject');
-    }
+    // Teacher-only content is hidden by default inside the eXeLearning package and
+    // revealed via the ?exe-teacher=1 URL parameter appended to the iframe src above
+    // when the teachermodevisible setting is on. The plugin no longer injects CSS into
+    // the package to hide the teacher-layer selector (mod_exeweb parity retired).
 }
 
 echo $OUTPUT->footer();