enrol/flatfile/enrol.php

   1 <?php
   2 require_once("$CFG->dirroot/enrol/enrol.class.php");
   3
   4 // The following flags are set in the configuration
   5 // $CFG->enrol_flatfilelocation:       where is the file we are looking for?
   6 // $CFG->enrol_allowinternal:          allow internal enrolment in courses
   7 // $CFG->enrol_emailstudents:          send email to students when they are enrolled in a course
   8 // $CFG->enrol_emailteachers:          send email to teachers when they are enrolled in a course
   9 // $CFG->enrol_emailadmins:            email the log from the cron job to the admin
  10
  11
  12
  13 class enrolment_plugin extends enrolment_base {
  14
  15     var $log;
  16
  17 /// Override the base print_entry() function
  18 function print_entry($course) {
  19     global $CFG;
  20
  21     if (! empty($CFG->enrol_allowinternal) ) {
  22         parent::print_entry($course);
  23     } else {
  24         print_header();
  25         notice(get_string("enrolmentnointernal"), $CFG->wwwroot);
  26     }
  27 }
  28
  29
  30 /// Override the base check_entry() function
  31 function check_entry($form, $course) {
  32     global $CFG;
  33
  34     if (! empty($CFG->enrol_allowinternal) ) {
  35         parent::check_entry($form, $course);
  36     }
  37 }
  38
  39
  40 /// Override the base config_form() function
  41 function config_form($frm) {
  42     global $CFG;
  43
  44     $vars = array('enrol_flatfilelocation', 'enrol_mailstudents', 'enrol_mailteachers', 'enrol_mailadmins');
  45     foreach ($vars as $var) {
  46         if (!isset($frm->$var)) {
  47             $frm->$var = '';
  48         }
  49     }
  50     include ("$CFG->dirroot/enrol/flatfile/config.html");
  51 }
  52
  53
  54 /// Override the base process_config() function
  55 function process_config($config) {
  56
  57     if (!isset($config->enrol_flatfilelocation)) {
  58         $config->enrol_flatfilelocation = '';
  59     }
  60     set_config('enrol_flatfilelocation', $config->enrol_flatfilelocation);
  61
  62     if (!isset($config->enrol_mailstudents)) {
  63         $config->enrol_mailstudents = '';
  64     }
  65     set_config('enrol_mailstudents', $config->enrol_mailstudents);
  66
  67     if (!isset($config->enrol_mailteachers)) {
  68         $config->enrol_mailteachers = '';
  69     }
  70     set_config('enrol_mailteachers', $config->enrol_mailteachers);
  71
  72     if (!isset($config->enrol_mailadmins)) {
  73         $config->enrol_mailadmins = '';
  74     }
  75     set_config('enrol_mailadmins', $config->enrol_mailadmins);
  76
  77     if (!isset($config->enrol_allowinternal)) {
  78         $config->enrol_allowinternal = '';
  79     }
  80     set_config('enrol_allowinternal', $config->enrol_allowinternal);
  81
  82     return true;
  83
  84 }
  85
  86 /**
  87 * Override the base cron() function to read in a file
  88 *
  89 * Comma separated file assumed to have four or six fields per line:
  90 *   operation, role, idnumber(user), idnumber(course) [, starttime, endtime]
  91 * where:
  92 *   operation        = add | del
  93 *   role             = student | teacher | teacheredit
  94 *   idnumber(user)   = idnumber in the user table NB not id
  95 *   idnumber(course) = idnumber in the course table NB not id
  96 *   starttime        = start time (in seconds since epoch) - optional
  97 *   endtime          = end time (in seconds since epoch) - optional
  98 */
  99     function cron() {
 100         global $CFG;
 101
 102         /// call the base class
 103         parent::cron();
 104
 105         if (empty($CFG->enrol_flatfilelocation)) {
 106             $filename = "$CFG->dataroot/1/enrolments.txt";  // Default location
 107         } else {
 108             $filename = $CFG->enrol_flatfilelocation;
 109         }
 110
 111         if ( file_exists($filename) ) {
 112
 113             $this->log  = userdate(time()) . "\n";
 114             $this->log .= "Flatfile enrol cron found file: $filename\n\n";
 115
 116             if (($fh = fopen($filename, "r")) != false) {
 117
 118                 $line = 0;
 119                 while (!feof($fh)) {
 120
 121                     $line++;
 122                     $fields = explode( ",", str_replace( "\r", "", fgets($fh) ) );
 123
 124
 125                 /// If a line is incorrectly formatted ie does not have 4 comma separated fields then ignore it
 126                     if (count($fields) != 4 and count($fields) !=6) {
 127                         if ( count($fields) > 1 or strlen($fields[0]) > 1) { // no error for blank lines
 128                             $this->log .= "$line: Line incorrectly formatted - ignoring\n";
 129                         }
 130                         continue;
 131                     }
 132
 133
 134                     $fields[0] = trim(strtolower($fields[0]));
 135                     $fields[1] = trim(strtolower($fields[1]));
 136                     $fields[2] = trim($fields[2]);
 137                     $fields[3] = trim($fields[3]);
 138
 139                     $this->log .= "$line: $fields[0] $fields[1] $fields[2] $fields[3] ";
 140
 141                     if (!empty($fields[5])) {
 142                         $fields[4] = (int)trim($fields[4]);
 143                         $fields[5] = (int)trim($fields[5]);
 144                         $this->log .= "$fields[4] $fields[5]";
 145                     } else {
 146                         $fields[4] = 0;
 147                         $fields[5] = 0;
 148                     }
 149
 150                     $this->log .= ":";
 151
 152
 153
 154                 /// check correct formatting of operation field
 155                     if ($fields[0] != "add" and $fields[0] != "del") {
 156                         $this->log .= "Unknown operation in field 1 - ignoring line\n";
 157                         continue;
 158                     }
 159
 160
 161                 /// check correct formatting of role field
 162                     if ($fields[1] != "student" and $fields[1] != "teacher" and $fields[1] != "teacheredit") {
 163                         $this->log .= "Unknown role in field2 - ignoring line\n";
 164                         continue;
 165                     }
 166
 167
 168                     if (! $user = get_record("user", "idnumber", $fields[2]) ) {
 169                         $this->log .= "Unknown user idnumber in field 3 - ignoring line\n";
 170                         continue;
 171                     }
 172
 173
 174                     if (! $course = get_record("course", "idnumber", $fields[3]) ) {
 175                         $this->log .= "Unknown course idnumber in field 4 - ignoring line\n";
 176                         continue;
 177                     }
 178
 179                     if ($fields[4] > $fields[5]) {
 180                         $this->log .= "Start time was later than end time - ignoring line\n";
 181                         continue;
 182                     }
 183
 184
 185                     unset($elog);
 186                     switch ($fields[1]) {
 187                         case "student":
 188                             if ($fields[0] == "add") {
 189                                 if (! enrol_student($user->id, $course->id, $fields[4], $fields[5], 'flatfile')) {
 190                                     $elog = "Error enrolling in course\n";
 191                                 }
 192                             } else {
 193                                 if (! unenrol_student($user->id, $course->id)) {
 194                                     $elog = "Error unenrolling from course\n";
 195                                 }
 196                             }
 197                             break;
 198
 199                         case "teacher":
 200                             if ($fields[0] == "add") {
 201                                 if (! add_teacher($user->id, $course->id, 0, '', $fields[4], $fields[5], 'flatfile')) {
 202                                     $elog = "Error adding teacher to course\n";
 203                                 }
 204                             } else {
 205                                 if (! remove_teacher($user->id, $course->id)) {
 206                                     $elog = "Error removing teacher from course\n";
 207                                 }
 208                             }
 209                             break;
 210
 211                         case "teacheredit":
 212                             if ($fields[0] == "add") {
 213                                 if (! add_teacher($user->id, $course->id, 1, '', $fields[4], $fields[5], 'flatfile')) {
 214                                     $elog = "Error adding teacher to course\n";
 215                                 }
 216                             } else {
 217                                 if (! remove_teacher($user->id, $course->id)) {
 218                                     $elog = "Error removing teacher from course\n";
 219                                 }
 220                             }
 221                             break;
 222
 223                         default: // should never get here as checks made above for correct values of $fields[1]
 224
 225                     } // end of switch
 226
 227
 228
 229                     if ( empty($elog) and ($fields[0] == "add") ) {
 230
 231                         if ($fields[1] == "student") {
 232                             if (! $teacher = get_teacher($course->id)) {
 233                                 $teacher = get_admin();
 234                             }
 235                         } else {
 236                             $teacher = get_admin();
 237                         }
 238
 239                         if (!empty($CFG->enrol_mailstudents)) {
 240                             $a->coursename = "$course->fullname";
 241                             $a->profileurl = "$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id";
 242                             email_to_user($user, $teacher, get_string("enrolmentnew", '', $course->shortname),
 243                                           get_string('welcometocoursetext', '', $a));
 244                         }
 245
 246                         if (!empty($CFG->enrol_mailteachers)) {
 247                             $a->course = "$course->fullname";
 248                             $a->user = fullname($user);
 249                             email_to_user($teacher, $user, get_string("enrolmentnew", '', $course->shortname),
 250                                           get_string('enrolmentnewuser', '', $a));
 251                         }
 252                     }
 253
 254
 255                     if (empty($elog)) {
 256                         $elog = "OK\n";
 257                     }
 258                     $this->log .= $elog;
 259
 260                 } // end of while loop
 261
 262             fclose($fh);
 263             } // end of if(file_open)
 264
 265             if(! @unlink($filename)) {
 266                 email_to_user(get_admin(), get_admin(), get_string("filelockedmailsubject", "enrol_flatfile"), get_string("filelockedmail", "enrol_flatfile", $filename));
 267                 $this->log .= "Error unlinking file $filename\n";
 268             }
 269
 270             if (!empty($CFG->enrol_mailadmins)) {
 271                 email_to_user(get_admin(), get_admin(), "Flatfile Enrolment Log", $this->log);
 272             }
 273
 274         } // end of if(file_exists)
 275
 276     } // end of function
 277
 278 } // end of class
 279
 280 ?>