first commit

question/bank/viewcreator/classes/creator_name_column.php

@@ -0,0 +1,78 @@
+<?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 qbank_viewcreator;
+
+use core_question\local\bank\column_base;
+
+/**
+ * A column type for the name of the question creator.
+ *
+ * @package   qbank_viewcreator
+ * @copyright 2009 Tim Hunt
+ * @author    2021 Ghaly Marc-Alexandre <marc-alexandreghaly@catalyst-ca.net>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class creator_name_column extends column_base {
+
+    public function get_name(): string {
+        return 'creatorname';
+    }
+
+    public function get_title(): string {
+        return get_string('createdby', 'question');
+    }
+
+    protected function display_content($question, $rowclasses): void {
+        global $PAGE;
+        $displaydata = [];
+
+        if (!empty($question->creatorfirstname) && !empty($question->creatorlastname)) {
+            $u = new \stdClass();
+            $u = username_load_fields_from_object($u, $question, 'creator');
+            $displaydata['date'] = userdate($question->timecreated, get_string('strftimedatetime', 'langconfig'));
+            $displaydata['creator'] = fullname($u);
+            echo $PAGE->get_renderer('qbank_viewcreator')->render_creator_name($displaydata);
+        }
+    }
+
+    public function get_extra_joins(): array {
+        return ['uc' => 'LEFT JOIN {user} uc ON uc.id = q.createdby'];
+    }
+
+    public function get_required_fields(): array {
+        $allnames = \core_user\fields::get_name_fields();
+        $requiredfields = [];
+        foreach ($allnames as $allname) {
+            $requiredfields[] = 'uc.' . $allname . ' AS creator' . $allname;
+        }
+        $requiredfields[] = 'q.timecreated';
+        return $requiredfields;
+    }
+
+    public function is_sortable(): array {
+        return [
+            'firstname' => ['field' => 'uc.firstname', 'title' => get_string('firstname')],
+            'lastname' => ['field' => 'uc.lastname', 'title' => get_string('lastname')],
+            'timecreated' => ['field' => 'q.timecreated', 'title' => get_string('date')]
+        ];
+    }
+
+    public function get_extra_classes(): array {
+        return ['pr-3'];
+    }
+
+}

question/bank/viewcreator/classes/modifier_name_column.php

@@ -0,0 +1,77 @@
+<?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 qbank_viewcreator;
+
+use core_question\local\bank\column_base;
+
+/**
+ * A column for info of the question modifier.
+ *
+ * @package    qbank_viewcreator
+ * @copyright  2022 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class modifier_name_column extends column_base {
+
+    public function get_name(): string {
+        return 'modifiername';
+    }
+
+    public function get_title(): string {
+        return get_string('modifiedby', 'qbank_viewcreator');
+    }
+
+    protected function display_content($question, $rowclasses): void {
+        global $PAGE;
+        $displaydata = [];
+        if (!empty($question->modifierfirstname) && !empty($question->modifierlastname)) {
+            $u = new \stdClass();
+            $u = username_load_fields_from_object($u, $question, 'modifier');
+            $displaydata['date'] = userdate($question->timemodified, get_string('strftimedatetime', 'langconfig'));
+            $displaydata['creator'] = fullname($u);
+            echo $PAGE->get_renderer('qbank_viewcreator')->render_creator_name($displaydata);
+        }
+    }
+
+    public function get_extra_joins(): array {
+        return ['um' => 'LEFT JOIN {user} um ON um.id = q.modifiedby'];
+    }
+
+    public function get_required_fields(): array {
+        $allnames = \core_user\fields::get_name_fields();
+        $requiredfields = [];
+        foreach ($allnames as $allname) {
+            $requiredfields[] = 'um.' . $allname . ' AS modifier' . $allname;
+        }
+        $requiredfields[] = 'q.timemodified';
+        return $requiredfields;
+    }
+
+    public function is_sortable(): array {
+        return [
+            'firstname' => ['field' => 'um.firstname', 'title' => get_string('firstname')],
+            'lastname' => ['field' => 'um.lastname', 'title' => get_string('lastname')],
+            'timemodified' => ['field' => 'q.timemodified', 'title' => get_string('date')]
+        ];
+    }
+
+    public function get_extra_classes(): array {
+        return ['pr-3'];
+    }
+
+}

question/bank/viewcreator/classes/output/renderer.php

@@ -0,0 +1,48 @@
+<?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 qbank_viewcreator\output;
+
+/**
+ * Class renderer.
+ * @package    qbank_viewcreator
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Ghaly Marc-Alexandre <marc-alexandreghaly@catalyst-ca.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class renderer extends \plugin_renderer_base {
+
+    /**
+     * Render question creator.
+     *
+     * @param array $displaydata
+     * @return string
+     */
+    public function render_creator_name($displaydata) {
+        return $this->render_from_template('qbank_viewcreator/creator_display', $displaydata);
+    }
+
+    /**
+     * Render question edit form callback.
+     *
+     * @param array $displaydata
+     * @return string
+     */
+    public function render_version_info($displaydata) {
+        return $this->render_from_template('qbank_viewcreator/version_info', $displaydata);
+    }
+
+}

question/bank/viewcreator/classes/plugin_feature.php

@@ -0,0 +1,37 @@
+<?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 qbank_viewcreator;
+
+use core_question\local\bank\plugin_features_base;
+
+/**
+ * Class plugin_feature is the entrypoint for the columns.
+ *
+ * @package    qbank_viewcreator
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Ghaly Marc-Alexandre <marc-alexandreghaly@catalyst-ca.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class plugin_feature extends plugin_features_base {
+
+    public function get_question_columns($qbank): array {
+        return [
+            new creator_name_column($qbank),
+            new modifier_name_column($qbank),
+        ];
+    }
+}

question/bank/viewcreator/classes/privacy/provider.php

@@ -0,0 +1,32 @@
+<?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 qbank_viewcreator\privacy;
+
+/**
+ * Privacy Subsystem for qbank_viewcreator implementing null_provider.
+ *
+ * @package    qbank_viewcreator
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Ghaly Marc-Alexandre <marc-alexandreghaly@catalyst-ca.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

question/bank/viewcreator/lang/en/qbank_viewcreator.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/>.
+
+/**
+ * Strings for component qbank_viewcreator, language 'en'
+ *
+ * @package    qbank_viewcreator
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Ghaly Marc-Alexandre <marc-alexandreghaly@catalyst-ca.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['modifiedby'] = 'Modified by';
+$string['pluginname'] = 'View creator';
+$string['privacy:metadata'] = 'The View creator question bank plugin does not store any personal data.';
+$string['version'] = 'Version {$a}';

question/bank/viewcreator/lib.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/>.
+
+/**
+ * Helper functions and callbacks.
+ *
+ * @package    qbank_viewcreator
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Edit page callback for information.
+ *
+ * @param object $question
+ * @return string
+ */
+function qbank_viewcreator_edit_form_display($question): string {
+    global $DB, $PAGE;
+    $versiondata = [];
+    $questionversion = $DB->get_record('question_versions', ['questionid' => $question->id])->version;
+    $versiondata['versionnumber'] = $questionversion;
+    if (!empty($question->createdby)) {
+        $a = new stdClass();
+        $a->time = userdate($question->timecreated);
+        $a->user = fullname($DB->get_record('user', ['id' => $question->createdby]));
+        $versiondata['createdby'] = get_string('created', 'question') . ' ' .
+                                    get_string('byandon', 'question', $a);
+    }
+    return $PAGE->get_renderer('qbank_viewcreator')->render_version_info($versiondata);
+
+}

question/bank/viewcreator/templates/creator_display.mustache

@@ -0,0 +1,33 @@
+{{!
+    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/>.
+}}
+{{!
+    @template qbank_viewcreator/creator_display
+    Example context (json):
+    {
+        "displaydata": [
+          {
+                "creator": "Marc Ghaly",
+                "date": "2 June 2021, 5:32 PM",
+          }
+        ]
+    }
+}}
+
+<span class="qbank-creator-name">
+    {{creator}}
+</span>
+<br>
+<span class="date">
+    {{date}}
+</span>

question/bank/viewcreator/templates/version_info.mustache

@@ -0,0 +1,37 @@
+{{!
+    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/>.
+}}
+{{!
+    @template qbank_viewcreator/version_info
+
+    Example context (json):
+    {
+        "addquestiondata": [
+          {
+                "versionnumber": 1,
+                "createdby": "Admin User on Wednesday, 20 October 2021, 5:33 AM"
+          }
+        ]
+    }
+}}
+<div class="question-version-number">
+    <a><u>{{#str}} version, qbank_viewcreator, {{versionnumber}} {{/str}}</u></a>
+</div>
+{{#createdby}}
+    <div class="question-creator-info">
+        <a>{{{createdby}}}</a>
+    </div>
+{{/createdby}}

question/bank/viewcreator/tests/behat/modified_by_column.feature

@@ -0,0 +1,73 @@
+@qbank @qbank_viewcreator
+Feature: Question bank Modified by column
+  In order to help keep track of the changes of the question version in the question bank
+  As a teacher
+  I need to know who modified the question and when the modification made in the question bank
+
+  Background:
+    Given the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1        | 0        |
+    And the following "users" exist:
+      | username | firstname | lastname | email |
+      | teacher1 | Teacher1 | 1 | teacher1@example.com |
+      | teacher2 | Teacher2 | 2 | teacher2@example.com |
+    And the following "course enrolments" exist:
+      | user | course | role |
+      | teacher1 | C1 | editingteacher |
+      | teacher2 | C1 | editingteacher |
+    And the following "activities" exist:
+      | activity   | name      | course | idnumber |
+      | quiz       | Test quiz | C1     | quiz1    |
+    And the following "question categories" exist:
+      | contextlevel    | reference | name           |
+      | Activity module | quiz1     | Test questions |
+    And the following "questions" exist:
+      | questioncategory | qtype     | name           | questiontext              |
+      | Test questions   | truefalse | First question | Answer the first question |
+
+  @javascript
+  Scenario: Enable/disable modified by column from the base view
+    Given I log in as "admin"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I should see "View creator"
+    When I click on "Disable" "link" in the "View creator" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    And I set the field "Filter type" to "Category"
+    And I set the field "Category" to "Test questions"
+    And I press "Apply filters"
+    Then I should not see "Modified by"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I click on "Enable" "link" in the "View creator" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    And I set the field "Filter type" to "Category"
+    And I set the field "Category" to "Test questions"
+    And I press "Apply filters"
+    Then I should see "Modified by"
+
+  @javascript
+  Scenario: Editing a question shows the modifier of the question
+    And I log in as "teacher1"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    And I set the field "Filter type" to "Category"
+    And I set the field "Category" to "Test questions"
+    And I press "Apply filters"
+    And I should see "First question"
+    And I choose "Edit question" action for "First question" in the question bank
+    And I should see "Version 1"
+    And I set the field "id_name" to "Renamed question v2"
+    And I set the field "id_questiontext" to "edited question"
+    And I press "id_submitbutton"
+    And I should see "Teacher1"
+    And I log in as "teacher2"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    And I set the field "Filter type" to "Category"
+    And I set the field "Category" to "Test questions"
+    And I press "Apply filters"
+    And I choose "Edit question" action for "Renamed question v2" in the question bank
+    Then I should see "Version 2"
+    And I set the field "id_name" to "Renamed question v3"
+    And I set the field "id_questiontext" to "edited question v3"
+    And I press "id_submitbutton"
+    And I should not see "Teacher1"
+    And I should see "Teacher2"

question/bank/viewcreator/tests/behat/view_view_creator_column.feature

@@ -0,0 +1,29 @@
+@qbank @qbank_viewcreator
+Feature: Use the qbank plugin manager page for viewcreator plugin
+  In order to check the plugin behaviour with enable and disable
+
+  Background:
+    Given the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1        | 0        |
+    And the following "activities" exist:
+      | activity   | name      | course | idnumber |
+      | quiz       | Test quiz | C1     | quiz1    |
+    And the following "question categories" exist:
+      | contextlevel | reference | name           |
+      | Course         | C1     | Test questions |
+    And the following "questions" exist:
+      | questioncategory | qtype     | name           | questiontext              |
+      | Test questions   | truefalse | First question | Answer the first question |
+
+  Scenario: Enable/disable viewcreator column from the base view
+    Given I log in as "admin"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I should see "View creator"
+    When I click on "Disable" "link" in the "View creator" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    Then I should not see "Created by"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I click on "Enable" "link" in the "View creator" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    Then I should see "Created by"

question/bank/viewcreator/version.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/>.
+
+/**
+ * Version information for qbank_viewcreator.
+ *
+ * @package    qbank_viewcreator
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Ghaly Marc-Alexandre <marc-alexandreghaly@catalyst-ca.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'qbank_viewcreator';
+$plugin->version   = 2024042200;
+$plugin->requires  = 2024041600;
+$plugin->maturity  = MATURITY_STABLE;