Fixes #223 allow student attendance to be disabled at site-level

Expired enrolments can prevent student self-attendance

.travis.yml

@@ -0,0 +1,42 @@
+language: php
+
+sudo: false
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+php:
+# - 5.4
+# - 5.5
+ - 5.6
+ - 7.0
+
+matrix:
+ allow_failures:
+  - php: 7.0
+
+env:
+ matrix:
+  - DB=pgsql MOODLE_BRANCH=MOODLE_28_STABLE
+  - DB=mysqli MOODLE_BRANCH=MOODLE_28_STABLE
+
+before_install:
+  - cd ../..
+  - composer selfupdate
+  - composer create-project -n --no-dev moodlerooms/moodle-plugin-ci ci ^1
+  - export PATH="$(cd ci/bin; pwd):$(cd ci/vendor/bin; pwd):$PATH"
+
+install:
+  - moodle-plugin-ci install
+
+script:
+  - moodle-plugin-ci phplint
+  - moodle-plugin-ci phpcpd
+  - moodle-plugin-ci phpmd
+  - moodle-plugin-ci codechecker
+  - moodle-plugin-ci csslint
+  - moodle-plugin-ci shifter
+  - moodle-plugin-ci jshint
+  - moodle-plugin-ci phpunit
+  - moodle-plugin-ci behat

README.md

@@ -1,21 +1,15 @@
 ABOUT
 ==========
-The "Attendance" module was developed by
+The Attendance module is supported and maintained by Dan Marsden http://danmarsden.com
+
+The Attendance module was previously developed by
     Dmitry Pupinin, Novosibirsk, Russia,
     Artem Andreev, Taganrog, Russia.
 
-This block may be distributed under the terms of the General Public License
-(see http://www.gnu.org/licenses/gpl.txt for details)
-
 PURPOSE
 ==========
-The attendance module and block are designed to allow instructors of a course keep an attendance log of the students in their courses. The instructor will setup the frequency of his classes (# of days per week & length of course) and the attendance is ready for use. To take attendance, the instructor clicks on the "Update Attendance" button and is presented with a list of all the students in that course, along with 4 options: Present, Absent, Late & Excused, with a Remarks textbox. Instructors can download the attendance for their course in Excel format or text format.
-Only the instructor can update the attendance data. However, a student gets to see his attendance record.
-
-INSTALLATION
-==========
-The attendance module follows standard installation procedure.
+The Attendance module allows teachers to maintain a record of attendance, replacing or supplementing a paper-based attendance register.
+It is primarily used in blended-learning environments where students are required to attend classes, lectures and tutorials and allows
+the teacher to track and optionally provide a grade for the students attendance.
 
-1. Create folder <path to your moodle dir>/mod/attendance.
-2. Extract files from folder inside archive to created folder.
-3. Visit page Home ► Site administration ► Notifications to complete installation.
+Sessions can be configured to allow students to record their own attendance and a range of different reports are available.

add_form.php

@@ -106,8 +106,13 @@ class mod_attendance_add_form extends moodleform {
         $mform->addHelpButton('addmultiply', 'createmultiplesessions', 'attendance');
 
         // Students can mark own attendance.
-        $mform->addElement('checkbox', 'studentscanmark', '', get_string('studentscanmark','attendance'));
-        $mform->addHelpButton('studentscanmark', 'studentscanmark', 'attendance');
+        if (!empty(get_config('attendance', 'studentscanmark'))) {
+            $mform->addElement('checkbox', 'studentscanmark', '', get_string('studentscanmark', 'attendance'));
+            $mform->addHelpButton('studentscanmark', 'studentscanmark', 'attendance');
+        } else {
+            $mform->addElement('hidden', 'studentscanmark', '0');
+            $mform->settype('studentscanmark', PARAM_INT);
+        }
 
         $mform->addElement('date_time_selector', 'sessiondate', get_string('sessiondate', 'attendance'));
 

attendance.php

@@ -41,6 +41,10 @@ $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST)
 // Require the user is logged in.
 require_login($course, true, $cm);
 
+if (empty(get_config('attendance', 'studentscanmark')) || empty($attforsession->studentscanmark)) {
+    redirect(new moodle_url('/mod/attendance/view.php', array('id' => $cm->id)));
+    exit;
+}
 $pageparams->sessionid = $id;
 $att = new attendance($attendance, $cm, $course, $PAGE->context, $pageparams);
 

lang/en/attendance.php

@@ -67,6 +67,7 @@ $string['cannottakeforgroup'] = 'You can\'t take attendance for group "{$a}"';
 $string['changeattendance'] = 'Change attendance';
 $string['changeduration'] = 'Change duration';
 $string['changesession'] = 'Change session';
+$string['checkweekdays'] = 'Select weekdays that fall within your selected session date range.';
 $string['column'] = 'column';
 $string['columns'] = 'columns';
 $string['commonsession'] = 'Common';
@@ -103,6 +104,8 @@ $string['downloadtext'] = 'Download in text format';
 $string['donotusepaging'] = 'Do not use paging';
 $string['duration'] = 'Duration';
 $string['editsession'] = 'Edit Session';
+$string['emptyacronym'] = 'Empty acronyms are not allowed. Status record not updated.';
+$string['emptydescription'] = 'Empty descriptions are not allowed. Status record not updated.';
 $string['edituser'] = 'Edit user';
 $string['endtime'] = 'Session end time';
 $string['endofperiod'] = 'End of period';
@@ -291,10 +294,11 @@ $string['eventstatusupdated'] = 'Status updated';
 $string['eventstatusadded'] = 'Status added';
 
 $string['studentscanmark'] = 'Allow students to record own attendance';
+$string['studentscanmark_desc'] = 'If checked, teachers will be able to allow students to mark their own attendance.';
 $string['studentscanmark_help'] = 'If checked students will be able to change their own attendance status for the session.';
 $string['set_by_student'] = 'Self-recorded';
 $string['attendance_already_submitted'] = 'You may not self register attendance that has already been set.';
 $string['lowgrade'] = 'Low grade';
 $string['submitattendance'] = 'Submit attendance';
 $string['attendancenotset'] = 'You must set your attendance';
-$string['export'] = 'Export';
+$string['export'] = 'Export';

locallib.php

@@ -1101,7 +1101,7 @@ class attendance {
             $maxtime = 'CASE WHEN MIN(ue.timeend) = 0 THEN 0 ELSE MAX(ue.timeend) END';
 
             // CONTRIB-3549
-            $sql = "SELECT ue.userid, ue.status,
+            $sql = "SELECT ue.userid, MIN(ue.status) as status,
                            $mintime AS mintime,
                            $maxtime AS maxtime
                       FROM {user_enrolments} ue
@@ -1109,7 +1109,7 @@ class attendance {
                      WHERE ue.userid $sql
                            AND e.status = :estatus
                            AND e.courseid = :courseid
-                  GROUP BY ue.userid, ue.status";
+                  GROUP BY ue.userid";
             $params += array('zerotime'=>0, 'estatus'=>ENROL_INSTANCE_ENABLED, 'courseid'=>$this->course->id);
             $enrolments = $DB->get_records_sql($sql, $params);
 
@@ -1166,7 +1166,7 @@ class attendance {
 
         // CONTRIB-4868
         $mintime = 'MIN(CASE WHEN (ue.timestart > :zerotime) THEN ue.timestart ELSE ue.timecreated END)';
-        $maxtime = 'MAX(ue.timeend)';
+        $maxtime = 'CASE WHEN MIN(ue.timeend) = 0 THEN 0 ELSE MAX(ue.timeend) END';
 
         $sql = "SELECT ue.userid, ue.status,
                        $mintime AS mintime,
@@ -1596,6 +1596,13 @@ class attendance {
     public function update_status($status, $acronym, $description, $grade, $visible) {
         global $DB;
 
+        if (isset($visible)) {
+            $status->visible = $visible;
+            $updated[] = $visible ? get_string('show') : get_string('hide');
+        } else if (empty($acronym) || empty($description)) {
+            return array('acronym' => $acronym, 'description' => $description);
+        }
+
         $updated = array();
 
         if ($acronym) {
@@ -1610,10 +1617,6 @@ class attendance {
             $status->grade = $grade;
             $updated[] = $grade;
         }
-        if (isset($visible)) {
-            $status->visible = $visible;
-            $updated[] = $visible ? get_string('show') : get_string('hide');
-        }
         $DB->update_record('attendance_statuses', $status);
 
         $event = \mod_attendance\event\status_updated::create(array(

preferences.php

@@ -55,6 +55,8 @@ $PAGE->set_cacheable(true);
 $PAGE->set_button($OUTPUT->update_module_button($cm->id, 'attendance'));
 $PAGE->navbar->add(get_string('settings', 'attendance'));
 
+$errors = array();
+
 switch ($att->pageparams->action) {
     case att_preferences_page_params::ACTION_ADD:
         $newacronym         = optional_param('newacronym', null, PARAM_TEXT);
@@ -92,7 +94,7 @@ switch ($att->pageparams->action) {
         echo $OUTPUT->footer();
         exit;
     case att_preferences_page_params::ACTION_HIDE:
-        $statuses = $att->get_statuses();
+        $statuses = $att->get_statuses(false);
         $status = $statuses[$att->pageparams->statusid];
         $att->update_status($status, null, null, null, 0);
         break;
@@ -112,7 +114,7 @@ switch ($att->pageparams->action) {
 
         foreach ($acronym as $id => $v) {
             $status = $statuses[$id];
-            $att->update_status($status, $acronym[$id], $description[$id], $grade[$id], null);
+            $errors[$id] = $att->update_status($status, $acronym[$id], $description[$id], $grade[$id], null);
         }
         if ($att->grade > 0) {
             att_update_all_users_grades($att->id, $att->course, $att->context, $cm);
@@ -122,7 +124,7 @@ switch ($att->pageparams->action) {
 
 $output = $PAGE->get_renderer('mod_attendance');
 $tabs = new attendance_tabs($att, attendance_tabs::TAB_PREFERENCES);
-$prefdata = new attendance_preferences_data($att);
+$prefdata = new attendance_preferences_data($att, array_filter($errors));
 $setselector = new attendance_set_selector($att, $maxstatusset);
 
 // Output starts here.

renderables.php

@@ -548,8 +548,11 @@ class attendance_preferences_data implements renderable {
 
     private $att;
 
-    public function __construct(attendance $att) {
+    public $errors;
+
+    public function __construct(attendance $att, $errors) {
         $this->statuses = $att->get_statuses(false);
+        $this->errors = $errors;
 
         foreach ($this->statuses as $st) {
             $st->haslogs = att_has_logs_for_status ($st->id);

renderer.php

@@ -295,8 +295,6 @@ class mod_attendance_renderer extends plugin_renderer_base {
                         att_sessions_page_params::ACTION_DELETE_SELECTED => get_string('delete'),
                         att_sessions_page_params::ACTION_CHANGE_DURATION => get_string('changeduration', 'attendance'));
 
-
-
             $controls = html_writer::select($options, 'action');
             $attributes = array(
                     'type'  => 'submit',
@@ -770,7 +768,8 @@ class mod_attendance_renderer extends plugin_renderer_base {
                 $cell->colspan = 2;
                 $row->cells[] = $cell;
             } else {
-                if (!empty($sess->studentscanmark)) { // Student can mark their own attendance.
+                if (!empty(get_config('attendance', 'studentscanmark')) && !empty($sess->studentscanmark)) {
+                    // Student can mark their own attendance.
                     // URL to the page that lets the student modify their attendance.
                     $url = new moodle_url('/mod/attendance/attendance.php',
                             array('sessid' => $sess->id, 'sesskey' => sesskey()));
@@ -963,10 +962,21 @@ class mod_attendance_renderer extends plugin_renderer_base {
 
         $i = 1;
         foreach ($prefdata->statuses as $st) {
+            $emptyacronym = '';
+            $emptydescription = '';
+            if (array_key_exists($st->id, $prefdata->errors)) {
+                if (empty($prefdata->errors[$st->id]['acronym'])) {
+                    $emptyacronym = $this->construct_notice(get_string('emptyacronym', 'mod_attendance'), 'notifyproblem');
+                }
+                if (empty($prefdata->errors[$st->id]['description'])) {
+                    $emptydescription = $this->construct_notice(get_string('emptydescription', 'mod_attendance') , 'notifyproblem');
+                }
+            }
+
             $table->data[$i][] = $i;
-            $table->data[$i][] = $this->construct_text_input('acronym['.$st->id.']', 2, 2, $st->acronym);
-            $table->data[$i][] = $this->construct_text_input('description['.$st->id.']', 30, 30, $st->description);
-            $table->data[$i][] = $this->construct_text_input('grade['.$st->id.']', 4, 4, format_float($st->grade));
+            $table->data[$i][] = $this->construct_text_input('acronym['.$st->id.']', 2, 2, $st->acronym) . $emptyacronym;
+            $table->data[$i][] = $this->construct_text_input('description['.$st->id.']', 30, 30, $st->description) . $emptydescription;
+            $table->data[$i][] = $this->construct_text_input('grade['.$st->id.']', 4, 4, $st->grade);
             $table->data[$i][] = $this->construct_preferences_actions_icons($st, $prefdata);
 
             $i++;
@@ -1040,6 +1050,18 @@ class mod_attendance_renderer extends plugin_renderer_base {
         return html_writer::empty_tag('input', $attributes);
     }
 
+    /**
+     * Construct a notice message
+     * 
+     * @param string $text
+     * @param string $class
+     * @return string
+     */
+    private function construct_notice($text, $class = 'notifymessage') {
+        $attributes = array('class' => $class);
+        return html_writer::tag('p', $text, $attributes);
+    }
+
     // Show different picture if it is a temporary user.
     protected function user_picture($user, array $opts = null) {
         if ($user->type == 'temporary') {

sessions.php

@@ -126,8 +126,10 @@ switch ($att->pageparams->action) {
             }
             redirect($att->url_manage(), get_string('sessiondeleted', 'attendance'));
         }
-        $sessid = required_param_array('sessid', PARAM_SEQUENCE);
-
+        $sessid = optional_param_array('sessid', '', PARAM_SEQUENCE);
+        if (empty($sessid)) {
+            print_error('nosessionsselected', 'attendance', $att->url_manage());
+        }
         $sessionsinfo = $att->get_sessions_info($sessid);
 
         $message = get_string('deletecheckfull', '', get_string('session', 'attendance'));
@@ -192,6 +194,10 @@ function construct_sessions_data_for_add($formdata) {
     $duration = $formdata->durtime['hours']*HOURSECS + $formdata->durtime['minutes']*MINSECS;
     $now = time();
 
+    if (empty(get_config('attendance', 'studentscanmark'))) {
+        $formdata->studentscanmark = 0;
+    }
+
     $sessions = array();
     if (isset($formdata->addmultiply)) {
         $startdate = $formdata->sessiondate;

settings.php

@@ -41,4 +41,7 @@ if ($ADMIN->fulltree) {
 
     $settings->add(new admin_setting_configselect('attendance/resultsperpage',
         get_string('resultsperpage', 'attendance'), get_string('resultsperpage_desc', 'attendance'), 25, $options));
+
+    $settings->add(new admin_setting_configcheckbox('attendance/studentscanmark',
+        get_string('studentscanmark', 'attendance'), get_string('studentscanmark_desc', 'attendance'), 1));
 }

tests/behat/preferences.feature

@@ -0,0 +1,55 @@
+@mod @uon @mod_attendance @mod_attendance_preferences
+Feature: Teachers can't change status variables to have empty acronyms or descriptions
+    In order to update status variables
+    As a teacher
+    I need to see an error notice below each acronym / description that I try to set to be empty
+
+    Background:
+        Given the following "courses" exist:
+            | fullname | shortname | summary | category |
+            | Course 1 | C101      | Prove the attendance activity settings works | 0 |
+        And the following "users" exist:
+            | username    | firstname | lastname |
+            | student1    | Sam       | Student  |
+            | teacher1    | Teacher   | One      |
+        And the following "course enrolments" exist:
+            | user        | course | role    |
+            | student1    | C101   | student |
+            | teacher1    | C101   | editingteacher |
+        And I log in as "teacher1"
+        And I follow "Course 1"
+        And I turn editing mode on
+        And I add a "Attendance" to section "1"
+        And I press "Save and display"
+        And I follow "Settings"
+
+    @javascript
+    Scenario: Teachers can add status variables
+        # Set the second status acronym to be empty
+        Given I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[2]/td[2]/input" to ""
+        # Set the second status description to be empty
+        And I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[2]/td[3]/input" to ""
+        # Set the second status grade to be empty
+        And I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[2]/td[4]/input" to ""
+        When I click on "Update" "button" in the "#preferencesform" "css_element"
+        Then I should see "Empty acronyms are not allowed" in the "//*[@id='preferencesform']/table/tbody/tr[2]/td[2]/p" "xpath_element"
+        And I should see "Empty descriptions are not allowed" in the "//*[@id='preferencesform']/table/tbody/tr[2]/td[3]/p" "xpath_element"
+        And I click on "Update" "button" in the "#preferencesform" "css_element"
+
+        # Set the first status acronym to be empty
+        Given I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[1]/td[2]/input" to ""
+        # Set the first status description to be empty
+        And I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[1]/td[3]/input" to ""
+        # Set the first status grade to be empty
+        And I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[1]/td[4]/input" to ""
+        # Set the third status acronym to be empty
+        And I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[3]/td[2]/input" to ""
+        # Set the third status description to be empty
+        And I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[3]/td[3]/input" to ""
+        # Set the third status grade to be empty
+        And I set the field with xpath "//*[@id='preferencesform']/table/tbody/tr[3]/td[4]/input" to ""
+        When I click on "Update" "button" in the "#preferencesform" "css_element"
+        Then I should see "Empty acronyms are not allowed" in the "//*[@id='preferencesform']/table/tbody/tr[1]/td[2]/p" "xpath_element"
+        And I should see "Empty descriptions are not allowed" in the "//*[@id='preferencesform']/table/tbody/tr[1]/td[3]/p" "xpath_element"
+        And I should see "Empty acronyms are not allowed" in the "//*[@id='preferencesform']/table/tbody/tr[3]/td[2]/p" "xpath_element"
+        And I should see "Empty descriptions are not allowed" in the "//*[@id='preferencesform']/table/tbody/tr[3]/td[3]/p" "xpath_element"

version.php

@@ -23,8 +23,8 @@
  */
 
 $plugin->version  = 2015040503;
-$plugin->requires = 2014042900;
-$plugin->release = '2.9.1';
+$plugin->requires = 2014111000;
+$plugin->release = '2.9.1.1';
 $plugin->maturity  = MATURITY_STABLE;
 $plugin->cron     = 0;
 $plugin->component = 'mod_attendance';