sessions.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  * Adding attendance sessions
  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__).'/../../config.php');
  26 require_once(dirname(__FILE__).'/locallib.php');
  27 require_once(dirname(__FILE__).'/add_form.php');
  28 require_once(dirname(__FILE__).'/update_form.php');
  29 require_once(dirname(__FILE__).'/duration_form.php');
  30
  31 $pageparams = new mod_attendance_sessions_page_params();
  32
  33 $id                     = required_param('id', PARAM_INT);
  34 $pageparams->action     = required_param('action', PARAM_INT);
  35
  36 if (optional_param('deletehiddensessions', false, PARAM_TEXT)) {
  37     $pageparams->action = mod_attendance_sessions_page_params::ACTION_DELETE_HIDDEN;
  38 }
  39
  40 if (empty($pageparams->action)) {
  41     // The form on manage.php can submit with the "choose" option - this should be fixed in the long term,
  42     // but in the meantime show a useful error and redirect when it occurs.
  43     $url = new moodle_url('/mod/attendance/view.php', array('id' => $id));
  44     redirect($url, get_string('invalidaction', 'mod_attendance'), 2);
  45 }
  46
  47 $cm             = get_coursemodule_from_id('attendance', $id, 0, false, MUST_EXIST);
  48 $course         = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
  49 $att            = $DB->get_record('attendance', array('id' => $cm->instance), '*', MUST_EXIST);
  50
  51 require_login($course, true, $cm);
  52
  53 $context = context_module::instance($cm->id);
  54 require_capability('mod/attendance:manageattendances', $context);
  55
  56 $att = new mod_attendance_structure($att, $cm, $course, $context, $pageparams);
  57
  58 $PAGE->set_url($att->url_sessions(array('action' => $pageparams->action)));
  59 $PAGE->set_title($course->shortname. ": ".$att->name);
  60 $PAGE->set_heading($course->fullname);
  61 $PAGE->set_cacheable(true);
  62 $PAGE->set_button($OUTPUT->update_module_button($cm->id, 'attendance'));
  63 $PAGE->navbar->add($att->name);
  64
  65 $currenttab = attendance_tabs::TAB_ADD;
  66 $formparams = array('course' => $course, 'cm' => $cm, 'modcontext' => $context, 'att' => $att);
  67 switch ($att->pageparams->action) {
  68     case mod_attendance_sessions_page_params::ACTION_ADD:
  69         $url = $att->url_sessions(array('action' => mod_attendance_sessions_page_params::ACTION_ADD));
  70         $mform = new mod_attendance_add_form($url, $formparams);
  71
  72         if ($mform->is_cancelled()) {
  73             redirect($att->url_manage());
  74         }
  75
  76         if ($formdata = $mform->get_data()) {
  77             $sessions = construct_sessions_data_for_add($formdata);
  78             $att->add_sessions($sessions);
  79             if (count($sessions) == 1) {
  80                 $message = get_string('sessiongenerated', 'attendance');
  81             } else {
  82                 $message = get_string('sessionsgenerated', 'attendance', count($sessions));
  83             }
  84
  85             mod_attendance_notifyqueue::notify_success($message);
  86             // Redirect to the sessions tab always showing all sessions.
  87             $SESSION->attcurrentattview[$cm->course] = ATT_VIEW_ALL;
  88             redirect($att->url_manage());
  89         }
  90         break;
  91     case mod_attendance_sessions_page_params::ACTION_UPDATE:
  92         $sessionid = required_param('sessionid', PARAM_INT);
  93
  94         $url = $att->url_sessions(array('action' => mod_attendance_sessions_page_params::ACTION_UPDATE, 'sessionid' => $sessionid));
  95         $formparams['sessionid'] = $sessionid;
  96         $mform = new mod_attendance_update_form($url, $formparams);
  97
  98         if ($mform->is_cancelled()) {
  99             redirect($att->url_manage());
 100         }
 101
 102         if ($formdata = $mform->get_data()) {
 103             $att->update_session_from_form_data($formdata, $sessionid);
 104
 105             mod_attendance_notifyqueue::notify_success(get_string('sessionupdated', 'attendance'));
 106             redirect($att->url_manage());
 107         }
 108         $currenttab = attendance_tabs::TAB_UPDATE;
 109         break;
 110     case mod_attendance_sessions_page_params::ACTION_DELETE:
 111         $sessionid = required_param('sessionid', PARAM_INT);
 112         $confirm   = optional_param('confirm', null, PARAM_INT);
 113
 114         if (isset($confirm) && confirm_sesskey()) {
 115             $att->delete_sessions(array($sessionid));
 116             if ($att->grade > 0) {
 117                 attendance_update_all_users_grades($att, $cm);
 118             }
 119             redirect($att->url_manage(), get_string('sessiondeleted', 'attendance'));
 120         }
 121
 122         $sessinfo = $att->get_session_info($sessionid);
 123
 124         $message = get_string('deletecheckfull', '', get_string('session', 'attendance'));
 125         $message .= str_repeat(html_writer::empty_tag('br'), 2);
 126         $message .= userdate($sessinfo->sessdate, get_string('strftimedmyhm', 'attendance'));
 127         $message .= html_writer::empty_tag('br');
 128         $message .= $sessinfo->description;
 129
 130         $params = array('action' => $att->pageparams->action, 'sessionid' => $sessionid, 'confirm' => 1, 'sesskey' => sesskey());
 131
 132         echo $OUTPUT->header();
 133         echo $OUTPUT->heading(get_string('attendanceforthecourse', 'attendance').' :: ' .format_string($course->fullname));
 134         echo $OUTPUT->confirm($message, $att->url_sessions($params), $att->url_manage());
 135         echo $OUTPUT->footer();
 136         exit;
 137     case mod_attendance_sessions_page_params::ACTION_DELETE_SELECTED:
 138         $confirm    = optional_param('confirm', null, PARAM_INT);
 139
 140         if (isset($confirm) && confirm_sesskey()) {
 141             $sessionsids = required_param('sessionsids', PARAM_ALPHANUMEXT);
 142             $sessionsids = explode('_', $sessionsids);
 143
 144             $att->delete_sessions($sessionsids);
 145             if ($att->grade > 0) {
 146                 attendance_update_all_users_grades($att, $cm);
 147             }
 148             redirect($att->url_manage(), get_string('sessiondeleted', 'attendance'));
 149         }
 150         $sessid = optional_param_array('sessid', '', PARAM_SEQUENCE);
 151         if (empty($sessid)) {
 152             print_error('nosessionsselected', 'attendance', $att->url_manage());
 153         }
 154         $sessionsinfo = $att->get_sessions_info($sessid);
 155
 156         $message = get_string('deletecheckfull', '', get_string('session', 'attendance'));
 157         $message .= html_writer::empty_tag('br');
 158         foreach ($sessionsinfo as $sessinfo) {
 159             $message .= html_writer::empty_tag('br');
 160             $message .= userdate($sessinfo->sessdate, get_string('strftimedmyhm', 'attendance'));
 161             $message .= html_writer::empty_tag('br');
 162             $message .= $sessinfo->description;
 163         }
 164
 165         $sessionsids = implode('_', $sessid);
 166         $params = array('action' => $att->pageparams->action, 'sessionsids' => $sessionsids,
 167                         'confirm' => 1, 'sesskey' => sesskey());
 168
 169         echo $OUTPUT->header();
 170         echo $OUTPUT->heading(get_string('attendanceforthecourse', 'attendance').' :: ' .format_string($course->fullname));
 171         echo $OUTPUT->confirm($message, $att->url_sessions($params), $att->url_manage());
 172         echo $OUTPUT->footer();
 173         exit;
 174     case mod_attendance_sessions_page_params::ACTION_CHANGE_DURATION:
 175         $sessid = optional_param_array('sessid', '', PARAM_SEQUENCE);
 176         $ids = optional_param('ids', '', PARAM_ALPHANUMEXT);
 177
 178         $slist = !empty($sessid) ? implode('_', $sessid) : '';
 179
 180         $url = $att->url_sessions(array('action' => mod_attendance_sessions_page_params::ACTION_CHANGE_DURATION));
 181         $formparams['ids'] = $slist;
 182         $mform = new mod_attendance_duration_form($url, $formparams);
 183
 184         if ($mform->is_cancelled()) {
 185             redirect($att->url_manage());
 186         }
 187
 188         if ($formdata = $mform->get_data()) {
 189             $sessionsids = explode('_', $ids);
 190             $duration = $formdata->durtime['hours'] * HOURSECS + $formdata->durtime['minutes'] * MINSECS;
 191             $att->update_sessions_duration($sessionsids, $duration);
 192             redirect($att->url_manage(), get_string('sessionupdated', 'attendance'));
 193         }
 194
 195         if ($slist === '') {
 196             print_error('nosessionsselected', 'attendance', $att->url_manage());
 197         }
 198
 199         break;
 200     case mod_attendance_sessions_page_params::ACTION_DELETE_HIDDEN:
 201         $confirm  = optional_param('confirm', null, PARAM_INT);
 202         if ($confirm && confirm_sesskey()) {
 203             $sessions = $att->get_hidden_sessions();
 204             $att->delete_sessions(array_keys($sessions));
 205             redirect($att->url_manage(), get_string('hiddensessionsdeleted', 'attendance'));
 206         }
 207
 208         $a = new stdClass();
 209         $a->count = $att->get_hidden_sessions_count();
 210         $a->date = userdate($course->startdate);
 211         $message = get_string('confirmdeletehiddensessions', 'attendance', $a);
 212
 213         $params = array('action' => $att->pageparams->action, 'confirm' => 1, 'sesskey' => sesskey());
 214         echo $OUTPUT->header();
 215         echo $OUTPUT->heading(get_string('attendanceforthecourse', 'attendance').' :: ' .format_string($course->fullname));
 216         echo $OUTPUT->confirm($message, $att->url_sessions($params), $att->url_manage());
 217         echo $OUTPUT->footer();
 218         exit;
 219 }
 220
 221 $output = $PAGE->get_renderer('mod_attendance');
 222 $tabs = new attendance_tabs($att, $currenttab);
 223 echo $output->header();
 224 echo $output->heading(get_string('attendanceforthecourse', 'attendance').' :: ' .format_string($course->fullname));
 225 echo $output->render($tabs);
 226
 227 $mform->display();
 228
 229 echo $OUTPUT->footer();
 230
 231 function construct_sessions_data_for_add($formdata) {
 232     global $CFG;
 233
 234     $sesstarttime = $formdata->sestime['starthour'] * HOURSECS + $formdata->sestime['startminute'] * MINSECS;
 235     $sesendtime = $formdata->sestime['endhour'] * HOURSECS + $formdata->sestime['endminute'] * MINSECS;
 236     $sessiondate = $formdata->sessiondate + $sesstarttime;
 237     $duration = $sesendtime - $sesstarttime;
 238     $now = time();
 239
 240     if (empty(get_config('attendance', 'studentscanmark'))) {
 241         $formdata->studentscanmark = 0;
 242     }
 243
 244     $sessions = array();
 245     if (isset($formdata->addmultiply)) {
 246         $startdate = $sessiondate;
 247         $enddate = $formdata->sessionenddate + DAYSECS; // Because enddate in 0:0am.
 248
 249         if ($enddate < $startdate) {
 250             return null;
 251         }
 252
 253         // Getting first day of week.
 254         $sdate = $startdate;
 255         $dinfo = usergetdate($sdate);
 256         if ($CFG->calendar_startwday === '0') { // Week start from sunday.
 257             $startweek = $startdate - $dinfo['wday'] * DAYSECS; // Call new variable.
 258         } else {
 259             $wday = $dinfo['wday'] === 0 ? 7 : $dinfo['wday'];
 260             $startweek = $startdate - ($wday - 1) * DAYSECS;
 261         }
 262
 263         $wdaydesc = array(0 => 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat');
 264
 265         while ($sdate < $enddate) {
 266             if ($sdate < $startweek + WEEKSECS) {
 267                 $dinfo = usergetdate($sdate);
 268                 if (isset($formdata->sdays) && array_key_exists($wdaydesc[$dinfo['wday']], $formdata->sdays)) {
 269                     $sess = new stdClass();
 270                     $sess->sessdate = make_timestamp($dinfo['year'], $dinfo['mon'], $dinfo['mday'],
 271                                                      $formdata->sestime['starthour'], $formdata->sestime['startminute']);
 272                     $sess->duration = $duration;
 273                     $sess->descriptionitemid = $formdata->sdescription['itemid'];
 274                     $sess->description = $formdata->sdescription['text'];
 275                     $sess->descriptionformat = $formdata->sdescription['format'];
 276                     $sess->timemodified = $now;
 277                     if (isset($formdata->studentscanmark)) { // Students will be able to mark their own attendance.
 278                         $sess->studentscanmark = 1;
 279                     }
 280                     $sess->statusset = $formdata->statusset;
 281
 282                     fill_groupid($formdata, $sessions, $sess);
 283                 }
 284                 $sdate += DAYSECS;
 285             } else {
 286                 $startweek += WEEKSECS * $formdata->period;
 287                 $sdate = $startweek;
 288             }
 289         }
 290     } else {
 291         $sess = new stdClass();
 292         $sess->sessdate = $sessiondate;
 293         $sess->duration = $duration;
 294         $sess->descriptionitemid = $formdata->sdescription['itemid'];
 295         $sess->description = $formdata->sdescription['text'];
 296         $sess->descriptionformat = $formdata->sdescription['format'];
 297         $sess->timemodified = $now;
 298         if (isset($formdata->studentscanmark)) { // Students will be able to mark their own attendance.
 299             $sess->studentscanmark = 1;
 300         }
 301         $sess->statusset = $formdata->statusset;
 302
 303         fill_groupid($formdata, $sessions, $sess);
 304     }
 305
 306     return $sessions;
 307 }
 308
 309 function fill_groupid($formdata, &$sessions, $sess) {
 310     if ($formdata->sessiontype == mod_attendance_structure::SESSION_COMMON) {
 311         $sess = clone $sess;
 312         $sess->groupid = 0;
 313         $sessions[] = $sess;
 314     } else {
 315         foreach ($formdata->groups as $groupid) {
 316             $sess = clone $sess;
 317             $sess->groupid = $groupid;
 318             $sessions[] = $sess;
 319         }
 320     }
 321 }