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