CTP-1685 add unfreeze function in lifecycle block

amd/src/lifecycle.js

@@ -1,17 +1,14 @@
 import Ajax from 'core/ajax';
 import notification from 'core/notification';
-import {getStrings} from 'core/str';
 
 // Default auto suggested read-only date.
 let defaultfreezedate = '';
 // The datepicker original value before user make any changes.
 let originalfreezedatevalue = '';
 
 export const init = (courseid) => {
-    // The course is read-only. Initialize the unfreeze button and return.
+    // The course is read-only. Do nothing.
     if (!document.getElementById('lifecycle-settings-container')) {
-        // Initialize the unfreeze button.
-        initUnfreezeButton(courseid);
         return;
     }
 
@@ -165,57 +162,3 @@ function updatepreferences(courseid) {
         });
     }
 }
-
-/**
- * Initialize the unfreeze button.
- *
- * @param {int} courseid
- */
-function initUnfreezeButton(courseid) {
-    // Get the unfreeze button.
-    let unfreezeButton = document.getElementById('unfreeze-button');
-
-    // The course is not frozen. Do nothing.
-    if (!unfreezeButton) {
-        return;
-    }
-
-    let contextname = unfreezeButton.getAttribute('data-contextname');
-
-    unfreezeButton.addEventListener('click', event => {
-        event.preventDefault();
-
-        const requiredStrings = [
-            {key: 'confirmcontextunlock', component: 'admin', param: {'contextname': contextname}},
-        ];
-
-        getStrings(requiredStrings).then(([unlockBody]) => {
-            return notification.confirm('Enable editing', unlockBody, 'Confirm', null, () => {
-                    Ajax.call([{
-                        methodname: 'block_lifecycle_unfreeze_course',
-                        args: {
-                            'courseid': courseid
-                        },
-                    }])[0].done(function(response) {
-                        if (response.success) {
-                            window.location.reload();
-                        } else {
-                            notification.addNotification({
-                                message: response.message || 'An error occurred while enabling editing.',
-                                type: 'error'
-                            });
-                            // Scroll to the top of the page to show the error message.
-                            window.scrollTo({top: 0, behavior: "instant"});
-                        }
-                    }).fail(function(err) {
-                        window.console.log(err);
-                    });
-            });
-        }).catch(
-            (error) => {
-                window.console.log(error);
-                return error;
-            }
-        );
-    });
-}

classes/manager.php

@@ -360,7 +360,10 @@ public static function unfreeze_course(int $courseid): void {
             throw new \moodle_exception('error:unfreeze_course', 'block_lifecycle');
         }
         $context = context_course::instance($courseid);
-        $context->set_locked(false);
+        if ($context->is_locked()) {
+            // Unlock the course context.
+            $context->set_locked(false);
+        }
     }
 
     /**

db/services.php

@@ -34,7 +34,6 @@
         'description' => 'Update auto context freezing preferences',
         'ajax' => true,
         'type' => 'write',
-        'readonlysession' => true,
         'loginrequired' => true,
     ],
     'block_lifecycle_get_scheduled_freeze_date' => [
@@ -44,15 +43,6 @@
         'description' => 'Get scheduled freeze date',
         'ajax' => true,
         'type' => 'read',
-        'readonlysession' => true,
-        'loginrequired' => true,
-    ],
-    'block_lifecycle_unfreeze_course' => [
-        'classname' => 'block_lifecycle\external\unfreeze_course',
-        'description' => 'Unfreeze a course',
-        'ajax' => true,
-        'type' => 'write',
-        'readonlysession' => true,
         'loginrequired' => true,
     ],
 ];

renderer.php

@@ -156,14 +156,18 @@ public function fetch_course_read_only_notification(): string {
     /**
      * Return the html for the unfreeze button.
      *
-     * @param course $context
+     * @param context_course $context
      * @return string
-     * @throws coding_exception
+     * @throws coding_exception|moodle_exception
      */
-    public function fetch_unfreeze_button_html(core\context\course $context): string {
-        return
-            '<a id="unfreeze-button" class="btn btn-primary w-100" data-contextname="' . $context->get_context_name() . '">' .
-                '<i class="fa-edit fa fa-fw"></i>' . get_string('label:unfreezebutton', 'block_lifecycle') .
-            '</a>';
+    public function fetch_unfreeze_button_html(context_course $context): string {
+        $url = new moodle_url('/blocks/lifecycle/unfreeze.php', ['id' => $context->instanceid]);
+        return $this->output->render_from_template(
+            'block_lifecycle/unfreeze_button_form',
+            [
+                'url' => $url->out(false),
+                'coursename' => $context->get_context_name(),
+            ]
+        );
     }
 }

templates/unfreeze_button.mustache

@@ -0,0 +1,47 @@
+{{!
+    This file is part the Local Analytics plugin for Moodle
+    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/>.
+}}
+{{!
+    @template block_lifecycle/unfreeze_button
+
+    Template for displaying the unfreeze button to unfreeze a frozen course.
+
+    Classes required for JS:
+    * none
+
+    Data attributes required for JS:
+    * none
+
+    Context variables required for this template:
+    * url - string The URL to the unfreeze page.
+    * coursefullname - string The full name of the course.
+
+    Example context (json):
+    {
+        "url": "http://test.m44.local/blocks/lifecycle/unfreeze.php?id=5",
+        "coursefullname": 'Test Course 1'
+    }
+}}
+<button type="button"
+        class="btn btn-primary w-100"
+        data-confirmation="modal"
+        data-confirmation-title-str='["label:unfreezebutton", "block_lifecycle"]'
+        data-confirmation-content-str='["confirmcontextunlock", "admin", {"contextname": "{{coursename}}"}]'
+        data-confirmation-yes-button-str='["confirm"]'
+        data-confirmation-destination="{{url}}"
+>
+    Enable editing
+    <span class="sr-only"> for course {{coursename}}</span>
+</button>

unfreeze.php

@@ -0,0 +1,60 @@
+<?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/>.
+
+/**
+ * unfreeze page for block_lifecycle to unfreeze a frozen course.
+ *
+ * @package    block_lifecycle
+ * @copyright  2024 onwards University College London {@link https://www.ucl.ac.uk/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Alex Yeung <[email protected]>
+ */
+
+namespace block_lifecycle;
+
+use context_course;
+use core\output\notification;
+use moodle_exception;
+use moodle_url;
+
+require_once('../../config.php');
+
+// Course ID.
+$courseid = required_param('id', PARAM_INT);
+
+// Get course context.
+$context = context_course::instance($courseid);
+
+// Get course instance.
+if (!$course = get_course($courseid)) {
+    throw new moodle_exception('course not found.', 'block_lifecycle');
+}
+
+// Make sure user is authenticated.
+require_login($course);
+
+// Check user's capability.
+require_capability('block/lifecycle:unfreezecourse', $context);
+
+// Unfreeze the course.
+try {
+    manager::unfreeze_course($courseid);
+    // Unfreeze done. Redirect back to the course page.
+    redirect(new moodle_url('/course/view.php', ['id' => $courseid]));
+} catch (moodle_exception $e) {
+    // Unfreeze failed. Redirect back to the course page with error message.
+    redirect(new moodle_url('/course/view.php', ['id' => $courseid]), $e->getMessage(), null, notification::NOTIFY_ERROR);
+}

version.php

@@ -25,7 +25,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2022120803;
+$plugin->version   = 2022120801;
 $plugin->release   = '0.1';
 $plugin->maturity  = MATURITY_ALPHA;
 $plugin->requires  = 2020061512;