enrol/manual/enrol.php

   1 <?php   /// $Id$
   2 ///////////////////////////////////////////////////////////////////////////
   3 //                                                                       //
   4 // NOTICE OF COPYRIGHT                                                   //
   5 //                                                                       //
   6 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   7 //          http://moodle.org                                            //
   8 //                                                                       //
   9 // Copyright (C) 2004  Martin Dougiamas  http://moodle.com               //
  10 //                                                                       //
  11 // This program is free software; you can redistribute it and/or modify  //
  12 // it under the terms of the GNU General Public License as published by  //
  13 // the Free Software Foundation; either version 2 of the License, or     //
  14 // (at your option) any later version.                                   //
  15 //                                                                       //
  16 // This program is distributed in the hope that it will be useful,       //
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  19 // GNU General Public License for more details:                          //
  20 //                                                                       //
  21 //          http://www.gnu.org/copyleft/gpl.html                         //
  22 //                                                                       //
  23 ///////////////////////////////////////////////////////////////////////////
  24
  25
  26 /**
  27 * enrolment_plugin_manual is the default enrolment plugin
  28 *
  29 * This class provides all the functionality for an enrolment plugin
  30 * In fact it includes all the code for the default, "manual" method
  31 * so that other plugins can override these as necessary.
  32 */
  33
  34 class enrolment_plugin_manual {
  35
  36 var $errormsg;
  37
  38 /**
  39 * Prints the entry form/page for this enrolment
  40 *
  41 * This is only called from course/enrol.php
  42 * Most plugins will probably override this to print payment
  43 * forms etc, or even just a notice to say that manual enrolment
  44 * is disabled
  45 *
  46 * @param    course  current course object
  47 */
  48 function print_entry($course) {
  49     global $CFG, $USER, $SESSION, $THEME;
  50
  51     $strloginto = get_string('loginto', '', $course->shortname);
  52     $strcourses = get_string('courses');
  53
  54 /// Automatically enrol into courses without password
  55
  56     $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
  57
  58     if ($course->password == '') {   // no password, so enrol
  59
  60         if (has_capability('moodle/legacy:guest', $context, $USER->id, false)) {
  61             add_to_log($course->id, 'course', 'guest', 'view.php?id='.$course->id, getremoteaddr());
  62
  63         } else if (empty($_GET['confirm']) && empty($_GET['cancel'])) {
  64
  65             print_header($strloginto, $course->fullname, "<a href=\".\">$strcourses</a> -> $strloginto");
  66             echo '<br />';
  67             notice_yesno(get_string('enrolmentconfirmation'), "enrol.php?id=$course->id&amp;confirm=1",
  68                                                               "enrol.php?id=$course->id&amp;cancel=1");
  69             print_footer();
  70             exit;
  71
  72         } else if (!empty($_GET['confirm'])) {
  73
  74             if (!enrol_into_course($course, $USER, 'manual')) {
  75                 print_error('couldnotassignrole');
  76             }
  77
  78             if (!empty($SESSION->wantsurl)) {
  79                 $destination = $SESSION->wantsurl;
  80                 unset($SESSION->wantsurl);
  81             } else {
  82                 $destination = "$CFG->wwwroot/course/view.php?id=$course->id";
  83             }
  84
  85             redirect($destination);
  86
  87         } else if (!empty($_GET['cancel'])) {
  88             unset($SESSION->wantsurl);
  89             if (!empty($SESSION->enrolcancel)) {
  90                 $destination = $SESSION->enrolcancel;
  91                 unset($SESSION->enrolcancel);
  92             } else {
  93                 $destination = $CFG->wwwroot;
  94             }
  95             redirect($destination);
  96         }
  97     }
  98
  99     $teacher = get_teacher($course->id);
 100     if (!isset($password)) {
 101         $password = '';
 102     }
 103
 104     print_header($strloginto, $course->fullname, "<a href=\".\">$strcourses</a> -> $strloginto", "form.password");
 105
 106     print_course($course, "80%");
 107
 108     include("$CFG->dirroot/enrol/manual/enrol.html");
 109
 110     print_footer();
 111
 112 }
 113
 114
 115
 116 /**
 117 * The other half to print_entry, this checks the form data
 118 *
 119 * This function checks that the user has completed the task on the
 120 * enrolment entry page and then enrolls them.
 121 *
 122 * @param    form    the form data submitted, as an object
 123 * @param    course  the current course, as an object
 124 */
 125 function check_entry($form, $course) {
 126     global $CFG, $USER, $SESSION, $THEME;
 127
 128     if (empty($form->password)) {
 129         $form->password = '';
 130     }
 131
 132     if (empty($course->password)) {
 133         // do not allow entry when no course password set
 134         // automatic login when manual primary, no login when secondary at all!!
 135         error('illegal enrolment attempted');
 136     }
 137
 138     $groupid = $this->check_group_entry($course->id, $form->password);
 139
 140     if (($form->password == $course->password) or ($groupid !== false) ) {
 141
 142         if ($USER->username == 'guest') { // only real user guest, do not use this for users with guest role
 143             $USER->enrolkey[$course->id] = true;
 144             add_to_log($course->id, 'course', 'guest', 'view.php?id='.$course->id, getremoteaddr());
 145
 146         } else {  /// Update or add new enrolment
 147             if (enrol_into_course($course, $USER, 'manual')) {
 148                 if ($groupid !== false) {
 149                     if (!add_user_to_group($groupid, $USER->id)) {
 150                         print_error('couldnotassigngroup');
 151                     }
 152                 }
 153             } else {
 154                 print_error('couldnotassignrole');
 155             }
 156         }
 157
 158         if ($SESSION->wantsurl) {
 159             $destination = $SESSION->wantsurl;
 160             unset($SESSION->wantsurl);
 161         } else {
 162             $destination = "$CFG->wwwroot/course/view.php?id=$course->id";
 163         }
 164
 165         redirect($destination);
 166
 167     } else {
 168         $this->errormsg = get_string('enrolmentkeyhint', '', substr($course->password,0,1));
 169     }
 170 }
 171
 172
 173 /**
 174 * Check if the given enrolment key matches a group enrolment key for the given course
 175 *
 176 * @param    courseid  the current course id
 177 * @param    password  the submitted enrolment key
 178 */
 179 function check_group_entry ($courseid, $password) {
 180     $ingroup = false;
 181
 182     if (($groups = get_groups($courseid)) !== false) {
 183         foreach ($groups as $group) {
 184             if ( !empty($group->password) and ($password == $group->password) ) {
 185                 $ingroup = $group->id;
 186             }
 187         }
 188     }
 189     return $ingroup;
 190 }
 191
 192
 193 /**
 194 * Prints a form for configuring the current enrolment plugin
 195 *
 196 * This function is called from admin/enrol.php, and outputs a
 197 * full page with a form for defining the current enrolment plugin.
 198 *
 199 * @param    page  an object containing all the data for this page
 200 */
 201 function config_form($page) {
 202
 203 }
 204
 205
 206 /**
 207 * Processes and stored configuration data for the enrolment plugin
 208 *
 209 * @param    config  all the configuration data as entered by the admin
 210 */
 211 function process_config($config) {
 212
 213     $return = true;
 214
 215     foreach ($config as $name => $value) {
 216         if (!set_config($name, $value)) {
 217             $return = false;
 218         }
 219     }
 220
 221     return $return;
 222 }
 223
 224
 225 /**
 226 * This function is run by admin/cron.php every time
 227 *
 228 * The cron function can perform regular checks for the current
 229 * enrollment plugin.  For example it can check a foreign database,
 230 * all look for a file to pull data in from
 231 *
 232 */
 233 function cron() {
 234     global $CFG;
 235
 236
 237     // Delete all assignments from the database that have already expired
 238
 239     $timenow = time();
 240
 241     if ($assignments = get_records_sql("SELECT ra.*, c.instanceid as courseid FROM
 242                                           {$CFG->prefix}role_assignments ra,
 243                                           {$CFG->prefix}context c
 244                                          WHERE ra.enrol = 'manual'
 245                                            AND ra.timeend > 0
 246                                            AND ra.timeend < $timenow
 247                                            AND ra.contextid = c.id
 248                                            AND c.contextlevel = ".CONTEXT_COURSE)) {
 249         foreach ($assignments as $assignment) {
 250             if ($course = get_record('course', 'id', $assignment->courseid)) {
 251                 if (empty($course->enrolperiod)) {   // This overrides student timeend
 252                     continue;
 253                 }
 254             }
 255             role_unassign($assignment->roleid, $assignment->userid, 0, $assignment->contextid);
 256         }
 257     }
 258
 259
 260
 261     // Notify users about enrolments that are going to expire soon!
 262
 263     if (empty($CFG->lastexpirynotify)) {
 264         $CFG->lastexpirynotify = 0;
 265     }
 266
 267     if ($CFG->lastexpirynotify < date('Ymd') &&
 268         ($courses = get_records_select('course', 'enrolperiod > 0 AND expirynotify > 0 AND expirythreshold > 0'))) {
 269
 270         $admin = get_admin();
 271
 272         $strexpirynotify = get_string('expirynotify');
 273         foreach ($courses as $course) {
 274             $a = new object;
 275             $a->coursename = $course->shortname .'/'. $course->fullname;
 276             $a->threshold = $course->expirythreshold / 86400;
 277             $a->extendurl = $CFG->wwwroot . '/user/index.php?id=' . $course->id;
 278             $a->current = array();
 279             $a->past = array();
 280             $a->current = $a->past = array();
 281             $expiry = time() + $course->expirythreshold;
 282
 283             /// Get all the role assignments for this course that have expired.
 284
 285             if (!$context = get_context_instance(CONTEXT_COURSE, $course->id)) {
 286                 continue;
 287             }
 288
 289             if ($oldenrolments = get_records_sql('
 290                       SELECT u.*
 291                         FROM '.$CFG->prefix.'role_assignments ra,
 292                              '.$CFG->prefix.'user u
 293                         WHERE ra.contextid = '.$context->id.'
 294                           AND ra.timeend > 0 AND ra.timeend <= '.$expiry.'
 295                           AND ra.userid = u.id ')) {
 296
 297
 298                 if (!$teacher = get_teacher($course->id)) {
 299                     $teacher = get_admin();
 300                 }
 301
 302                 $a->studentstr = fullname($user, true);
 303                 $a->teacherstr = fullname($teacher, true);
 304
 305                 $strexpirynotifystudentsemail = get_string('expirynotifystudentsemail', '', $a);
 306
 307                 foreach ($oldenrolments as $user) {       /// Email all users about to expire
 308                     if ($user->timeend < ($expiry - 86400)) {
 309                         $a->past[] = fullname($user) . " <$user->email>";
 310                     } else {
 311                         $a->current[] = fullname($user) . " <$user->email>";
 312                         if ($course->notifystudents) {     // Send this guy notice
 313                             email_to_user($student, $teacher, $SITE->fullname .' '. $strexpirynotify,
 314                                           $strexpirynotifystudentsemail);
 315                         }
 316                     }
 317                 }
 318
 319                 $a->current = implode("\n", $a->current);
 320                 $a->past = implode("\n", $a->past);
 321
 322                 $strexpirynotifyemail = get_string('expirynotifyemail', '', $a);
 323
 324                 if ($a->current || $a->past) {
 325                     if ($teachers = get_users_by_capability($context, 'moodle/course:update',
 326                                                             'u.*,ra.hidden', 'r.sortorder ASC',
 327                                                             '', '', '', '', false)) {
 328                         foreach ($teachers as $teacher) {
 329                             email_to_user($teacher, $admin, $a->coursename .' '. $strexpirynotify, $strexpirynotifyemail);
 330                         }
 331                     }
 332                 }
 333             }
 334             set_config('lastexpirynotify', date('Ymd'));
 335         }
 336     }
 337 }
 338
 339
 340 /**
 341 * Returns the relevant icons for a course
 342 *
 343 * @param    course  the current course, as an object
 344 */
 345 function get_access_icons($course) {
 346     global $CFG;
 347
 348     global $strallowguests;
 349     global $strrequireskey;
 350
 351     if (empty($strallowguests)) {
 352         $strallowguests = get_string('allowguests');
 353         $strrequireskey = get_string('requireskey');
 354     }
 355
 356     $str = '';
 357
 358     if (!empty($course->guest)) {
 359         $str .= '<a title="'.$strallowguests.'" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">';
 360         $str .= '<img class="accessicon" alt="'.$strallowguests.'" src="'.$CFG->pixpath.'/i/guest.gif" /></a>&nbsp;&nbsp;';
 361     }
 362     if (!empty($course->password)) {
 363         $str .= '<a title="'.$strrequireskey.'" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">';
 364         $str .= '<img class="accessicon" alt="'.$strrequireskey.'" src="'.$CFG->pixpath.'/i/key.gif" /></a>';
 365     }
 366
 367     return $str;
 368 }
 369
 370
 371 } /// end of class
 372
 373 ?>