Feature/userstats

classes/tables/userstats_table.php

@@ -0,0 +1,274 @@
+<?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/>.
+
+/**
+ * Prints a particular instance of moodleoverflow
+ *
+ * You can have a rather longer description of the file as well,
+ * if you like, and it can span multiple lines.
+ *
+ * @package   mod_moodleoverflow
+ * @copyright 2023 Tamaro Walter
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_moodleoverflow\tables;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/mod/moodleoverflow/lib.php');
+require_once($CFG->libdir . '/tablelib.php');
+
+/**
+ * Table listing all user statistics of a course
+ *
+ * @package   mod_moodleoverflow
+ * @copyright 2023 Tamaro Walter
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class userstats_table extends \flexible_table {
+
+    private $courseid;            // Course ID.
+    private $moodleoverflowid;    // Moodleoverflow that started the printing of statistics.
+    private $usertable = array(); // Usertable will have objects with every user and his statistics.
+
+    /**
+     * Constructor for workflow_table.
+     * @param int $uniqueid Unique id of this table.
+     */
+    public function __construct($uniqueid, $courseid, $moodleoverflow, $url) {
+        parent::__construct($uniqueid);
+        global $PAGE;
+        $this->courseid = $courseid;
+        $this->moodleoverflowid = $moodleoverflow;
+        $this->set_attribute('class', 'statistics-table');
+        $this->set_attribute('id', $uniqueid);
+        $this->define_columns(['id', 'username', 'receivedupvotes', 'receiveddownvotes', 'activity', 'reputation']);
+        $this->define_baseurl($url);
+        $this->define_headers(['User ID', 'User', 'Received upvotes',
+                               'Received downvotes', 'Amount of activity', 'User reputation']);
+        $this->get_table_data();
+        $this->sortable(true, 'reputation', SORT_DESC);
+        $this->no_sorting('id');
+        $this->no_sorting('username');
+        $this->setup();
+    }
+
+    /**
+     * Method to display the table.
+     * @return void
+     */
+    public function out() {
+        global $DB;
+        $this->start_output();
+        $this->sort_table_data($this->get_sort_order());
+        $this->format_and_add_array_of_rows($this->usertable, true);
+        $this->text_sorting('username');
+        $this->finish_output();
+    }
+
+    /**
+     * Method to sort the usertable.
+     */
+    private function sort_table_data($sortorder) {
+        $key = $sortorder['sortby'];
+        // The index of each object in usertable is it's value of $key.
+        $length = count($this->usertable);
+        if ($sortorder['sortorder'] == 4) {
+            // 4 means sort in ascending order.
+            $this->quick_usertable_sort(0, $length - 1, $key, 'asc');
+        } else if ($sortorder['sortorder'] == 3) {
+            // 3 means sort in descending order.
+            $this->quick_usertable_sort(0, $length - 1, $key, 'desc');
+        }
+    }
+
+    /**
+     * Sorts usertable with quicksort algorithm.
+     */
+    private function quick_usertable_sort($low, $high, $key, $order) {
+        if ($low >= $high) {
+            return;
+        }
+        $left = $low;
+        $right = $high;
+        $pivot = $this->usertable[intval(($low + $high) / 2)];
+        $pivot = $pivot->$key;
+        do {
+            if ($order == 'asc') {
+                while ($this->usertable[$left]->$key < $pivot) {
+                    $left++;
+                }
+                while ($this->usertable[$right]->$key > $pivot) {
+                    $right--;
+                }
+            } else if ($order == 'desc') {
+                while ($this->usertable[$left]->$key > $pivot) {
+                    $left++;
+                }
+                while ($this->usertable[$right]->$key < $pivot) {
+                    $right--;
+                }
+            }
+            if ($left <= $right) {
+                $temp = $this->usertable[$right];
+                $this->usertable[$right] = $this->usertable[$left];
+                $this->usertable[$left] = $temp;
+                $right--;
+                $left++;
+            }
+        } while ($left <= $right);
+        if ($low < $right) {
+            if ($order == 'asc') {
+                $this->quick_usertable_sort($low, $right, $key, 'asc');
+            } else if ($order == 'desc') {
+                $this->quick_usertable_sort($low, $right, $key, 'desc');
+            }
+        }
+        if ($high > $left) {
+            if ($order == 'asc') {
+                $this->quick_usertable_sort($left, $high, $key, 'desc');
+            } else if ($order == 'desc') {
+                $this->quick_usertable_sort($left, $high, $key, 'desc');
+            }
+        }
+    }
+
+    /**
+     * Method to collect all the data.
+     * Method will collect all users from the given course and will determine the user statistics
+     *
+     * @return 2d-array with user statistic
+     */
+    public function get_table_data() {
+        global $DB;
+        // Get all userdata from a course.
+        $context = \context_course::instance($this->courseid);
+        $users = get_enrolled_users($context , '',  0, $userfields = 'u.id, u.firstname, u.lastname');
+
+        // Step 1.0: Build the datatable with all relevant Informations.
+        $sqlquery = 'SELECT (ROW_NUMBER() OVER (ORDER BY ratings.id)) AS row_num,
+                            ratings.id AS rateid,
+                            discuss.userid AS discussuserid,
+                            posts.id AS postid,
+                            posts.userid AS postuserid,
+                            ratings.rating AS rating,
+                            ratings.userid AS rateuserid,
+                            ratings.postid AS ratepostid,
+                            discuss.id AS discussid,
+                            posts.discussion AS postdiscussid,
+                            ratings.discussionid AS ratediscussid
+                      FROM {moodleoverflow_discussions} discuss
+                      LEFT JOIN {moodleoverflow_posts} posts ON discuss.id = posts.discussion
+                      LEFT JOIN {moodleoverflow_ratings} ratings ON posts.id = ratings.postid
+                      WHERE discuss.course = ' . $this->courseid . ';';
+        $ratingdata = $DB->get_records_sql($sqlquery);
+
+        // Step 2.0: Now collect the data for every user in the course.
+        foreach ($users as $user) {
+            $student = new \stdClass();
+            $student->id = $user->id;
+            $student->name = $user->firstname . ' ' . $user->lastname;
+            $linktostudent = new \moodle_url('/user/view.php', array('id' => $student->id, 'course' => $this->courseid));
+            $student->link = \html_writer::link($linktostudent->out(), $student->name);
+            $student->submittedposts = array(); // Key = postid, Value = postid.
+            $student->ratedposts = array();     // Key = rateid, Value = rateid.
+            $student->receivedupvotes = 0;
+            $student->receiveddownvotes = 0;
+            $student->activity = 0;
+            $student->reputation = 0;
+            foreach ($ratingdata as $row) {
+                if ($row->postuserid == $student->id && $row->rating == RATING_UPVOTE) {
+                    $student->receivedupvotes += 1;
+                }
+                if ($row->postuserid == $student->id && $row->rating == RATING_DOWNVOTE) {
+                    $student->receiveddownvotes += 1;
+                }
+                if ($row->rateuserid == $student->id && !array_key_exists($row->rateid, $student->ratedposts)) {
+                    $student->activity += 1;
+                    $student->ratedposts[$row->rateid] = $row->rateid;
+                }
+                if ($row->postuserid == $student->id && !array_key_exists($row->postid, $student->submittedposts)) {
+                    $student->activity += 1;
+                    $student->submittedposts[$row->postid] = $row->postid;
+                }
+            }
+            // Get the user reputation from the course.
+            $student->reputation = \mod_moodleoverflow\ratings::moodleoverflow_get_reputation($this->moodleoverflowid,
+                                                                                              $student->id);
+            array_push($this->usertable, $student);
+        }
+    }
+
+    /**
+     * Return the usertable.
+     */
+    public function get_usertable() {
+        return $this->usertable;
+    }
+
+    // Functions that show the data.
+    public function col_userid($row) {
+        return $row->id;
+    }
+
+    public function col_username($row) {
+        return $row->link;
+    }
+
+    public function col_receivedupvotes($row) {
+        if ($row->receivedupvotes > 0) {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-success') .
+                   $row->receivedupvotes . \html_writer::end_span());
+        } else {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-warning') .
+                   $row->receivedupvotes . \html_writer::end_span());
+        }
+    }
+
+    public function col_receiveddownvotes($row) {
+        if ($row->receiveddownvotes > 0) {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-success') .
+                    $row->receiveddownvotes . \html_writer::end_span());
+        } else {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-warning') .
+                   $row->receiveddownvotes . \html_writer::end_span());
+        }
+    }
+
+    public function col_activity($row) {
+        if ($row->activity > 0) {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-success') .
+                   $row->activity . \html_writer::end_span());
+        } else {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-warning') .
+                   $row->activity . \html_writer::end_span());
+        }
+    }
+
+    public function col_reputation($row) {
+        if ($row->reputation > 0) {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-success') .
+                   $row->reputation . \html_writer::end_span());
+        } else {
+            return \html_writer::tag('h5', \html_writer::start_span('badge badge-warning') .
+                   $row->reputation . \html_writer::end_span());
+        }
+    }
+
+    public function other_cols($colname, $attempt) {
+        return null;
+    }
+}

lang/en/moodleoverflow.php

@@ -63,6 +63,7 @@
 
 // Strings for the locallib.php.
 $string['addanewdiscussion'] = 'Add a new discussion topic';
+$string['seeuserstats'] = 'View user statistics';
 $string['nodiscussions'] = 'There are no discussion topics yet in this forum.';
 $string['headerdiscussion'] = 'Discussion';
 $string['headerstartedby'] = 'Started by';

locallib.php

@@ -134,6 +134,7 @@ function moodleoverflow_print_latest_discussions($moodleoverflow, $cm, $page = -
     $canstartdiscussion = moodleoverflow_user_can_post_discussion($moodleoverflow, $cm, $context);
     $canviewdiscussions = has_capability('mod/moodleoverflow:viewdiscussion', $context);
     $canreviewposts = has_capability('mod/moodleoverflow:reviewpost', $context);
+    $canseeuserstats = has_capability('mod/moodleoverflow:viewanyrating', $context);
 
     // Print a button if the user is capable of starting
     // a new discussion or if the selfenrol is aviable.
@@ -146,6 +147,17 @@ function moodleoverflow_print_latest_discussions($moodleoverflow, $cm, $page = -
         echo $OUTPUT->render($button);
     }
 
+    // Print a button if the user is capable of seeing the user stats.
+    if ($canseeuserstats) {
+        $buttontext2 = get_string('seeuserstats', 'moodleoverflow');
+        $buttonurl2 = new moodle_url('/mod/moodleoverflow/userstats.php', ['id' => $cm->id,
+                                                                           'courseid' => $moodleoverflow->course,
+                                                                           'mid' => $moodleoverflow->id]);
+        $button2 = new single_button($buttonurl2, $buttontext2, 'get');
+        $button2->class = 'singlebutton align-middle m-2';
+        echo $OUTPUT->render($button2);
+    }
+
     // Get all the recent discussions the user is allowed to see.
     $discussions = moodleoverflow_get_discussions($cm, $page, $perpage);
 

tests/dailymail_test.php

@@ -127,7 +127,6 @@ private function helper_run_send_mails() {
      * Test if the task send_daily_mail sends a mail to the user.
      */
     public function test_mail_delivery() {
-        global $DB;
 
         // Create user with maildigest = on.
         $this->helper_create_user_and_discussion('1');
@@ -145,7 +144,6 @@ public function test_mail_delivery() {
      * Test if the content of the mail matches the supposed content.
      */
     public function test_content_of_mail_delivery() {
-        global $DB;
 
         // Create user with maildigest = on.
         $this->helper_create_user_and_discussion('1');
@@ -180,7 +178,6 @@ public function test_content_of_mail_delivery() {
      * Test if the task does not send a mail when maildigest = 0
      */
     public function test_mail_not_send() {
-        global $DB;
         // Creat user with daily_mail = off.
         $this->helper_create_user_and_discussion('0');