enrol/imsenterprise/lib.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  * IMS Enterprise file enrolment plugin.
  19  *
  20  * This plugin lets the user specify an IMS Enterprise file to be processed.
  21  * The IMS Enterprise file is mainly parsed on a regular cron,
  22  * but can also be imported via the UI (Admin Settings).
  23  * @package    enrol
  24  * @subpackage imsenterprise
  25  * @copyright  2010 Eugene Venter
  26  * @author     Eugene Venter - based on code by Dan Stowell
  27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28  */
  29
  30 defined('MOODLE_INTERNAL') || die();
  31
  32 /*
  33
  34 Note for programmers:
  35
  36 This class uses regular expressions to mine the data file. The main reason is
  37 that XML handling changes from PHP 4 to PHP 5, so this should work on both.
  38
  39 One drawback is that the pattern-matching doesn't (currently) handle XML
  40 namespaces - it only copes with a <group> tag if it says <group>, and not
  41 (for example) <ims:group>.
  42
  43 This should also be able to handle VERY LARGE FILES - so the entire IMS file is
  44 NOT loaded into memory at once. It's handled line-by-line, 'forgetting' tags as
  45 soon as they are processed.
  46
  47 N.B. The "sourcedid" ID code is translated to Moodle's "idnumber" field, both
  48 for users and for courses.
  49
  50 */
  51
  52 require_once($CFG->dirroot.'/group/lib.php');
  53
  54
  55 class enrol_imsenterprise_plugin extends enrol_plugin {
  56
  57 var $log;
  58
  59
  60 /**
  61 * Read in an IMS Enterprise file.
  62 * Originally designed to handle v1.1 files but should be able to handle
  63 * earlier types as well, I believe.
  64 *
  65 */
  66 function cron() {
  67     global $CFG;
  68
  69     // Get configs
  70     $imsfilelocation    = $this->get_config('imsfilelocation');
  71     $logtolocation      = $this->get_config('logtolocation');
  72     $mailadmins         = $this->get_config('mailadmins');
  73     $prev_time          = $this->get_config('prev_time');
  74     $prev_md5           = $this->get_config('prev_md5');
  75     $prev_path          = $this->get_config('prev_path');
  76
  77     if (empty($imsfilelocation)) {
  78         // $filename = "$CFG->dirroot/enrol/imsenterprise/example.xml";  // Default location
  79         $filename = "$CFG->dataroot/1/imsenterprise-enrol.xml";  // Default location
  80     } else {
  81         $filename = $imsfilelocation;
  82     }
  83
  84     $this->logfp = false; // File pointer for writing log data to
  85     if(!empty($logtolocation)) {
  86         $this->logfp = fopen($logtolocation, 'a');
  87     }
  88
  89     if ( file_exists($filename) ) {
  90         @set_time_limit(0);
  91         $starttime = time();
  92
  93         $this->log_line('----------------------------------------------------------------------');
  94         $this->log_line("IMS Enterprise enrol cron process launched at " . userdate(time()));
  95         $this->log_line('Found file '.$filename);
  96         $this->xmlcache = '';
  97
  98         // Make sure we understand how to map the IMS-E roles to Moodle roles
  99         $this->load_role_mappings();
 100
 101         $md5 = md5_file($filename); // NB We'll write this value back to the database at the end of the cron
 102         $filemtime = filemtime($filename);
 103
 104         // Decide if we want to process the file (based on filepath, modification time, and MD5 hash)
 105         // This is so we avoid wasting the server's efforts processing a file unnecessarily
 106         if(empty($prev_path)  || ($filename != $prev_path)) {
 107             $fileisnew = true;
 108         } elseif(isset($prev_time) && ($filemtime <= $prev_time)) {
 109             $fileisnew = false;
 110             $this->log_line('File modification time is not more recent than last update - skipping processing.');
 111         } elseif(isset($prev_md5) && ($md5 == $prev_md5)) {
 112             $fileisnew = false;
 113             $this->log_line('File MD5 hash is same as on last update - skipping processing.');
 114         } else {
 115             $fileisnew = true; // Let's process it!
 116         }
 117
 118         if($fileisnew) {
 119
 120             $listoftags = array('group', 'person', 'member', 'membership', 'comments', 'properties'); // The list of tags which should trigger action (even if only cache trimming)
 121             $this->continueprocessing = true; // The <properties> tag is allowed to halt processing if we're demanding a matching target
 122
 123             // FIRST PASS: Run through the file and process the group/person entries
 124             if (($fh = fopen($filename, "r")) != false) {
 125
 126                 $line = 0;
 127                 while ((!feof($fh)) && $this->continueprocessing) {
 128
 129                     $line++;
 130                     $curline = fgets($fh);
 131                     $this->xmlcache .= $curline; // Add a line onto the XML cache
 132
 133                     while (true) {
 134                       // If we've got a full tag (i.e. the most recent line has closed the tag) then process-it-and-forget-it.
 135                       // Must always make sure to remove tags from cache so they don't clog up our memory
 136                       if($tagcontents = $this->full_tag_found_in_cache('group', $curline)) {
 137                           $this->process_group_tag($tagcontents);
 138                           $this->remove_tag_from_cache('group');
 139                       } elseif($tagcontents = $this->full_tag_found_in_cache('person', $curline)) {
 140                           $this->process_person_tag($tagcontents);
 141                           $this->remove_tag_from_cache('person');
 142                       } elseif($tagcontents = $this->full_tag_found_in_cache('membership', $curline)) {
 143                           $this->process_membership_tag($tagcontents);
 144                           $this->remove_tag_from_cache('membership');
 145                       } elseif($tagcontents = $this->full_tag_found_in_cache('comments', $curline)) {
 146                           $this->remove_tag_from_cache('comments');
 147                       } elseif($tagcontents = $this->full_tag_found_in_cache('properties', $curline)) {
 148                           $this->process_properties_tag($tagcontents);
 149                           $this->remove_tag_from_cache('properties');
 150                       } else {
 151                           break;
 152                       }
 153                     } // End of while-tags-are-detected
 154                 } // end of while loop
 155                 fclose($fh);
 156                 fix_course_sortorder();
 157             } // end of if(file_open) for first pass
 158
 159             /*
 160
 161
 162             SECOND PASS REMOVED
 163             Since the IMS specification v1.1 insists that "memberships" should come last,
 164             and since vendors seem to have done this anyway (even with 1.0),
 165             we can sensibly perform the import in one fell swoop.
 166
 167
 168             // SECOND PASS: Now go through the file and process the membership entries
 169             $this->xmlcache = '';
 170             if (($fh = fopen($filename, "r")) != false) {
 171                 $line = 0;
 172                 while ((!feof($fh)) && $this->continueprocessing) {
 173                     $line++;
 174                     $curline = fgets($fh);
 175                     $this->xmlcache .= $curline; // Add a line onto the XML cache
 176
 177                     while(true){
 178                   // Must always make sure to remove tags from cache so they don't clog up our memory
 179                   if($tagcontents = $this->full_tag_found_in_cache('group', $curline)){
 180                           $this->remove_tag_from_cache('group');
 181                       }elseif($tagcontents = $this->full_tag_found_in_cache('person', $curline)){
 182                           $this->remove_tag_from_cache('person');
 183                       }elseif($tagcontents = $this->full_tag_found_in_cache('membership', $curline)){
 184                           $this->process_membership_tag($tagcontents);
 185                           $this->remove_tag_from_cache('membership');
 186                       }elseif($tagcontents = $this->full_tag_found_in_cache('comments', $curline)){
 187                           $this->remove_tag_from_cache('comments');
 188                       }elseif($tagcontents = $this->full_tag_found_in_cache('properties', $curline)){
 189                           $this->remove_tag_from_cache('properties');
 190                       }else{
 191                     break;
 192                   }
 193                 }
 194                 } // end of while loop
 195                 fclose($fh);
 196             } // end of if(file_open) for second pass
 197
 198
 199            */
 200
 201             $timeelapsed = time() - $starttime;
 202             $this->log_line('Process has completed. Time taken: '.$timeelapsed.' seconds.');
 203
 204
 205         } // END of "if file is new"
 206
 207
 208         // These variables are stored so we can compare them against the IMS file, next time round.
 209         $this->set_config('prev_time', $filemtime);
 210         $this->set_config('prev_md5',  $md5);
 211         $this->set_config('prev_path', $filename);
 212
 213
 214
 215     }else{ // end of if(file_exists)
 216         $this->log_line('File not found: '.$filename);
 217     }
 218
 219     if (!empty($mailadmins)) {
 220         $msg = "An IMS enrolment has been carried out within Moodle.\nTime taken: $timeelapsed seconds.\n\n";
 221         if(!empty($logtolocation)){
 222             if($this->logfp){
 223                 $msg .= "Log data has been written to:\n";
 224                 $msg .= "$logtolocation\n";
 225                 $msg .= "(Log file size: ".ceil(filesize($logtolocation)/1024)."Kb)\n\n";
 226             }else{
 227                 $msg .= "The log file appears not to have been successfully written.\nCheck that the file is writeable by the server:\n";
 228                 $msg .= "$logtolocation\n\n";
 229             }
 230         }else{
 231             $msg .= "Logging is currently not active.";
 232         }
 233
 234         $eventdata = new object();
 235         $eventdata->modulename        = 'moodle';
 236         $eventdata->component         = 'imsenterprise';
 237         $eventdata->name              = 'imsenterprise_enrolment';
 238         $eventdata->userfrom          = get_admin();
 239         $eventdata->userto            = get_admin();
 240         $eventdata->subject           = "Moodle IMS Enterprise enrolment notification";
 241         $eventdata->fullmessage       = $msg;
 242         $eventdata->fullmessageformat = FORMAT_PLAIN;
 243         $eventdata->fullmessagehtml   = '';
 244         $eventdata->smallmessage      = '';
 245         message_send($eventdata);
 246
 247         $this->log_line('Notification email sent to administrator.');
 248
 249     }
 250
 251     if($this->logfp){
 252       fclose($this->logfp);
 253     }
 254
 255
 256 } // end of cron() function
 257
 258 /**
 259 * Check if a complete tag is found in the cached data, which usually happens
 260 * when the end of the tag has only just been loaded into the cache.
 261 * Returns either false, or the contents of the tag (including start and end).
 262 * @param string $tagname Name of tag to look for
 263 * @param string $latestline The very last line in the cache (used for speeding up the match)
 264 */
 265 function full_tag_found_in_cache($tagname, $latestline){ // Return entire element if found. Otherwise return false.
 266     if(strpos(strtolower($latestline), '</'.strtolower($tagname).'>')===false){
 267         return false;
 268     }elseif(preg_match('{(<'.$tagname.'\b.*?>.*?</'.$tagname.'>)}is', $this->xmlcache, $matches)){
 269         return $matches[1];
 270     }else return false;
 271 }
 272
 273 /**
 274 * Remove complete tag from the cached data (including all its contents) - so
 275 * that the cache doesn't grow to unmanageable size
 276 * @param string $tagname Name of tag to look for
 277 */
 278 function remove_tag_from_cache($tagname){ // Trim the cache so we're not in danger of running out of memory.
 279     ///echo "<p>remove_tag_from_cache: $tagname</p>";  flush();  ob_flush();
 280     //  echo "<p>remove_tag_from_cache:<br />".htmlspecialchars($this->xmlcache);
 281     $this->xmlcache = trim(preg_replace('{<'.$tagname.'\b.*?>.*?</'.$tagname.'>}is', '', $this->xmlcache, 1)); // "1" so that we replace only the FIRST instance
 282     //  echo "<br />".htmlspecialchars($this->xmlcache)."</p>";
 283 }
 284
 285 /**
 286 * Very simple convenience function to return the "recstatus" found in person/group/role tags.
 287 * 1=Add, 2=Update, 3=Delete, as specified by IMS, and we also use 0 to indicate "unspecified".
 288 * @param string $tagdata the tag XML data
 289 * @param string $tagname the name of the tag we're interested in
 290 */
 291 function get_recstatus($tagdata, $tagname){
 292     if(preg_match('{<'.$tagname.'\b[^>]*recstatus\s*=\s*["\'](\d)["\']}is', $tagdata, $matches)){
 293         // echo "<p>get_recstatus($tagname) found status of $matches[1]</p>";
 294         return intval($matches[1]);
 295     }else{
 296         // echo "<p>get_recstatus($tagname) found nothing</p>";
 297         return 0; // Unspecified
 298     }
 299 }
 300
 301 /**
 302 * Process the group tag. This defines a Moodle course.
 303 * @param string $tagconents The raw contents of the XML element
 304 */
 305 function process_group_tag($tagcontents){
 306     global $DB;
 307
 308     // Get configs
 309     $truncatecoursecodes    = $this->get_config('truncatecoursecodes');
 310     $createnewcourses       = $this->get_config('createnewcourses');
 311     $createnewcategories    = $this->get_config('createnewcategories');
 312
 313     // Process tag contents
 314     unset($group);
 315     if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)){
 316         $group->coursecode = trim($matches[1]);
 317     }
 318     if(preg_match('{<description>.*?<short>(.*?)</short>.*?</description>}is', $tagcontents, $matches)){
 319         $group->description = trim($matches[1]);
 320     }
 321     if(preg_match('{<org>.*?<orgunit>(.*?)</orgunit>.*?</org>}is', $tagcontents, $matches)){
 322         $group->category = trim($matches[1]);
 323     }
 324
 325     $recstatus = ($this->get_recstatus($tagcontents, 'group'));
 326     //echo "<p>get_recstatus for this group returned $recstatus</p>";
 327
 328     if(!(strlen($group->coursecode)>0)){
 329         $this->log_line('Error at line '.$line.': Unable to find course code in \'group\' element.');
 330     }else{
 331         // First, truncate the course code if desired
 332         if(intval($truncatecoursecodes)>0){
 333             $group->coursecode = ($truncatecoursecodes > 0)
 334                      ? substr($group->coursecode, 0, intval($truncatecoursecodes))
 335                      : $group->coursecode;
 336         }
 337
 338         /* -----------Course aliasing is DEACTIVATED until a more general method is in place---------------
 339
 340        // Second, look in the course alias table to see if the code should be translated to something else
 341         if($aliases = $DB->get_field('enrol_coursealias', 'toids', array('fromid'=>$group->coursecode))){
 342             $this->log_line("Found alias of course code: Translated $group->coursecode to $aliases");
 343             // Alias is allowed to be a comma-separated list, so let's split it
 344             $group->coursecode = explode(',', $aliases);
 345         }
 346        */
 347
 348         // For compatibility with the (currently inactive) course aliasing, we need this to be an array
 349         $group->coursecode = array($group->coursecode);
 350
 351         // Third, check if the course(s) exist
 352         foreach($group->coursecode as $coursecode){
 353             $coursecode = trim($coursecode);
 354             if(!$DB->get_field('course', 'id', array('idnumber'=>$coursecode))) {
 355               if(!$createnewcourses) {
 356                   $this->log_line("Course $coursecode not found in Moodle's course idnumbers.");
 357               } else {
 358                 // Create the (hidden) course(s) if not found
 359                 $course = new object();
 360                 $course->fullname = $group->description;
 361                 $course->shortname = $coursecode;
 362                 $course->idnumber = $coursecode;
 363                 $course->format = 'topics';
 364                 $course->visible = 0;
 365                 // Insert default names for teachers/students, from the current language
 366                 $site = get_site();
 367
 368                 // Handle course categorisation (taken from the group.org.orgunit field if present)
 369                 if(strlen($group->category)>0){
 370                     // If the category is defined and exists in Moodle, we want to store it in that one
 371                     if($catid = $DB->get_field('course_categories', 'id', array('name'=>$group->category))){
 372                         $course->category = $catid;
 373                     } elseif($createnewcategories) {
 374                         // Else if we're allowed to create new categories, let's create this one
 375                         $newcat->name = $group->category;
 376                        $newcat->visible = 0;
 377                        $catid = $DB->insert_record('course_categories', $newcat);
 378                        $course->category = $catid;
 379                        $this->log_line("Created new (hidden) category, #$catid: $newcat->name");
 380                     }else{
 381                         // If not found and not allowed to create, stick with default
 382                         $this->log_line('Category '.$group->category.' not found in Moodle database, so using default category instead.');
 383                         $course->category = 1;
 384                     }
 385                 }else{
 386                     $course->category = 1;
 387                 }
 388                 $course->timecreated = time();
 389                 $course->startdate = time();
 390                 $course->numsections = 1;
 391                 // Choose a sort order that puts us at the start of the list!
 392                 $course->sortorder = 0;
 393
 394                 $courseid = $DB->insert_record('course', $course);
 395
 396                 // Setup the blocks
 397                 $course = $DB->get_record('course', array('id' => $courseid));
 398                 blocks_add_default_course_blocks($course);
 399
 400                 $section = new object();
 401                 $section->course = $course->id;   // Create a default section.
 402                 $section->section = 0;
 403                 $section->summaryformat = FORMAT_HTML;
 404                 $section->id = $DB->insert_record("course_sections", $section);
 405
 406                 add_to_log(SITEID, "course", "new", "view.php?id=$course->id", "$course->fullname (ID $course->id)");
 407
 408                 $this->log_line("Created course $coursecode in Moodle (Moodle ID is $course->id)");
 409               }
 410             }elseif($recstatus==3 && ($courseid = $DB->get_field('course', 'id', array('idnumber'=>$coursecode)))){
 411                 // If course does exist, but recstatus==3 (delete), then set the course as hidden
 412                 $DB->set_field('course', 'visible', '0', array('id'=>$courseid));
 413             }
 414         } // End of foreach(coursecode)
 415     }
 416 } // End process_group_tag()
 417
 418 /**
 419 * Process the person tag. This defines a Moodle user.
 420 * @param string $tagconents The raw contents of the XML element
 421 */
 422 function process_person_tag($tagcontents){
 423     global $CFG, $DB;
 424
 425     // Get plugin configs
 426     $imssourcedidfallback   = $this->get_config('imssourcedidfallback');
 427     $fixcaseusernames       = $this->get_config('fixcaseusernames');
 428     $fixcasepersonalnames   = $this->get_config('fixcasepersonalnames');
 429     $imsdeleteusers         = $this->get_config('imsdeleteusers');
 430     $createnewusers         = $this->get_config('createnewusers');
 431
 432     if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)){
 433         $person->idnumber = trim($matches[1]);
 434     }
 435     if(preg_match('{<name>.*?<n>.*?<given>(.+?)</given>.*?</n>.*?</name>}is', $tagcontents, $matches)){
 436         $person->firstname = trim($matches[1]);
 437     }
 438     if(preg_match('{<name>.*?<n>.*?<family>(.+?)</family>.*?</n>.*?</name>}is', $tagcontents, $matches)){
 439         $person->lastname = trim($matches[1]);
 440     }
 441     if(preg_match('{<userid>(.*?)</userid>}is', $tagcontents, $matches)){
 442         $person->username = trim($matches[1]);
 443     }
 444     if($imssourcedidfallback && trim($person->username)==''){
 445       // This is the point where we can fall back to useing the "sourcedid" if "userid" is not supplied
 446       // NB We don't use an "elseif" because the tag may be supplied-but-empty
 447         $person->username = $person->idnumber;
 448     }
 449     if(preg_match('{<email>(.*?)</email>}is', $tagcontents, $matches)){
 450         $person->email = trim($matches[1]);
 451     }
 452     if(preg_match('{<url>(.*?)</url>}is', $tagcontents, $matches)){
 453         $person->url = trim($matches[1]);
 454     }
 455     if(preg_match('{<adr>.*?<locality>(.+?)</locality>.*?</adr>}is', $tagcontents, $matches)){
 456         $person->city = trim($matches[1]);
 457     }
 458     if(preg_match('{<adr>.*?<country>(.+?)</country>.*?</adr>}is', $tagcontents, $matches)){
 459         $person->country = trim($matches[1]);
 460     }
 461
 462     // Fix case of some of the fields if required
 463     if($fixcaseusernames && isset($person->username)){
 464         $person->username = strtolower($person->username);
 465     }
 466     if($fixcasepersonalnames){
 467         if(isset($person->firstname)){
 468             $person->firstname = ucwords(strtolower($person->firstname));
 469         }
 470         if(isset($person->lastname)){
 471             $person->lastname = ucwords(strtolower($person->lastname));
 472         }
 473     }
 474
 475     $recstatus = ($this->get_recstatus($tagcontents, 'person'));
 476
 477
 478     // Now if the recstatus is 3, we should delete the user if-and-only-if the setting for delete users is turned on
 479     // In the "users" table we can do this by setting deleted=1
 480     if($recstatus==3){
 481
 482         if($imsdeleteusers){ // If we're allowed to delete user records
 483             // Make sure their "deleted" field is set to one
 484             $DB->set_field('user', 'deleted', 1, array('username'=>$person->username));
 485             $this->log_line("Marked user record for user '$person->username' (ID number $person->idnumber) as deleted.");
 486         }else{
 487             $this->log_line("Ignoring deletion request for user '$person->username' (ID number $person->idnumber).");
 488         }
 489
 490     }else{ // Add or update record
 491
 492
 493         // If the user exists (matching sourcedid) then we don't need to do anything.
 494         if(!$DB->get_field('user', 'id', array('idnumber'=>$person->idnumber)) && $createnewusers){
 495             // If they don't exist and haven't a defined username, we log this as a potential problem.
 496             if((!isset($person->username)) || (strlen($person->username)==0)){
 497                 $this->log_line("Cannot create new user for ID # $person->idnumber - no username listed in IMS data for this person.");
 498             } else if ($DB->get_field('user', 'id', array('username'=>$person->username))){
 499                 // If their idnumber is not registered but their user ID is, then add their idnumber to their record
 500                 $DB->set_field('user', 'idnumber', $person->idnumber, array('username'=>$person->username));
 501             } else {
 502
 503             // If they don't exist and they have a defined username, and $createnewusers == true, we create them.
 504             $person->lang = 'manual'; //TODO: this needs more work due tu multiauth changes
 505             $person->auth = $CFG->auth;
 506             $person->confirmed = 1;
 507             $person->timemodified = time();
 508             $person->mnethostid = $CFG->mnet_localhost_id;
 509             $id = $DB->insert_record('user', $person);
 510     /*
 511     Photo processing is deactivated until we hear from Moodle dev forum about modification to gdlib.
 512
 513                                  //Antoni Mas. 07/12/2005. If a photo URL is specified then we might want to load
 514                                  // it into the user's profile. Beware that this may cause a heavy overhead on the server.
 515                                  if($CFG->enrol_processphoto){
 516                                    if(preg_match('{<photo>.*?<extref>(.*?)</extref>.*?</photo>}is', $tagcontents, $matches)){
 517                                      $person->urlphoto = trim($matches[1]);
 518                                    }
 519                                    //Habilitam el flag que ens indica que el personatge t foto prpia.
 520                                    $person->picture = 1;
 521                                    //Llibreria creada per nosaltres mateixos.
 522                                    require_once($CFG->dirroot.'/lib/gdlib.php');
 523                                    if ($usernew->picture = save_profile_image($id, $person->urlphoto,'user')) { TODO: use process_new_icon() instead
 524                                      $DB->set_field('user', 'picture', $usernew->picture, array('id'=>$id));  /// Note picture in DB
 525                                    }
 526                                  }
 527     */
 528                 $this->log_line("Created user record for user '$person->username' (ID number $person->idnumber).");
 529             }
 530         } elseif ($createnewusers) {
 531             $this->log_line("User record already exists for user '$person->username' (ID number $person->idnumber).");
 532
 533             // Make sure their "deleted" field is set to zero.
 534             $DB->set_field('user', 'deleted', 0, array('idnumber'=>$person->idnumber));
 535         }else{
 536             $this->log_line("No user record found for '$person->username' (ID number $person->idnumber).");
 537         }
 538
 539     } // End of are-we-deleting-or-adding
 540
 541 } // End process_person_tag()
 542
 543 /**
 544 * Process the membership tag. This defines whether the specified Moodle users
 545 * should be added/removed as teachers/students.
 546 * @param string $tagconents The raw contents of the XML element
 547 */
 548 function process_membership_tag($tagcontents){
 549     global $DB;
 550
 551     // Get plugin configs
 552     $truncatecoursecodes = $this->get_config('truncatecoursecodes');
 553     $imscapitafix = $this->get_config('imscapitafix');
 554
 555     $memberstally = 0;
 556     $membersuntally = 0;
 557
 558     // In order to reduce the number of db queries required, group name/id associations are cached in this array:
 559     $groupids = array();
 560
 561     if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)){
 562         $ship->coursecode = ($truncatecoursecodes > 0)
 563                                  ? substr(trim($matches[1]), 0, intval($truncatecoursecodes))
 564                                  : trim($matches[1]);
 565         $ship->courseid = $DB->get_field('course', 'id', array('idnumber'=>$ship->coursecode));
 566     }
 567     if($ship->courseid && preg_match_all('{<member>(.*?)</member>}is', $tagcontents, $membermatches, PREG_SET_ORDER)){
 568         $courseobj = new stdClass();
 569         $courseobj->id = $ship->courseid;
 570
 571         foreach($membermatches as $mmatch){
 572             unset($member);
 573             unset($memberstoreobj);
 574             if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $mmatch[1], $matches)){
 575                 $member->idnumber = trim($matches[1]);
 576             }
 577             if(preg_match('{<role\s+roletype=["\'](.+?)["\'].*?>}is', $mmatch[1], $matches)){
 578                 $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
 579             } elseif($imscapitafix && preg_match('{<roletype>(.+?)</roletype>}is', $mmatch[1], $matches)){
 580                 // The XML that comes out of Capita Student Records seems to contain a misinterpretation of the IMS specification!
 581                 $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
 582             }
 583             if(preg_match('{<role\b.*?<status>(.+?)</status>.*?</role>}is', $mmatch[1], $matches)){
 584                 $member->status = trim($matches[1]); // 1 means active, 0 means inactive - treat this as enrol vs unenrol
 585             }
 586
 587             $recstatus = ($this->get_recstatus($mmatch[1], 'role'));
 588             if($recstatus==3){
 589               $member->status = 0; // See above - recstatus of 3 (==delete) is treated the same as status of 0
 590               //echo "<p>process_membership_tag: unenrolling member due to recstatus of 3</p>";
 591             }
 592
 593             $timeframe->begin = 0;
 594             $timeframe->end = 0;
 595             if(preg_match('{<role\b.*?<timeframe>(.+?)</timeframe>.*?</role>}is', $mmatch[1], $matches)){
 596                 $timeframe = $this->decode_timeframe($matches[1]);
 597             }
 598             if(preg_match('{<role\b.*?<extension>.*?<cohort>(.+?)</cohort>.*?</extension>.*?</role>}is', $mmatch[1], $matches)){
 599                 $member->groupname = trim($matches[1]);
 600                 // The actual processing (ensuring a group record exists, etc) occurs below, in the enrol-a-student clause
 601             }
 602
 603             $rolecontext = get_context_instance(CONTEXT_COURSE, $ship->courseid);
 604             $rolecontext = $rolecontext->id; // All we really want is the ID
 605 //$this->log_line("Context instance for course $ship->courseid is...");
 606 //print_r($rolecontext);
 607
 608             // Add or remove this student or teacher to the course...
 609             $memberstoreobj->userid = $DB->get_field('user', 'id', array('idnumber'=>$member->idnumber));
 610             $memberstoreobj->enrol = 'imsenterprise';
 611             $memberstoreobj->course = $ship->courseid;
 612             $memberstoreobj->time = time();
 613             $memberstoreobj->timemodified = time();
 614             if($memberstoreobj->userid){
 615
 616                 // Decide the "real" role (i.e. the Moodle role) that this user should be assigned to.
 617                 // Zero means this roletype is supposed to be skipped.
 618                 $moodleroleid = $this->rolemappings[$member->roletype];
 619                 if(!$moodleroleid) {
 620                     $this->log_line("SKIPPING role $member->roletype for $memberstoreobj->userid ($member->idnumber) in course $memberstoreobj->course");
 621                     continue;
 622                 }
 623
 624                 if(intval($member->status) == 1) {
 625                     // Enrol the member
 626
 627                     $einstance = $DB->get_record('enrol',
 628                                     array('courseid' => $courseobj->id, 'enrol' => $memberstoreobj->enrol));
 629                     if (empty($einstance)) {
 630                         // Only add an enrol instance to the course if non-existent
 631                         $enrolid = $this->add_instance($courseobj);
 632                         $einstance = $DB->get_record('enrol', array('id' => $enrolid));
 633                     }
 634
 635                     $this->enrol_user($einstance, $memberstoreobj->userid, $moodleroleid, $timeframe->begin, $timeframe->end);
 636
 637                     $this->log_line("Enrolled user #$memberstoreobj->userid ($member->idnumber) to role $member->roletype in course $memberstoreobj->course");
 638                     $memberstally++;
 639
 640                     // At this point we can also ensure the group membership is recorded if present
 641                     if(isset($member->groupname)){
 642                         // Create the group if it doesn't exist - either way, make sure we know the group ID
 643                         if(isset($groupids[$member->groupname])) {
 644                             $member->groupid = $groupids[$member->groupname]; // Recall the group ID from cache if available
 645                         } else {
 646                             if($groupid = $DB->get_field('groups', 'id', 'name', $member->groupname, array('courseid'=>$ship->courseid))){
 647                                 $member->groupid = $groupid;
 648                                 $groupids[$member->groupname] = $groupid; // Store ID in cache
 649                             } else {
 650                                 // Attempt to create the group
 651                                 $group->name = $member->groupname;
 652                                 $group->courseid = $ship->courseid;
 653                                 $group->timecreated = time();
 654                                 $group->timemodified = time();
 655                                 $groupid = $DB->insert_record('groups', $group);
 656                                 $this->log_line('Added a new group for this course: '.$group->name);
 657                                 $groupids[$member->groupname] = $groupid; // Store ID in cache
 658                                 $member->groupid = $groupid;
 659                             }
 660                         }
 661                         // Add the user-to-group association if it doesn't already exist
 662                         if($member->groupid) {
 663                             groups_add_member($member->groupid, $memberstoreobj->userid);
 664                         }
 665                     } // End of group-enrolment (from member.role.extension.cohort tag)
 666
 667                 } elseif ($this->get_config('imsunenrol')) {
 668                     // Unenrol member
 669
 670                     $einstances = $DB->get_records('enrol',
 671                                     array('enrol' => $memberstoreobj->enrol, 'courseid' => $courseobj->id));
 672                     foreach ($einstances as $einstance) {
 673                         // Unenrol the user from all imsenterprise enrolment instances
 674                         $this->unenrol_user($einstance, $memberstoreobj->userid);
 675                     }
 676
 677                     $membersuntally++;
 678                     $this->log_line("Unenrolled $member->idnumber from role $moodleroleid in course");
 679                 }
 680
 681             }
 682         }
 683         $this->log_line("Added $memberstally users to course $ship->coursecode");
 684         if($membersuntally > 0){
 685             $this->log_line("Removed $membersuntally users from course $ship->coursecode");
 686         }
 687     }
 688 } // End process_membership_tag()
 689
 690 /**
 691 * Process the properties tag. The only data from this element
 692 * that is relevant is whether a <target> is specified.
 693 * @param string $tagconents The raw contents of the XML element
 694 */
 695 function process_properties_tag($tagcontents){
 696     $imsrestricttarget = $this->get_config('imsrestricttarget');
 697
 698     if ($imsrestricttarget) {
 699         if(!(preg_match('{<target>'.preg_quote($imsrestricttarget).'</target>}is', $tagcontents, $matches))){
 700             $this->log_line("Skipping processing: required target \"$imsrestricttarget\" not specified in this data.");
 701             $this->continueprocessing = false;
 702         }
 703     }
 704 }
 705
 706 /**
 707 * Store logging information. This does two things: uses the {@link mtrace()}
 708 * function to print info to screen/STDOUT, and also writes log to a text file
 709 * if a path has been specified.
 710 * @param string $string Text to write (newline will be added automatically)
 711 */
 712 function log_line($string){
 713     mtrace($string);
 714     if($this->logfp) {
 715         fwrite($this->logfp, $string . "\n");
 716     }
 717 }
 718
 719 /**
 720 * Process the INNER contents of a <timeframe> tag, to return beginning/ending dates.
 721 */
 722 function decode_timeframe($string){ // Pass me the INNER CONTENTS of a <timeframe> tag - beginning and/or ending is returned, in unix time, zero indicating not specified
 723     $ret->begin = $ret->end = 0;
 724     // Explanatory note: The matching will ONLY match if the attribute restrict="1"
 725     // because otherwise the time markers should be ignored (participation should be
 726     // allowed outside the period)
 727     if(preg_match('{<begin\s+restrict="1">(\d\d\d\d)-(\d\d)-(\d\d)</begin>}is', $string, $matches)){
 728         $ret->begin = mktime(0,0,0, $matches[2], $matches[3], $matches[1]);
 729     }
 730     if(preg_match('{<end\s+restrict="1">(\d\d\d\d)-(\d\d)-(\d\d)</end>}is', $string, $matches)){
 731         $ret->end = mktime(0,0,0, $matches[2], $matches[3], $matches[1]);
 732     }
 733     return $ret;
 734 } // End decode_timeframe
 735
 736 /**
 737 * Load the role mappings (from the config), so we can easily refer to
 738 * how an IMS-E role corresponds to a Moodle role
 739 */
 740 function load_role_mappings() {
 741     require_once('locallib.php');
 742     global $DB;
 743
 744     $imsroles = new imsenterprise_roles();
 745     $imsroles = $imsroles->get_imsroles();
 746
 747     $this->rolemappings = array();
 748     foreach($imsroles as $imsrolenum=>$imsrolename) {
 749         $this->rolemappings[$imsrolenum] = $this->rolemappings[$imsrolename]
 750             = $DB->get_field('config_plugins', 'value', array('name'=>'imsrolemap' . $imsrolenum));
 751     }
 752 }
 753
 754 } // end of class
 755
 756