Initial commit

.github/workflows/ci.yml

@@ -0,0 +1,150 @@
+name: Moodle Plugin CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_USER: 'postgres'
+          POSTGRES_HOST_AUTH_METHOD: 'trust'
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
+
+      mariadb:
+        image: mariadb:10
+        env:
+          MYSQL_USER: 'root'
+          MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+          MYSQL_CHARACTER_SET_SERVER: "utf8mb4"
+          MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci"
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+         - php: '7.4'
+           moodle-branch: 'MOODLE_401_STABLE'
+           database: pgsql
+         - php: '8.1'
+           moodle-branch: 'MOODLE_401_STABLE'
+           database: mariadb
+         - php: '8.0'
+           moodle-branch: 'MOODLE_402_STABLE'
+           database: mariadb
+         - php: '8.1'
+           moodle-branch: 'MOODLE_402_STABLE'
+           database: pgsql
+         - php: '8.1'
+           moodle-branch: 'MOODLE_403_STABLE'
+           database: mariadb
+         - php: '8.2'
+           moodle-branch: 'MOODLE_403_STABLE'
+           database: pgsql
+         - php: '8.2'
+           moodle-branch: 'MOODLE_404_STABLE'
+           database: mariadb
+         - php: '8.3'
+           moodle-branch: 'MOODLE_404_STABLE'
+           database: pgsql
+         - php: '8.3'
+           moodle-branch: 'MOODLE_405_STABLE'
+           database: mariadb
+         - php: '8.3'
+           moodle-branch: 'MOODLE_405_STABLE'
+           database: pgsql
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          path: plugin
+
+      - name: Setup PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: ${{ matrix.extensions }}
+          ini-values: max_input_vars=5000
+          # If you are not using code coverage, keep "none". Otherwise, use "pcov" (Moodle 3.10 and up) or "xdebug".
+          # If you try to use code coverage with "none", it will fallback to phpdbg (which has known problems).
+          coverage: none
+
+      - name: Initialise moodle-plugin-ci
+        run: |
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
+          echo $(cd ci/bin; pwd) >> $GITHUB_PATH
+          echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
+          sudo locale-gen en_AU.UTF-8
+          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
+
+      - name: Install moodle-plugin-ci
+        run: moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+          # Uncomment this to run Behat tests using the Moodle App.
+          # MOODLE_APP: 'true'
+
+      - name: PHP Lint
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phplint
+
+      - name: PHP Mess Detector
+        continue-on-error: true # This step will show errors but will not fail
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpmd
+
+      - name: Moodle Code Checker
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpcs --max-warnings 0
+
+      - name: Moodle PHPDoc Checker
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpdoc --max-warnings 0
+
+      - name: Validating
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci validate
+
+      - name: Check upgrade savepoints
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci savepoints
+
+      - name: Mustache Lint
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci mustache
+
+      - name: Grunt
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci grunt --max-lint-warnings 0
+
+      - name: PHPUnit tests
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpunit --fail-on-warning
+
+      - name: Behat features
+        id: behat
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci behat --profile chrome
+
+      - name: Upload Behat Faildump
+        if: ${{ failure() && steps.behat.outcome == 'failure' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: Behat Faildump (${{ join(matrix.*, ', ') }})
+          path: ${{ github.workspace }}/moodledata/behat_dump
+          retention-days: 7
+          if-no-files-found: ignore
+
+      - name: Mark cancelled jobs as failed.
+        if: ${{ cancelled() }}
+        run: exit 1

classes/condition.php

@@ -0,0 +1,147 @@
+<?php
+// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
+
+/**
+ * Condition to restrict access by dedication time
+ *
+ * @package     availability_dedicationtime
+ * @copyright   2024 Santosh N. <[email protected]>
+ * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace availability_dedicationtime;
+use core_availability\info;
+/**
+ * Dedication time condition.
+ *
+ * @package availability_dedicationtime
+ * @copyright 2024 Santosh N. <[email protected]>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class condition extends \core_availability\condition {
+
+    /** @var string dedication time value */
+    protected $dedicationtime;
+
+    /** @var string dedication time unit */
+    protected $unit;
+
+    /**
+     * Constructor.
+     *
+     * @param \stdClass $structure Data structure from JSON decode
+     * @throws \coding_exception If invalid data structure.
+     */
+    public function __construct($structure) {
+        $this->dedicationtime = $structure->dedicationtime;
+        $this->unit = $structure->unit;
+    }
+
+    /**
+     * Determines whether this item is availabile.
+     *
+     * @param  bool $not Set true if we are inverting the condition
+     * @param  \core_availability\info $info Item we're checking
+     * @param  bool $grabthelot if true, caches information required for all course-modules
+     * @param  int $userid User ID to check availability for
+     * @return bool true if available
+     */
+    public function is_available($not, info $info, $grabthelot, $userid) {
+        global $DB;
+        $modinfo = $info->get_modinfo();
+        $course = $modinfo->get_course();
+        $sql = "SELECT SUM(timespent) as timespent
+                  FROM {block_dedication}
+                 WHERE userid = ?
+                       AND courseid = ?";
+        $data = $DB->get_record_sql($sql, [$userid, $course->id]);
+        $dtime = $this->get_dedication_time();
+        if ($not) {
+            if ($data->timespent == $dtime) {
+                return false;
+            }
+            return true;
+        }
+        if ($data->timespent >= $dtime) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Returns the dedication time in seconds
+     * @return int time in seconds
+     */
+    protected function get_dedication_time() {
+        if ($this->unit == 'hours') {
+            return $this->dedicationtime * 3600;
+        }
+        return $this->dedicationtime * 60;
+    }
+
+    /**
+     * Converts seconds into hours and minutes time format
+     * @param int $seconds Seconds
+     * @return array time value array
+     */
+    protected function seconds_to_hours_minutes($seconds) {
+        $hours = floor($seconds / 3600);
+        $minutes = floor(($seconds % 3600) / 60);
+        return [
+            'hours' => $hours,
+            'minutes' => $minutes,
+        ];
+    }
+
+    /**
+     * Obtains a string describing this restriction (whether or not it actually applies).
+     *
+     * @param  bool $full Set true if this is the 'full information' view
+     * @param  bool $not Set true if we are inverting the condition
+     * @param  \core_availability\info $info Item we're checking
+     * @return string Information string (for admin) about all restrictions on this item
+     */
+    public function get_description($full, $not, info $info) {
+        $dseconds = $this->get_dedication_time();
+        $dtime = $this->seconds_to_hours_minutes($dseconds);
+        if ($not) {
+            return get_string('requires_notfinish', 'availability_dedicationtime', $dtime);
+        }
+
+        return get_string('requires_finish', 'availability_dedicationtime', $dtime);
+    }
+
+    /**
+     * Obtains a representation of the options of this condition as a string, for debugging.
+     *
+     * @return string dedication time value
+     */
+    protected function get_debug_string() {
+        return $this->dedicationtime . ' ' . $this->unit;
+    }
+
+    /**
+     * Saves tree data back to a structure object.
+     *
+     * @return \stdClass Structure object (ready to be made into JSON format)
+     */
+    public function save() {
+        return (object)[
+            'type' => 'dedicationtime',
+            'dedicationtime' => $this->dedicationtime,
+            'unit' => $this->unit,
+        ];
+    }
+}

classes/frontend.php

@@ -0,0 +1,54 @@
+<?php
+// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
+
+/**
+ * Restrict access by dedication time
+ *
+ * @package     availability_dedicationtime
+ * @copyright   2024 Santosh N. <[email protected]>
+ * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace availability_dedicationtime;
+/**
+ * Restrict access by dedication time
+ *
+ * @package     availability_dedicationtime
+ * @copyright   2024 Santosh N. <[email protected]>
+ * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class frontend extends \core_availability\frontend {
+    /**
+     * Gets a list of string identifiers (in the plugin's language file) that are required in JavaScript for this plugin.
+     *
+     * @return Array of required string identifiers
+     */
+    protected function get_javascript_strings() {
+        return ['title', 'description'];
+    }
+    /**
+     * Delivers parameters to the javascript part of the plugin
+     *
+     * @param  \stdClass $course Course object
+     * @param  \cm_info $cm Course-module currently being edited (null if none)
+     * @param  \section_info $section Section currently being edited (null if none)
+     * @return array Array of parameters for the JavaScript function
+     */
+    protected function get_javascript_init_params($course, \cm_info $cm = null, \section_info $section = null) {
+        global $OUTPUT;
+        $html = $OUTPUT->render_from_template('availability_dedicationtime/dedication', []);
+        return [$html];
+    }
+}