first commit

blocks/badges/block_badges.php

@@ -0,0 +1,116 @@
+<?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/>.
+
+/**
+ * Block for displaying earned local badges to users
+ *
+ * @package    block_badges
+ * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
+ */
+class block_badges extends block_base {
+
+    public function init() {
+        global $CFG;
+
+        require_once($CFG->libdir . "/badgeslib.php");
+
+        $this->title = get_string('pluginname', 'block_badges');
+    }
+
+    public function instance_allow_multiple() {
+        return true;
+    }
+
+    public function has_config() {
+        return false;
+    }
+
+    public function instance_allow_config() {
+        return true;
+    }
+
+    public function applicable_formats() {
+        return array(
+                'admin' => false,
+                'site-index' => true,
+                'course-view' => true,
+                'mod' => false,
+                'my' => true
+        );
+    }
+
+    public function specialization() {
+        if (empty($this->config->title)) {
+            $this->title = get_string('pluginname', 'block_badges');
+        } else {
+            $this->title = $this->config->title;
+        }
+    }
+
+    public function get_content() {
+        global $USER, $CFG;
+
+        if ($this->content !== null) {
+            return $this->content;
+        }
+
+        if (empty($this->config)) {
+            $this->config = new stdClass();
+        }
+
+        // Number of badges to display.
+        if (!isset($this->config->numberofbadges)) {
+            $this->config->numberofbadges = 10;
+        }
+
+        // Create empty content.
+        $this->content = new stdClass();
+        $this->content->text = '';
+
+        if (empty($CFG->enablebadges)) {
+            $this->content->text .= get_string('badgesdisabled', 'badges');
+            return $this->content;
+        }
+
+        $courseid = $this->page->course->id;
+        if ($courseid == SITEID) {
+            $courseid = null;
+        }
+
+        if ($badges = badges_get_user_badges($USER->id, $courseid, 0, $this->config->numberofbadges)) {
+            $output = $this->page->get_renderer('core', 'badges');
+            $this->content->text = $output->print_badges_list($badges, $USER->id, true);
+        } else {
+            $this->content->text .= get_string('nothingtodisplay', 'block_badges');
+        }
+
+        return $this->content;
+    }
+
+    /**
+     * This block shouldn't be added to a page if the badges advanced feature is disabled.
+     *
+     * @param moodle_page $page
+     * @return bool
+     */
+    public function can_block_be_added(moodle_page $page): bool {
+        global $CFG;
+
+        return $CFG->enablebadges;
+    }
+}

blocks/badges/classes/privacy/provider.php

@@ -0,0 +1,46 @@
+<?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/>.
+
+/**
+ * Privacy Subsystem implementation for block_badges.
+ *
+ * @package    block_badges
+ * @copyright  2018 Zig Tan <zig@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace block_badges\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for block_badges implementing null_provider.
+ *
+ * @copyright  2018 Zig Tan <zig@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\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';
+    }
+}

blocks/badges/db/access.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/>.
+
+/**
+ * Latest badges block capabilities.
+ *
+ * @package    block_badges
+ * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
+ */
+
+$capabilities = array(
+        'block/badges:addinstance' => array(
+                'captype'      => 'read',
+                'contextlevel' => CONTEXT_BLOCK,
+                'archetypes' => array(
+                    'editingteacher' => CAP_ALLOW,
+                    'manager' => CAP_ALLOW
+                ),
+                'clonepermissionsfrom' => 'moodle/site:manageblocks'
+        ),
+        'block/badges:myaddinstance' => array(
+                'riskbitmask'  => RISK_PERSONAL,
+                'captype'      => 'read',
+                'contextlevel' => CONTEXT_SYSTEM,
+                'archetypes'   => array(
+                        'user' => CAP_ALLOW,
+                ),
+                'clonepermissionsfrom' => 'moodle/my:manageblocks'
+        ),
+);

blocks/badges/db/upgrade.php

@@ -0,0 +1,59 @@
+<?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/>.
+
+/**
+ * This file keeps track of upgrades to the badges block
+ *
+ * Sometimes, changes between versions involve alterations to database structures
+ * and other major things that may break installations.
+ *
+ * The upgrade function in this file will attempt to perform all the necessary
+ * actions to upgrade your older installation to the current version.
+ *
+ * If there's something it cannot do itself, it will tell you what you need to do.
+ *
+ * The commands in here will all be database-neutral, using the methods of
+ * database_manager class
+ *
+ * Please do not forget to use upgrade_set_timeout()
+ * before any action that may take longer time to finish.
+ *
+ * @since Moodle 2.8
+ * @package block_badges
+ * @copyright 2014 Andrew Davis
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Upgrade the badges block
+ * @param int $oldversion
+ * @param object $block
+ */
+function xmldb_block_badges_upgrade($oldversion, $block) {
+    // Automatically generated Moodle v4.1.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    // Automatically generated Moodle v4.2.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    // Automatically generated Moodle v4.3.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    // Automatically generated Moodle v4.4.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    return true;
+}

blocks/badges/edit_form.php

@@ -0,0 +1,38 @@
+<?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/>.
+
+/**
+ * Form for editing badges block instances.
+ *
+ * @package    block_badges
+ * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
+ */
+
+class block_badges_edit_form extends block_edit_form {
+    protected function specific_definition($mform) {
+        $mform->addElement('header', 'configheader', get_string('blocksettings', 'block'));
+
+        $numberofbadges = array('0' => get_string('all'));
+        for ($i = 1; $i <= 20; $i++) {
+            $numberofbadges[$i] = $i;
+        }
+
+        $mform->addElement('select', 'config_numberofbadges', get_string('numbadgestodisplay', 'block_badges'), $numberofbadges);
+        $mform->setDefault('config_numberofbadges', 10);
+    }
+}

blocks/badges/lang/en/block_badges.php

@@ -0,0 +1,31 @@
+<?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/>.
+
+/**
+ * Language file for block "badges"
+ *
+ * @package    block_badges
+ * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
+ */
+
+$string['pluginname'] = 'Latest badges';
+$string['numbadgestodisplay'] = 'Number of latest badges to display';
+$string['nothingtodisplay'] = 'You have no badges to display';
+$string['badges:addinstance'] = 'Add a new Latest badges block';
+$string['badges:myaddinstance'] = 'Add a new Latest badges block to Dashboard';
+$string['privacy:metadata'] = 'The Latest badges block only shows data stored in other locations.';

blocks/badges/tests/badges_test.php

@@ -0,0 +1,63 @@
+<?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 block_badges;
+
+use advanced_testcase;
+use block_badges;
+use context_course;
+
+/**
+ * PHPUnit block_badges tests
+ *
+ * @package    block_badges
+ * @category   test
+ * @copyright  2021 Sara Arjona (sara@moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @coversDefaultClass \block_badges
+ */
+class badges_test extends advanced_testcase {
+    public static function setUpBeforeClass(): void {
+        require_once(__DIR__ . '/../../moodleblock.class.php');
+        require_once(__DIR__ . '/../block_badges.php');
+    }
+
+    /**
+     * Test the behaviour of can_block_be_added() method.
+     *
+     * @covers ::can_block_be_added
+     */
+    public function test_can_block_be_added(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        // Create a course and prepare the page where the block will be added.
+        $course = $this->getDataGenerator()->create_course();
+        $page = new \moodle_page();
+        $page->set_context(context_course::instance($course->id));
+        $page->set_pagelayout('course');
+
+        $block = new block_badges();
+
+        // If badges advanced feature is enabled, the method should return true.
+        set_config('enablebadges', true);
+        $this->assertTrue($block->can_block_be_added($page));
+
+        // However, if the badges advanced feature is disabled, the method should return false.
+        set_config('enablebadges', false);
+        $this->assertFalse($block->can_block_be_added($page));
+    }
+}

blocks/badges/tests/behat/block_badges.feature

@@ -0,0 +1,31 @@
+@block @block_badges
+Feature: Enable Block Badges in a course without badges
+  In order to view the badges block in a course
+  As a teacher
+  I can add badges block to a course and view the contents
+
+  Background:
+    Given the following "users" exist:
+      | username | firstname | lastname | email | idnumber |
+      | teacher1 | Teacher | 1 | teacher1@example.com | T1 |
+    And the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1 | 0 |
+    And the following "course enrolments" exist:
+      | user | course | role |
+      | teacher1 | C1 | editingteacher |
+
+  Scenario: Add the block to a the course when badges are disabled
+    Given I log in as "teacher1"
+    And I am on "Course 1" course homepage with editing mode on
+    When I add the "Latest badges" block
+    And the following config values are set as admin:
+      | enablebadges | 0 |
+    And I reload the page
+    Then I should see "Badges are not enabled on this site." in the "Latest badges" "block"
+
+  Scenario: Add the block to a the course when badges are enabled
+    Given I log in as "teacher1"
+    And I am on "Course 1" course homepage with editing mode on
+    When I add the "Latest badges" block
+    Then I should see "You have no badges to display" in the "Latest badges" "block"

blocks/badges/tests/behat/block_badges_course.feature

@@ -0,0 +1,70 @@
+@block @block_badges @core_badges @_file_upload @javascript
+Feature: Enable Block Badges in a course
+  In order to enable the badges block in a course
+  As a teacher
+  I can add badges block to a course
+
+  Background:
+    Given the following "users" exist:
+      | username | firstname | lastname | email | idnumber |
+      | teacher1 | Teacher | 1 | teacher1@example.com | T1 |
+    And the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1 | 0 |
+    And the following "course enrolments" exist:
+      | user | course | role |
+      | teacher1 | C1 | editingteacher |
+    And I log in as "teacher1"
+    And I am on "Course 1" course homepage
+    # Issue badge 1 of 2
+    And I navigate to "Badges > Add a new badge" in current page administration
+    And I set the following fields to these values:
+      | id_name | Badge 1 |
+      | id_description | Badge 1 |
+    And I upload "blocks/badges/tests/fixtures/badge.png" file to "Image" filemanager
+    And I press "Create badge"
+    And I select "Manual issue by role" from the "Add badge criteria" singleselect
+    And I set the field "Teacher" to "1"
+    And I press "Save"
+    And I press "Enable access"
+    And I press "Continue"
+    And I select "Recipients (0)" from the "jump" singleselect
+    And I press "Award badge"
+    And I set the field "potentialrecipients[]" to "Teacher 1 (teacher1@example.com)"
+    And I press "Award badge"
+    # Issue Badge 2 of 2
+    And I am on "Course 1" course homepage
+    And I navigate to "Badges > Add a new badge" in current page administration
+    And I set the following fields to these values:
+      | id_name | Badge 2 |
+      | id_description | Badge 2 |
+    And I upload "blocks/badges/tests/fixtures/badge.png" file to "Image" filemanager
+    And I press "Create badge"
+    And I select "Manual issue by role" from the "Add badge criteria" singleselect
+    And I set the field "Teacher" to "1"
+    And I press "Save"
+    And I press "Enable access"
+    And I press "Continue"
+    And I select "Recipients (0)" from the "jump" singleselect
+    And I press "Award badge"
+    And I set the field "potentialrecipients[]" to "Teacher 1 (teacher1@example.com)"
+    And I press "Award badge"
+    And I log out
+
+  Scenario: Add the recent badges block to a course.
+    Given I log in as "teacher1"
+    And I am on "Course 1" course homepage with editing mode on
+    When I add the "Latest badges" block
+    Then I should see "Badge 1" in the "Latest badges" "block"
+    And I should see "Badge 2" in the "Latest badges" "block"
+
+  Scenario: Add the recent badges block to a course and limit it to only display 1 badge.
+    Given I log in as "teacher1"
+    And I am on "Course 1" course homepage with editing mode on
+    When I add the "Latest badges" block
+    And I configure the "Latest badges" block
+    And I set the following fields to these values:
+      | Number of latest badges to display | 1 |
+    And I press "Save changes"
+    Then I should see "Badge 2" in the "Latest badges" "block"
+    And I should not see "Badge 1" in the "Latest badges" "block"

blocks/badges/tests/behat/block_badges_dashboard.feature

@@ -0,0 +1,40 @@
+@block @block_badges @core_badges @_file_upload @javascript
+Feature: Enable Block Badges on the dashboard and view awarded badges
+  In order to view recent badges on the dashboard
+  As a teacher
+  I can add badges block to the dashboard
+
+  Scenario: Add the recent badges block to a course.
+    Given the following "users" exist:
+      | username | firstname | lastname | email | idnumber |
+      | teacher1 | Teacher | 1 | teacher1@example.com | T1 |
+    And the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1 | 0 |
+    And the following "course enrolments" exist:
+      | user | course | role |
+      | teacher1 | C1 | editingteacher |
+    And the following "blocks" exist:
+      | blockname  | contextlevel | reference | pagetypepattern | defaultregion |
+      | badges     | System       | 1         | my-index        | side-post     |
+    And I log in as "teacher1"
+    And I am on "Course 1" course homepage
+    # Issue badge 1 of 2
+    And I navigate to "Badges > Add a new badge" in current page administration
+    And I set the following fields to these values:
+      | id_name | Badge 1 |
+      | id_description | Badge 1 |
+    And I upload "blocks/badges/tests/fixtures/badge.png" file to "Image" filemanager
+    And I press "Create badge"
+    And I select "Manual issue by role" from the "Add badge criteria" singleselect
+    And I set the field "Teacher" to "1"
+    And I press "Save"
+    And I press "Enable access"
+    And I press "Continue"
+    And I select "Recipients (0)" from the "jump" singleselect
+    And I press "Award badge"
+    And I set the field "potentialrecipients[]" to "Teacher 1 (teacher1@example.com)"
+    And I press "Award badge"
+    And I log out
+    When I log in as "teacher1"
+    Then I should see "Badge 1" in the "Latest badges" "block"

blocks/badges/tests/behat/block_badges_frontpage.feature

@@ -0,0 +1,38 @@
+@block @block_badges @core_badges @_file_upload @javascript
+Feature: Enable Block Badges on the frontpage and view awarded badges
+  In order to enable the badges block on the frontpage
+  As a admin
+  I can add badges block to the frontpage
+
+  Scenario: Add the recent badges block on the frontpage and view recent badges
+    Given the following "users" exist:
+      | username | firstname | lastname | email | idnumber |
+      | teacher1 | Teacher | 1 | teacher1@example.com | T1 |
+    And the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1 | 0 |
+    And the following "course enrolments" exist:
+      | user | course | role |
+      | teacher1 | C1 | editingteacher |
+    And the following "blocks" exist:
+      | blockname | contextlevel | reference | pagetypepattern | defaultregion |
+      | badges    | System       | 1         | site-index      | side-pre      |
+    And I am on the "Course 1" course page logged in as teacher1
+    # Issue badge 1 of 2
+    And I navigate to "Badges > Add a new badge" in current page administration
+    And I set the following fields to these values:
+      | id_name | Badge 1 |
+      | id_description | Badge 1 |
+    And I upload "blocks/badges/tests/fixtures/badge.png" file to "Image" filemanager
+    And I press "Create badge"
+    And I select "Manual issue by role" from the "Add badge criteria" singleselect
+    And I set the field "Teacher" to "1"
+    And I press "Save"
+    And I press "Enable access"
+    And I press "Continue"
+    And I select "Recipients (0)" from the "jump" singleselect
+    And I press "Award badge"
+    And I set the field "potentialrecipients[]" to "Teacher 1 (teacher1@example.com)"
+    And I press "Award badge"
+    When I am on site homepage
+    Then I should see "Badge 1" in the "Latest badges" "block"

blocks/badges/version.php

@@ -0,0 +1,30 @@
+<?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/>.
+
+/**
+ * Version details
+ *
+ * @package    block_badges
+ * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;        // The current plugin version (Date: YYYYMMDDXX).
+$plugin->requires  = 2024041600;        // Requires this Moodle version.
+$plugin->component = 'block_badges';