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 require_once($CFG->dirroot.'/group/lib.php');
  26
  27 /**
  28 * enrolment_plugin_manual is the default enrolment plugin
  29 *
  30 * This class provides all the functionality for an enrolment plugin
  31 * In fact it includes all the code for the default, "manual" method
  32 * so that other plugins can override these as necessary.
  33 */
  34
  35 class enrolment_plugin_manual {
  36
  37 var $errormsg;
  38
  39 /**
  40 * Prints the entry form/page for this enrolment
  41 *
  42 * This is only called from course/enrol.php
  43 * Most plugins will probably override this to print payment
  44 * forms etc, or even just a notice to say that manual enrolment
  45 * is disabled
  46 *
  47 * @param    course  current course object
  48 */
  49 function print_entry($course) {
  50     global $CFG, $USER, $SESSION, $THEME;
  51
  52     $strloginto = get_string('loginto', '', $course->shortname);
  53     $strcourses = get_string('courses');
  54
  55 /// Automatically enrol into courses without password
  56
  57     $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
  58
  59     $navlinks = array();
  60     $navlinks[] = array('name' => $strcourses, 'link' => ".", 'type' => 'misc');
  61     $navlinks[] = array('name' => $strloginto, 'link' => null, 'type' => 'misc');
  62     $navigation = build_navigation($navlinks);
  63
  64     if ($course->password == '') {   // no password, so enrol
  65
  66         if (has_capability('moodle/legacy:guest', $context, $USER->id, false)) {
  67             add_to_log($course->id, 'course', 'guest', 'view.php?id='.$course->id, getremoteaddr());
  68
  69         } else if (empty($_GET['confirm']) && empty($_GET['cancel'])) {
  70
  71             print_header($strloginto, $course->fullname, $navigation);
  72             echo '<br />';
  73             notice_yesno(get_string('enrolmentconfirmation'), "enrol.php?id=$course->id&amp;confirm=1",
  74                                                               "enrol.php?id=$course->id&amp;cancel=1");
  75             print_footer();
  76             exit;
  77
  78         } else if (!empty($_GET['confirm'])) {
  79
  80             if (!enrol_into_course($course, $USER, 'manual')) {
  81                 print_error('couldnotassignrole');
  82             }
  83             // force a refresh of mycourses
  84             unset($USER->mycourses);
  85
  86             if (!empty($SESSION->wantsurl)) {
  87                 $destination = $SESSION->wantsurl;
  88                 unset($SESSION->wantsurl);
  89             } else {
  90                 $destination = "$CFG->wwwroot/course/view.php?id=$course->id";
  91             }
  92
  93             redirect($destination);
  94
  95         } else if (!empty($_GET['cancel'])) {
  96             unset($SESSION->wantsurl);
  97             if (!empty($SESSION->enrolcancel)) {
  98                 $destination = $SESSION->enrolcancel;
  99                 unset($SESSION->enrolcancel);
 100             } else {
 101                 $destination = $CFG->wwwroot;
 102             }
 103             redirect($destination);
 104         }
 105     }
 106
 107     // if we get here we are going to display the form asking for the enrolment key
 108     // and (hopefully) provide information about who to ask for it.
 109     if (!isset($password)) {
 110         $password = '';
 111     }
 112
 113     print_header($strloginto, $course->fullname, $navigation, "form.password");
 114
 115     print_course($course, "80%");
 116
 117     include("$CFG->dirroot/enrol/manual/enrol.html");
 118
 119     print_footer();
 120
 121 }
 122
 123
 124
 125 /**
 126 * The other half to print_entry, this checks the form data
 127 *
 128 * This function checks that the user has completed the task on the
 129 * enrolment entry page and then enrolls them.
 130 *
 131 * @param    form    the form data submitted, as an object
 132 * @param    course  the current course, as an object
 133 */
 134 function check_entry($form, $course) {
 135     global $CFG, $USER, $SESSION, $THEME;
 136
 137     if (empty($form->password)) {
 138         $form->password = '';
 139     }
 140
 141     if (empty($course->password)) {
 142         // do not allow entry when no course password set
 143         // automatic login when manual primary, no login when secondary at all!!
 144         error('illegal enrolment attempted');
 145     }
 146
 147     $groupid = $this->check_group_entry($course->id, $form->password);
 148
 149     if ((stripslashes($form->password) == $course->password) or ($groupid !== false) ) {
 150
 151         if (isguestuser()) { // only real user guest, do not use this for users with guest role
 152             $USER->enrolkey[$course->id] = true;
 153             add_to_log($course->id, 'course', 'guest', 'view.php?id='.$course->id, getremoteaddr());
 154
 155         } else {  /// Update or add new enrolment
 156             if (enrol_into_course($course, $USER, 'manual')) {
 157                 // force a refresh of mycourses
 158                 unset($USER->mycourses);
 159                 if ($groupid !== false) {
 160                     if (!groups_add_member($groupid, $USER->id)) {
 161                         print_error('couldnotassigngroup');
 162                     }
 163                 }
 164             } else {
 165                 print_error('couldnotassignrole');
 166             }
 167         }
 168
 169         if ($SESSION->wantsurl) {
 170             $destination = $SESSION->wantsurl;
 171             unset($SESSION->wantsurl);
 172         } else {
 173             $destination = "$CFG->wwwroot/course/view.php?id=$course->id";
 174         }
 175
 176         redirect($destination);
 177
 178     } else {
 179         $this->errormsg = get_string('enrolmentkeyhint', '', substr($course->password,0,1));
 180     }
 181 }
 182
 183
 184 /**
 185 * Check if the given enrolment key matches a group enrolment key for the given course
 186 *
 187 * @param    courseid  the current course id
 188 * @param    password  the submitted enrolment key
 189 */
 190 function check_group_entry ($courseid, $password) {
 191
 192     if ($groups = groups_get_all_groups($courseid)) {
 193         foreach ($groups as $group) {
 194             if ( !empty($group->enrolmentkey) and (stripslashes($password) == $group->enrolmentkey) ) {
 195                 return $group->id;
 196             }
 197         }
 198     }
 199
 200     return false;
 201 }
 202
 203
 204 /**
 205 * Prints a form for configuring the current enrolment plugin
 206 *
 207 * This function is called from admin/enrol.php, and outputs a
 208 * full page with a form for defining the current enrolment plugin.
 209 *
 210 * @param    frm  an object containing all the data for this page
 211 */
 212 function config_form($frm) {
 213     global $CFG;
 214
 215     if (!isset( $frm->enrol_manual_keyholderrole )) {
 216         $frm->enrol_manual_keyholderrole = '';
 217     }
 218
 219     include ("$CFG->dirroot/enrol/manual/config.html");
 220 }
 221
 222
 223 /**
 224 * Processes and stored configuration data for the enrolment plugin
 225 *
 226 * @param    config  all the configuration data as entered by the admin
 227 */
 228 function process_config($config) {
 229
 230     $return = true;
 231
 232     foreach ($config as $name => $value) {
 233         if (!set_config($name, $value)) {
 234             $return = false;
 235         }
 236     }
 237
 238     return $return;
 239 }
 240
 241
 242 /**
 243 * This function is run by admin/cron.php every time
 244 *
 245 * The cron function can perform regular checks for the current
 246 * enrollment plugin.  For example it can check a foreign database,
 247 * all look for a file to pull data in from
 248 *
 249 */
 250 function cron() {
 251     global $CFG;
 252
 253     // Notify users about enrolments that are going to expire soon!
 254
 255     if (empty($CFG->lastexpirynotify)) {
 256         $CFG->lastexpirynotify = 0;
 257     }
 258
 259     if ($CFG->lastexpirynotify < date('Ymd') &&
 260         ($courses = get_records_select('course', 'enrolperiod > 0 AND expirynotify > 0 AND expirythreshold > 0'))) {
 261
 262         $admin = get_admin();
 263
 264         $strexpirynotify = get_string('expirynotify');
 265         foreach ($courses as $course) {
 266             $a = new object();
 267             $a->coursename = $course->shortname .'/'. $course->fullname;
 268             $a->threshold = $course->expirythreshold / 86400;
 269             $a->extendurl = $CFG->wwwroot . '/user/index.php?id=' . $course->id;
 270             $a->current = array();
 271             $a->past = array();
 272             $a->current = $a->past = array();
 273             $expiry = time() + $course->expirythreshold;
 274
 275             /// Get all the role assignments for this course that have expired.
 276
 277             if (!$context = get_context_instance(CONTEXT_COURSE, $course->id)) {
 278                 continue;
 279             }
 280
 281             if ($oldenrolments = get_records_sql('
 282                       SELECT u.*
 283                         FROM '.$CFG->prefix.'role_assignments ra,
 284                              '.$CFG->prefix.'user u
 285                         WHERE ra.contextid = '.$context->id.'
 286                           AND ra.timeend > 0 AND ra.timeend <= '.$expiry.'
 287                           AND ra.userid = u.id ')) {
 288
 289
 290                 if (!$teacher = get_teacher($course->id)) {
 291                     $teacher = get_admin();
 292                 }
 293
 294                 $a->teacherstr = fullname($teacher, true);
 295
 296                 $strexpirynotifystudentsemail = get_string('expirynotifystudentsemail', '', $a);
 297
 298                 foreach ($oldenrolments as $user) {       /// Email all users about to expire
 299                     $a->studentstr = fullname($user, true);
 300                     if ($user->timeend < ($expiry - 86400)) {
 301                         $a->past[] = fullname($user) . " <$user->email>";
 302                     } else {
 303                         $a->current[] = fullname($user) . " <$user->email>";
 304                         if ($course->notifystudents) {     // Send this guy notice
 305                             email_to_user($user, $teacher, $SITE->fullname .' '. $strexpirynotify,
 306                                           $strexpirynotifystudentsemail);
 307                         }
 308                     }
 309                 }
 310
 311                 $a->current = implode("\n", $a->current);
 312                 $a->past = implode("\n", $a->past);
 313
 314                 $strexpirynotifyemail = get_string('expirynotifyemail', '', $a);
 315
 316                 if ($a->current || $a->past) {
 317                     if ($teachers = get_users_by_capability($context, 'moodle/course:update',
 318                                                             'u.*', 'u.username ASC',
 319                                                             '', '', '', '', false)) {
 320                         foreach ($teachers as $teacher) {
 321                             email_to_user($teacher, $admin, $a->coursename .' '. $strexpirynotify, $strexpirynotifyemail);
 322                         }
 323                     }
 324                 }
 325             }
 326             set_config('lastexpirynotify', date('Ymd'));
 327         }
 328     }
 329 }
 330
 331
 332 /**
 333 * Returns the relevant icons for a course
 334 *
 335 * @param    course  the current course, as an object
 336 */
 337 function get_access_icons($course) {
 338     global $CFG;
 339
 340     global $strallowguests;
 341     global $strrequireskey;
 342
 343     if (empty($strallowguests)) {
 344         $strallowguests = get_string('allowguests');
 345         $strrequireskey = get_string('requireskey');
 346     }
 347
 348     $str = '';
 349
 350     if (!empty($course->guest)) {
 351         $str .= '<a title="'.$strallowguests.'" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">';
 352         $str .= '<img class="accessicon" alt="'.$strallowguests.'" src="'.$CFG->pixpath.'/i/guest.gif" /></a>&nbsp;&nbsp;';
 353     }
 354     if (!empty($course->password)) {
 355         $str .= '<a title="'.$strrequireskey.'" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">';
 356         $str .= '<img class="accessicon" alt="'.$strrequireskey.'" src="'.$CFG->pixpath.'/i/key.gif" /></a>';
 357     }
 358
 359     return $str;
 360 }
 361
 362 /**
 363  * Prints the message telling you were to get the enrolment key
 364  * appropriate for the prevailing circumstances
 365  * A bit clunky because I didn't want to change the standard strings
 366  */
 367 function print_enrolmentkeyfrom($course) {
 368     global $CFG;
 369     global $USER;
 370
 371     $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 372     $guest = has_capability('moodle/legacy:guest', $context, $USER->id, false);
 373
 374     // if a keyholder role is defined we list teachers in that role (if any exist)
 375     $contactslisted = false;
 376     $canseehidden = has_capability('moodle/role:viewhiddenassigns', $context);
 377     if (!empty($CFG->enrol_manual_keyholderrole)) {
 378         if ($contacts = get_role_users($CFG->enrol_manual_keyholderrole, get_context_instance(CONTEXT_COURSE, $course->id),$canseehidden  )) {
 379             // guest user has a slightly different message
 380             if ($guest) {
 381                 print_string('enrolmentkeyfromguest', '', ':<br />' );
 382             }
 383             else {
 384                 print_string('enrolmentkeyfrom', '', ':<br />');
 385             }
 386             foreach ($contacts as $contact) {
 387                 $contactname = "<a href=\"../user/view.php?id=$contact->id&course=".SITEID."\">".fullname($contact)."</a>.";
 388                 echo "$contactname<br />";
 389             }
 390             $contactslisted = true;
 391         }
 392     }
 393
 394     // if no keyholder role is defined OR nobody is in that role we do this the 'old' way
 395     // (show the first person with update rights)
 396     if (!$contactslisted) {
 397         if ($teachers = get_users_by_capability(get_context_instance(CONTEXT_COURSE, $course->id), 'moodle/course:update',
 398             'u.*', 'u.id ASC', 0, 1, '', '', false, true)) {
 399             $teacher = array_shift($teachers);
 400         }
 401         if (!empty($teacher)) {
 402             $teachername = "<a href=\"../user/view.php?id=$teacher->id&course=".SITEID."\">".fullname($teacher)."</a>.";
 403         } else {
 404             $teachername = strtolower( get_string('defaultcourseteacher') ); //get_string('yourteacher', '', $course->teacher);
 405         }
 406
 407         // guest user has a slightly different message
 408         if ($guest) {
 409             print_string('enrolmentkeyfromguest', '', $teachername );
 410         }
 411         else {
 412             print_string('enrolmentkeyfrom', '', $teachername);
 413         }
 414     }
 415 }
 416
 417 } /// end of class
 418
 419 ?>