clc plugin

step/uclcontextdelete/lang/en/lifecyclestep_uclcontextdelete.php

@@ -0,0 +1,28 @@
+<?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/>.
+
+/**
+ * Lang strings for delete course step
+ *
+ * @package lifecyclestep_uclcontextdelete
+ * @copyright  2025 UCL
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['stepname'] = 'Course deletion step';
+$string['plugindescription'] = "Delegates deletion by calling the Catalyst batch deletion tool to delete courses that have already been archived by UCL's contextfreeze trigger";
+$string['pluginname'] = 'UCL contextdelete (Deletion of archived courses)';
+$string['privacy:metadata'] = 'This subplugin does not store any personal data.';

step/uclcontextdelete/lib.php

@@ -0,0 +1,52 @@
+<?php
+namespace tool_lifecycle\step;
+
+use tool_lifecycle\local\response\step_response;
+use core\task\manager;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once(__DIR__ . '/../lib.php');
+
+class uclcontextdelete extends libbase {
+
+    /**
+     * Ensure task only queued once per workflow execution.
+     *
+     * @var bool
+     */
+    protected static $taskqueued = false;
+
+    public function process_course($processid, $instanceid, $course) {
+
+        // Only queue once per workflow run
+        if (!self::$taskqueued) {
+
+            if (class_exists('\tool_catmaintenance\task\batch_course_deletion')) {
+
+                $task = new \tool_catmaintenance\task\batch_course_deletion();
+                manager::queue_adhoc_task($task);
+
+                self::$taskqueued = true;
+
+                debugging(
+                    'Lifecycle queued Catalyst batch_course_deletion task.',
+                    DEBUG_DEVELOPER
+                );
+
+            } else {
+
+                debugging(
+                    'Catalyst batch_course_deletion task not available — skipping queue.',
+                    DEBUG_DEVELOPER
+                );
+            }
+        }
+
+        return step_response::proceed();
+    }
+
+    public function get_subpluginname() {
+        return 'uclcontextdelete';
+    }
+}

step/uclcontextdelete/version.php

@@ -0,0 +1,8 @@
+<?php
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'lifecyclestep_uclcontextdelete';
+$plugin->version   = 2025102300;
+$plugin->requires  = 2022112800; // Requires Moodle 4.1+.
+$plugin->maturity  = MATURITY_STABLE;
+$plugin->release   = '0.1';

step/uclcontextfreeze/lang/en/lifecyclestep_uclcontextfreeze.php

@@ -0,0 +1,29 @@
+<?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/>.
+
+/**
+ * Lang strings for delete course step
+ *
+ * @package lifecyclestep_uclcontextfreeze
+ * @copyright  2025 UCL
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['stepname'] = 'Archive/Freeze course step';
+$string['plugindescription'] = 'Calls UCLs contextfreeze (block) to archive courses';
+$string['pluginname'] = 'UCL contextfreeze';
+$string['privacy:metadata'] = 'This subplugin does not store any personal data.';
+

step/uclcontextfreeze/lib.php

@@ -0,0 +1,83 @@
+<?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/>.
+
+ /**
+  * Step subplugin to freeze a course context using UCL block_lifecycle manager.
+  *
+  * @package    lifecyclestep_uclcontextfreeze
+  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+  */
+
+namespace tool_lifecycle\step;
+
+use stdClass;
+use tool_lifecycle\local\response\step_response;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once(__DIR__ . '/../lib.php');
+
+/**
+ * Step subplugin to freeze a course context using UCL block_lifecycle.
+ *
+ * @package    lifecyclestep_uclcontextfreeze
+ */
+class uclcontextfreeze extends libbase {
+
+    /**
+     * Processes the course and returns a response.
+     *
+     * @param int $processid of the respective process.
+     * @param int $instanceid of the step instance.
+     * @param stdClass $course to be processed.
+     * @return step_response
+     */
+    public function process_course($processid, $instanceid, $course) {
+
+        if (!class_exists('\block_lifecycle\manager')) {
+            return step_response::rollback();
+        }
+
+        try {
+            \block_lifecycle\manager::freeze_course((int)$course->id);
+        } catch (\Exception $e) {
+            return step_response::rollback();
+        }
+
+        return step_response::proceed();
+    }
+
+    /**
+     * Processes the course in status waiting and returns a response.
+     *
+     * @param int $processid
+     * @param int $instanceid
+     * @param stdClass $course
+     * @return step_response
+     */
+    public function process_waiting_course($processid, $instanceid, $course) {
+        return $this->process_course($processid, $instanceid, $course);
+    }
+
+    /**
+     * The return value should be equivalent with the name of the subplugin folder.
+     *
+     * @return string
+     */
+    public function get_subpluginname() {
+        return 'uclcontextfreeze';
+    }
+}

step/uclcontextfreeze/version.php

@@ -0,0 +1,14 @@
+<?php
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'lifecyclestep_uclcontextfreeze';
+$plugin->version   = 2025102300;
+$plugin->requires  = 2022112800; // Requires Moodle 4.1+.
+$plugin->maturity  = MATURITY_STABLE;
+$plugin->release   = '0.1';
+
+// Requires UCL's lifecycle bloxk (so the manager class exists)
+$plugin->dependencies = [
+    'block_lifecycle' => ANY_VERSION,
+];
+

trigger/coursedelete/classes/privacy/provider.php

@@ -0,0 +1,39 @@
+<?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/>.
+
+namespace lifecycletrigger_coursedelete\privacy;
+
+use core_privacy\local\metadata\null_provider;
+
+/**
+ * Privacy subsystem implementation for lifecycletrigger_coursefreeze.
+ *
+ * @package     lifecycletrigger_coursefreeze
+ * @copyright   2025 Gifty Wanzola (ccaewan)
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

trigger/coursedelete/lang/en/lifecycletrigger_coursedelete.php

@@ -0,0 +1,45 @@
+<?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/>.
+
+/**
+ * Lang strings for course freeze trigger
+ *
+ * @package lifecycletrigger_coursedelete
+ * @copyright  2025 Gifty (ccaewan)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+ $string['pluginname'] = 'Select long-term archived courses for deletion';
+ // Description shown on the workflow configuration page.
+
+ $string['plugindescription'] =
+    'Selects courses that have been archived (frozen), have not been accessed for a prolonged period, '
+    . 'and were created sufficiently long ago. These courses are considered end-of-life and may be '
+    . 'safely removed using a delete step in the workflow.';
+
+ $string['inactivitydelay'] = 'Last access threshold';
+ $string['inactivitydelay_help'] =
+    'Only delete courses where the most recent user activity is older than this period. '
+    . 'Set to 48 months by default to target courses with no access for at least 4 years.';
+
+ $string['creationdelay'] = 'Minimum course age';
+
+ $string['creationdelay_help'] =
+    'The minimum age of a course based on its creation date. '
+    . 'Courses created more recently than this threshold will not be selected for deletion.'
+    . 'Set to 60 months by default to target courses with older than at least 5 years.';
+
+ $string['privacy:metadata'] = 'The Course deletion trigger does not store or process personal data.';