lib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Library of functions and constants for module attendance
  19  *
  20  * @package   mod_attendance
  21  * @copyright  2011 Artem Andreev <andreev.artem@gmail.com>
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 require_once(dirname(__FILE__) . '/classes/calendar_helpers.php');
  26
  27 /**
  28  * Returns the information if the module supports a feature
  29  *
  30  * @see plugin_supports() in lib/moodlelib.php
  31  * @param string $feature FEATURE_xx constant for requested feature
  32  * @return mixed true if the feature is supported, null if unknown
  33  */
  34 function attendance_supports($feature) {
  35     switch($feature) {
  36         case FEATURE_GRADE_HAS_GRADE:
  37             return true;
  38         case FEATURE_GROUPS:
  39             return true;
  40         case FEATURE_GROUPINGS:
  41             return true;
  42         case FEATURE_MOD_INTRO:
  43             return true;
  44         case FEATURE_BACKUP_MOODLE2:
  45             return true;
  46         // Artem Andreev: AFAIK it's not tested.
  47         case FEATURE_COMPLETION_TRACKS_VIEWS:
  48             return false;
  49         default:
  50             return null;
  51     }
  52 }
  53
  54 function att_add_default_statuses($attid) {
  55     global $DB;
  56
  57     $statuses = $DB->get_recordset('attendance_statuses', array('attendanceid' => 0), 'id');
  58     foreach ($statuses as $st) {
  59         $rec = $st;
  60         $rec->attendanceid = $attid;
  61         $DB->insert_record('attendance_statuses', $rec);
  62     }
  63     $statuses->close();
  64 }
  65
  66 function attendance_add_instance($attendance) {
  67     global $DB;
  68
  69     $attendance->timemodified = time();
  70
  71     $attendance->id = $DB->insert_record('attendance', $attendance);
  72
  73     att_add_default_statuses($attendance->id);
  74
  75     attendance_grade_item_update($attendance);
  76
  77     return $attendance->id;
  78 }
  79
  80
  81 function attendance_update_instance($attendance) {
  82     global $DB;
  83
  84     $attendance->timemodified = time();
  85     $attendance->id = $attendance->instance;
  86
  87     if (! $DB->update_record('attendance', $attendance)) {
  88         return false;
  89     }
  90
  91     attendance_grade_item_update($attendance);
  92
  93     return true;
  94 }
  95
  96
  97 function attendance_delete_instance($id) {
  98     global $DB;
  99
 100     if (! $attendance = $DB->get_record('attendance', array('id' => $id))) {
 101         return false;
 102     }
 103
 104     if ($sessids = array_keys($DB->get_records('attendance_sessions', array('attendanceid' => $id), '', 'id'))) {
 105         if (attendance_existing_calendar_events_ids($sessids)) {
 106             attendance_delete_calendar_events($sessids);
 107         }
 108         $DB->delete_records_list('attendance_log', 'sessionid', $sessids);
 109         $DB->delete_records('attendance_sessions', array('attendanceid' => $id));
 110     }
 111     $DB->delete_records('attendance_statuses', array('attendanceid' => $id));
 112
 113     $DB->delete_records('attendance', array('id' => $id));
 114
 115     attendance_grade_item_delete($attendance);
 116
 117     return true;
 118 }
 119
 120 function attendance_delete_course($course, $feedback=true) {
 121     global $DB;
 122
 123     $attids = array_keys($DB->get_records('attendance', array('course' => $course->id), '', 'id'));
 124     $sessids = array_keys($DB->get_records_list('attendance_sessions', 'attendanceid', $attids, '', 'id'));
 125     if (attendance_existing_calendar_events_ids($sessids)) {
 126         attendance_delete_calendar_events($sessids);
 127     }
 128     if ($sessids) {
 129         $DB->delete_records_list('attendance_log', 'sessionid', $sessids);
 130     }
 131     if ($attids) {
 132         $DB->delete_records_list('attendance_statuses', 'attendanceid', $attids);
 133         $DB->delete_records_list('attendance_sessions', 'attendanceid', $attids);
 134     }
 135     $DB->delete_records('attendance', array('course' => $course->id));
 136
 137     return true;
 138 }
 139
 140 /**
 141  * Called by course/reset.php
 142  * @param $mform form passed by reference
 143  */
 144 function attendance_reset_course_form_definition(&$mform) {
 145     $mform->addElement('header', 'attendanceheader', get_string('modulename', 'attendance'));
 146
 147     $mform->addElement('static', 'description', get_string('description', 'attendance'),
 148                                 get_string('resetdescription', 'attendance'));
 149     $mform->addElement('checkbox', 'reset_attendance_log', get_string('deletelogs', 'attendance'));
 150
 151     $mform->addElement('checkbox', 'reset_attendance_sessions', get_string('deletesessions', 'attendance'));
 152     $mform->disabledIf('reset_attendance_sessions', 'reset_attendance_log', 'notchecked');
 153
 154     $mform->addElement('checkbox', 'reset_attendance_statuses', get_string('resetstatuses', 'attendance'));
 155     $mform->setAdvanced('reset_attendance_statuses');
 156     $mform->disabledIf('reset_attendance_statuses', 'reset_attendance_log', 'notchecked');
 157 }
 158
 159 /**
 160  * Course reset form defaults.
 161  */
 162 function attendance_reset_course_form_defaults($course) {
 163     return array('reset_attendance_log' => 0, 'reset_attendance_statuses' => 0, 'reset_attendance_sessions' => 0);
 164 }
 165
 166 function attendance_reset_userdata($data) {
 167     global $DB;
 168
 169     $status = array();
 170
 171     $attids = array_keys($DB->get_records('attendance', array('course' => $data->courseid), '', 'id'));
 172
 173     if (!empty($data->reset_attendance_log)) {
 174         $sess = $DB->get_records_list('attendance_sessions', 'attendanceid', $attids, '', 'id');
 175         if (!empty($sess)) {
 176             list($sql, $params) = $DB->get_in_or_equal(array_keys($sess));
 177             $DB->delete_records_select('attendance_log', "sessionid $sql", $params);
 178             list($sql, $params) = $DB->get_in_or_equal($attids);
 179             $DB->set_field_select('attendance_sessions', 'lasttaken', 0, "attendanceid $sql", $params);
 180
 181             $status[] = array(
 182                 'component' => get_string('modulenameplural', 'attendance'),
 183                 'item' => get_string('attendancedata', 'attendance'),
 184                 'error' => false
 185             );
 186         }
 187     }
 188
 189     if (!empty($data->reset_attendance_statuses)) {
 190         $DB->delete_records_list('attendance_statuses', 'attendanceid', $attids);
 191         foreach ($attids as $attid) {
 192             att_add_default_statuses($attid);
 193         }
 194
 195         $status[] = array(
 196             'component' => get_string('modulenameplural', 'attendance'),
 197             'item' => get_string('sessions', 'attendance'),
 198             'error' => false
 199         );
 200     }
 201
 202     if (!empty($data->reset_attendance_sessions)) {
 203         $sessionsids = array_keys($DB->get_records_list('attendance_sessions', 'attendanceid', $attids, '', 'id'));
 204         if (attendance_existing_calendar_events_ids($sessionsids)) {
 205             attendance_delete_calendar_events($sessionsids);
 206         }
 207         $DB->delete_records_list('attendance_sessions', 'attendanceid', $attids);
 208
 209         $status[] = array(
 210             'component' => get_string('modulenameplural', 'attendance'),
 211             'item' => get_string('statuses', 'attendance'),
 212             'error' => false
 213         );
 214     }
 215
 216     return $status;
 217 }
 218 /*
 219  * Return a small object with summary information about what a
 220  *  user has done with a given particular instance of this module
 221  *  Used for user activity reports.
 222  *  $return->time = the time they did it
 223  *  $return->info = a short text description
 224  */
 225 function attendance_user_outline($course, $user, $mod, $attendance) {
 226     global $CFG;
 227     require_once(dirname(__FILE__).'/locallib.php');
 228     require_once($CFG->libdir.'/gradelib.php');
 229
 230     $grades = grade_get_grades($course->id, 'mod', 'attendance', $attendance->id, $user->id);
 231
 232     $result = new stdClass();
 233     if (!empty($grades->items[0]->grades)) {
 234         $grade = reset($grades->items[0]->grades);
 235         $result->time = $grade->dategraded;
 236     } else {
 237         $result->time = 0;
 238     }
 239     if (has_capability('mod/attendance:canbelisted', $mod->context, $user->id)) {
 240         $statuses = attendance_get_statuses($attendance->id);
 241         $grade = attendance_get_user_grade(attendance_get_user_statuses_stat($attendance->id, $course->startdate,
 242                                                                       $user->id, $mod), $statuses);
 243         $maxgrade = attendance_get_user_max_grade(attendance_get_user_taken_sessions_count($attendance->id, $course->startdate,
 244                                                                                     $user->id, $mod), $statuses);
 245
 246         $result->info = $grade.' / '.$maxgrade;
 247     }
 248
 249     return $result;
 250 }
 251 /*
 252  * Print a detailed representation of what a  user has done with
 253  * a given particular instance of this module, for user activity reports.
 254  *
 255  */
 256 function attendance_user_complete($course, $user, $mod, $attendance) {
 257     global $CFG;
 258
 259     require_once(dirname(__FILE__).'/renderhelpers.php');
 260     require_once($CFG->libdir.'/gradelib.php');
 261
 262     if (has_capability('mod/attendance:canbelisted', $mod->context, $user->id)) {
 263         echo construct_full_user_stat_html_table($attendance, $user);
 264     }
 265 }
 266
 267 function attendance_update_grades($attendance, $userid=0, $nullifnone=true) {
 268     // We need this function to exist so that quick editing of module name is passed to gradebook.
 269 }
 270 /**
 271  * Create grade item for given attendance
 272  *
 273  * @param object $attendance object with extra cmidnumber
 274  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
 275  * @return int 0 if ok, error code otherwise
 276  */
 277 function attendance_grade_item_update($attendance, $grades=null) {
 278     global $CFG, $DB;
 279
 280     require_once('locallib.php');
 281
 282     if (!function_exists('grade_update')) { // Workaround for buggy PHP versions.
 283         require_once($CFG->libdir.'/gradelib.php');
 284     }
 285
 286     if (!isset($attendance->courseid)) {
 287         $attendance->courseid = $attendance->course;
 288     }
 289     if (!$DB->get_record('course', array('id' => $attendance->course))) {
 290         error("Course is misconfigured");
 291     }
 292
 293     if (!empty($attendance->cmidnumber)) {
 294         $params = array('itemname' => $attendance->name, 'idnumber' => $attendance->cmidnumber);
 295     } else {
 296         // MDL-14303.
 297         $params = array('itemname' => $attendance->name/*, 'idnumber'=>$attendance->id*/);
 298     }
 299
 300     if ($attendance->grade > 0) {
 301         $params['gradetype'] = GRADE_TYPE_VALUE;
 302         $params['grademax']  = $attendance->grade;
 303         $params['grademin']  = 0;
 304     } else if ($attendance->grade < 0) {
 305         $params['gradetype'] = GRADE_TYPE_SCALE;
 306         $params['scaleid']   = -$attendance->grade;
 307
 308     } else {
 309         $params['gradetype'] = GRADE_TYPE_NONE;
 310     }
 311
 312     if ($grades === 'reset') {
 313         $params['reset'] = true;
 314         $grades = null;
 315     }
 316
 317     return grade_update('mod/attendance', $attendance->courseid, 'mod', 'attendance', $attendance->id, 0, $grades, $params);
 318 }
 319
 320 /**
 321  * Delete grade item for given attendance
 322  *
 323  * @param object $attendance object
 324  * @return object attendance
 325  */
 326 function attendance_grade_item_delete($attendance) {
 327     global $CFG;
 328     require_once($CFG->libdir.'/gradelib.php');
 329
 330     if (!isset($attendance->courseid)) {
 331         $attendance->courseid = $attendance->course;
 332     }
 333
 334     return grade_update('mod/attendance', $attendance->courseid, 'mod', 'attendance',
 335                         $attendance->id, 0, null, array('deleted' => 1));
 336 }
 337
 338 /**
 339  * This function returns if a scale is being used by one attendance
 340  * it it has support for grading and scales. Commented code should be
 341  * modified if necessary. See book, glossary or journal modules
 342  * as reference.
 343  *
 344  * @param int $attendanceid
 345  * @param int $scaleid
 346  * @return boolean True if the scale is used by any attendance
 347  */
 348 function attendance_scale_used ($attendanceid, $scaleid) {
 349     return false;
 350 }
 351
 352 /**
 353  * Checks if scale is being used by any instance of attendance
 354  *
 355  * This is used to find out if scale used anywhere
 356  *
 357  * @param int $scaleid
 358  * @return bool true if the scale is used by any book
 359  */
 360 function attendance_scale_used_anywhere($scaleid) {
 361     return false;
 362 }
 363
 364 /**
 365  * Serves the attendance sessions descriptions files.
 366  *
 367  * @param object $course
 368  * @param object $cm
 369  * @param object $context
 370  * @param string $filearea
 371  * @param array $args
 372  * @param bool $forcedownload
 373  * @return bool false if file not found, does not return if found - justsend the file
 374  */
 375 function attendance_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
 376     global $DB;
 377
 378     if ($context->contextlevel != CONTEXT_MODULE) {
 379         return false;
 380     }
 381
 382     require_login($course, false, $cm);
 383
 384     if (!$DB->record_exists('attendance', array('id' => $cm->instance))) {
 385         return false;
 386     }
 387
 388     // Session area is served by pluginfile.php.
 389     $fileareas = array('session');
 390     if (!in_array($filearea, $fileareas)) {
 391         return false;
 392     }
 393
 394     $sessid = (int)array_shift($args);
 395     if (!$DB->record_exists('attendance_sessions', array('id' => $sessid))) {
 396         return false;
 397     }
 398
 399     $fs = get_file_storage();
 400     $relativepath = implode('/', $args);
 401     $fullpath = "/$context->id/mod_attendance/$filearea/$sessid/$relativepath";
 402     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
 403         return false;
 404     }
 405     send_stored_file($file, 0, 0, true);
 406 }