MDL-25983 enrol_imsenterprise Importing the course summary when adding new courses
[moodle.git] / 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/>.
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  */
30 defined('MOODLE_INTERNAL') || die();
32 /*
34 Note for programmers:
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.
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>.
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.
47 N.B. The "sourcedid" ID code is translated to Moodle's "idnumber" field, both
48 for users and for courses.
50 */
52 require_once($CFG->dirroot.'/group/lib.php');
55 class enrol_imsenterprise_plugin extends enrol_plugin {
57 var $log;
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;
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');
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     }
84     $this->logfp = false; // File pointer for writing log data to
85     if(!empty($logtolocation)) {
86         $this->logfp = fopen($logtolocation, 'a');
87     }
89     if ( file_exists($filename) ) {
90         @set_time_limit(0);
91         $starttime = time();
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 = '';
98         // Make sure we understand how to map the IMS-E roles to Moodle roles
99         $this->load_role_mappings();
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);
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         }
118         if($fileisnew) {
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
123             // FIRST PASS: Run through the file and process the group/person entries
124             if (($fh = fopen($filename, "r")) != false) {
126                 $line = 0;
127                 while ((!feof($fh)) && $this->continueprocessing) {
129                     $line++;
130                     $curline = fgets($fh);
131                     $this->xmlcache .= $curline; // Add a line onto the XML cache
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
159             /*
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.
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
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
199            */
201             $timeelapsed = time() - $starttime;
202             $this->log_line('Process has completed. Time taken: '.$timeelapsed.' seconds.');
205         } // END of "if file is new"
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);
215     }else{ // end of if(file_exists)
216         $this->log_line('File not found: '.$filename);
217     }
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         }
234         $eventdata = new stdClass();
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);
247         $this->log_line('Notification email sent to administrator.');
249     }
251     if($this->logfp){
252       fclose($this->logfp);
253     }
256 } // end of cron() function
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;
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>";
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     }
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;
308     // Get configs
309     $truncatecoursecodes    = $this->get_config('truncatecoursecodes');
310     $createnewcourses       = $this->get_config('createnewcourses');
311     $createnewcategories    = $this->get_config('createnewcategories');
313     // Process tag contents
314     $group = new stdClass();
315     if (preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)) {
316         $group->coursecode = trim($matches[1]);
317     }
318     if (preg_match('{<description>.*?<long>(.*?)</long>.*?</description>}is', $tagcontents, $matches)){
319         $group->description = trim($matches[1]);
320     }
321     if (preg_match('{<description>.*?<short>(.*?)</short>.*?</description>}is', $tagcontents, $matches)) {
322         $group->shortName = trim($matches[1]);
323     }
324     if (preg_match('{<description>.*?<full>(.*?)</full>.*?</description>}is', $tagcontents, $matches)) {
325         $group->fulldescription = trim($matches[1]);
326     }
327     if (preg_match('{<org>.*?<orgunit>(.*?)</orgunit>.*?</org>}is', $tagcontents, $matches)) {
328         $group->category = trim($matches[1]);
329     }
331     $recstatus = ($this->get_recstatus($tagcontents, 'group'));
332     //echo "<p>get_recstatus for this group returned $recstatus</p>";
334     if (!(strlen($group->coursecode)>0)) {
335         $this->log_line('Error at line '.$line.': Unable to find course code in \'group\' element.');
336     } else {
337         // First, truncate the course code if desired
338         if (intval($truncatecoursecodes)>0) {
339             $group->coursecode = ($truncatecoursecodes > 0)
340                      ? substr($group->coursecode, 0, intval($truncatecoursecodes))
341                      : $group->coursecode;
342         }
344         /* -----------Course aliasing is DEACTIVATED until a more general method is in place---------------
346        // Second, look in the course alias table to see if the code should be translated to something else
347         if($aliases = $DB->get_field('enrol_coursealias', 'toids', array('fromid'=>$group->coursecode))){
348             $this->log_line("Found alias of course code: Translated $group->coursecode to $aliases");
349             // Alias is allowed to be a comma-separated list, so let's split it
350             $group->coursecode = explode(',', $aliases);
351         }
352        */
354         // For compatibility with the (currently inactive) course aliasing, we need this to be an array
355         $group->coursecode = array($group->coursecode);
357         // Third, check if the course(s) exist
358         foreach ($group->coursecode as $coursecode) {
359             $coursecode = trim($coursecode);
360             if (!$DB->get_field('course', 'id', array('idnumber'=>$coursecode))) {
361                 if (!$createnewcourses) {
362                     $this->log_line("Course $coursecode not found in Moodle's course idnumbers.");
363                 } else {
364                     // Set shortname to description or description to shortname if one is set but not the other.
365                     $nodescription = !isset($group->description);
366                     $noshortname = !isset($group->shortName);
367                     if ( $nodescription && $noshortname) {
368                         // If neither short nor long description are set let if fail
369                         $this->log_line("Neither long nor short name are set for $coursecode");
370                     } else if ($nodescription) {
371                         // If short and ID exist, then give the long short's value, then give short the ID's value
372                         $group->description = $group->shortName;
373                         $group->shortName = $coursecode;
374                     } else if ($noshortname) {
375                         // If long and ID exist, then map long to long, then give short the ID's value.
376                         $group->shortName = $coursecode;
377                     }
378                     // Create the (hidden) course(s) if not found
379                     $courseconfig = get_config('moodlecourse'); // Load Moodle Course shell defaults
380                     $course = new stdClass();
381                     $course->fullname = $group->description;
382                     $course->shortname = $group->shortName;
383                     if (!empty($group->fulldescription)) {
384                         $course->summary = format_text($group->fulldescription, FORMAT_HTML);
385                     }
386                     $course->idnumber = $coursecode;
387                     $course->format = $courseconfig->format;
388                     $course->visible = $courseconfig->visible;
389                     $course->numsections = $courseconfig->numsections;
390                     $course->hiddensections = $courseconfig->hiddensections;
391                     $course->newsitems = $courseconfig->newsitems;
392                     $course->showgrades = $courseconfig->showgrades;
393                     $course->showreports = $courseconfig->showreports;
394                     $course->maxbytes = $courseconfig->maxbytes;
395                     $course->groupmode = $courseconfig->groupmode;
396                     $course->groupmodeforce = $courseconfig->groupmodeforce;
397                     $course->enablecompletion = $courseconfig->enablecompletion;
398                     $course->completionstartonenrol = $courseconfig->completionstartonenrol;
399                     // Insert default names for teachers/students, from the current language
401                     // Handle course categorisation (taken from the group.org.orgunit field if present)
402                     if (strlen($group->category)>0) {
403                         // If the category is defined and exists in Moodle, we want to store it in that one
404                         if ($catid = $DB->get_field('course_categories', 'id', array('name'=>$group->category))) {
405                             $course->category = $catid;
406                         } else if ($createnewcategories) {
407                             // Else if we're allowed to create new categories, let's create this one
408                             $newcat = new stdClass();
409                             $newcat->name = $group->category;
410                             $newcat->visible = 0;
411                             $catid = $DB->insert_record('course_categories', $newcat);
412                             $course->category = $catid;
413                             $this->log_line("Created new (hidden) category, #$catid: $newcat->name");
414                         } else {
415                             // If not found and not allowed to create, stick with default
416                             $this->log_line('Category '.$group->category.' not found in Moodle database, so using default category instead.');
417                             $course->category = 1;
418                         }
419                     } else {
420                         $course->category = 1;
421                     }
422                     $course->timecreated = time();
423                     $course->startdate = time();
424                     // Choose a sort order that puts us at the start of the list!
425                     $course->sortorder = 0;
427                     $courseid = $DB->insert_record('course', $course);
429                     // Setup default enrolment plugins
430                     $course->id = $courseid;
431                     enrol_course_updated(true, $course, null);
433                     // Setup the blocks
434                     $course = $DB->get_record('course', array('id' => $courseid));
435                     blocks_add_default_course_blocks($course);
437                     $section = new stdClass();
438                     $section->course = $course->id;   // Create a default section.
439                     $section->section = 0;
440                     $section->summaryformat = FORMAT_HTML;
441                     $section->id = $DB->insert_record("course_sections", $section);
443                     add_to_log(SITEID, "course", "new", "view.php?id=$course->id", "$course->fullname (ID $course->id)");
445                     $this->log_line("Created course $coursecode in Moodle (Moodle ID is $course->id)");
446                 }
447             } else if ($recstatus==3 && ($courseid = $DB->get_field('course', 'id', array('idnumber'=>$coursecode)))) {
448                 // If course does exist, but recstatus==3 (delete), then set the course as hidden
449                 $DB->set_field('course', 'visible', '0', array('id'=>$courseid));
450             }
451         } // End of foreach(coursecode)
452     }
453 } // End process_group_tag()
455 /**
456 * Process the person tag. This defines a Moodle user.
457 * @param string $tagconents The raw contents of the XML element
458 */
459 function process_person_tag($tagcontents){
460     global $CFG, $DB;
462     // Get plugin configs
463     $imssourcedidfallback   = $this->get_config('imssourcedidfallback');
464     $fixcaseusernames       = $this->get_config('fixcaseusernames');
465     $fixcasepersonalnames   = $this->get_config('fixcasepersonalnames');
466     $imsdeleteusers         = $this->get_config('imsdeleteusers');
467     $createnewusers         = $this->get_config('createnewusers');
469     $person = new stdClass();
470     if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)){
471         $person->idnumber = trim($matches[1]);
472     }
473     if(preg_match('{<name>.*?<n>.*?<given>(.+?)</given>.*?</n>.*?</name>}is', $tagcontents, $matches)){
474         $person->firstname = trim($matches[1]);
475     }
476     if(preg_match('{<name>.*?<n>.*?<family>(.+?)</family>.*?</n>.*?</name>}is', $tagcontents, $matches)){
477         $person->lastname = trim($matches[1]);
478     }
479     if(preg_match('{<userid>(.*?)</userid>}is', $tagcontents, $matches)){
480         $person->username = trim($matches[1]);
481     }
482     if($imssourcedidfallback && trim($person->username)==''){
483       // This is the point where we can fall back to useing the "sourcedid" if "userid" is not supplied
484       // NB We don't use an "elseif" because the tag may be supplied-but-empty
485         $person->username = $person->idnumber;
486     }
487     if(preg_match('{<email>(.*?)</email>}is', $tagcontents, $matches)){
488         $person->email = trim($matches[1]);
489     }
490     if(preg_match('{<url>(.*?)</url>}is', $tagcontents, $matches)){
491         $person->url = trim($matches[1]);
492     }
493     if(preg_match('{<adr>.*?<locality>(.+?)</locality>.*?</adr>}is', $tagcontents, $matches)){
494         $person->city = trim($matches[1]);
495     }
496     if(preg_match('{<adr>.*?<country>(.+?)</country>.*?</adr>}is', $tagcontents, $matches)){
497         $person->country = trim($matches[1]);
498     }
500     // Fix case of some of the fields if required
501     if($fixcaseusernames && isset($person->username)){
502         $person->username = strtolower($person->username);
503     }
504     if($fixcasepersonalnames){
505         if(isset($person->firstname)){
506             $person->firstname = ucwords(strtolower($person->firstname));
507         }
508         if(isset($person->lastname)){
509             $person->lastname = ucwords(strtolower($person->lastname));
510         }
511     }
513     $recstatus = ($this->get_recstatus($tagcontents, 'person'));
516     // Now if the recstatus is 3, we should delete the user if-and-only-if the setting for delete users is turned on
517     // In the "users" table we can do this by setting deleted=1
518     if($recstatus==3){
520         if($imsdeleteusers){ // If we're allowed to delete user records
521             // Make sure their "deleted" field is set to one
522             $DB->set_field('user', 'deleted', 1, array('username'=>$person->username));
523             $this->log_line("Marked user record for user '$person->username' (ID number $person->idnumber) as deleted.");
524         }else{
525             $this->log_line("Ignoring deletion request for user '$person->username' (ID number $person->idnumber).");
526         }
528     }else{ // Add or update record
531         // If the user exists (matching sourcedid) then we don't need to do anything.
532         if(!$DB->get_field('user', 'id', array('idnumber'=>$person->idnumber)) && $createnewusers){
533             // If they don't exist and haven't a defined username, we log this as a potential problem.
534             if((!isset($person->username)) || (strlen($person->username)==0)){
535                 $this->log_line("Cannot create new user for ID # $person->idnumber - no username listed in IMS data for this person.");
536             } else if ($DB->get_field('user', 'id', array('username'=>$person->username))){
537                 // If their idnumber is not registered but their user ID is, then add their idnumber to their record
538                 $DB->set_field('user', 'idnumber', $person->idnumber, array('username'=>$person->username));
539             } else {
541             // If they don't exist and they have a defined username, and $createnewusers == true, we create them.
542             $person->lang = 'manual'; //TODO: this needs more work due tu multiauth changes
543             $person->auth = $CFG->auth;
544             $person->confirmed = 1;
545             $person->timemodified = time();
546             $person->mnethostid = $CFG->mnet_localhost_id;
547             $id = $DB->insert_record('user', $person);
548     /*
549     Photo processing is deactivated until we hear from Moodle dev forum about modification to gdlib.
551                                  //Antoni Mas. 07/12/2005. If a photo URL is specified then we might want to load
552                                  // it into the user's profile. Beware that this may cause a heavy overhead on the server.
553                                  if($CFG->enrol_processphoto){
554                                    if(preg_match('{<photo>.*?<extref>(.*?)</extref>.*?</photo>}is', $tagcontents, $matches)){
555                                      $person->urlphoto = trim($matches[1]);
556                                    }
557                                    //Habilitam el flag que ens indica que el personatge t foto prpia.
558                                    $person->picture = 1;
559                                    //Llibreria creada per nosaltres mateixos.
560                                    require_once($CFG->dirroot.'/lib/gdlib.php');
561                                    if ($usernew->picture = save_profile_image($id, $person->urlphoto,'user')) { TODO: use process_new_icon() instead
562                                      $DB->set_field('user', 'picture', $usernew->picture, array('id'=>$id));  /// Note picture in DB
563                                    }
564                                  }
565     */
566                 $this->log_line("Created user record for user '$person->username' (ID number $person->idnumber).");
567             }
568         } elseif ($createnewusers) {
569             $this->log_line("User record already exists for user '$person->username' (ID number $person->idnumber).");
571             // Make sure their "deleted" field is set to zero.
572             $DB->set_field('user', 'deleted', 0, array('idnumber'=>$person->idnumber));
573         }else{
574             $this->log_line("No user record found for '$person->username' (ID number $person->idnumber).");
575         }
577     } // End of are-we-deleting-or-adding
579 } // End process_person_tag()
581 /**
582 * Process the membership tag. This defines whether the specified Moodle users
583 * should be added/removed as teachers/students.
584 * @param string $tagconents The raw contents of the XML element
585 */
586 function process_membership_tag($tagcontents){
587     global $DB;
589     // Get plugin configs
590     $truncatecoursecodes = $this->get_config('truncatecoursecodes');
591     $imscapitafix = $this->get_config('imscapitafix');
593     $memberstally = 0;
594     $membersuntally = 0;
596     // In order to reduce the number of db queries required, group name/id associations are cached in this array:
597     $groupids = array();
599     $ship = new stdClass();
601     if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)){
602         $ship->coursecode = ($truncatecoursecodes > 0)
603                                  ? substr(trim($matches[1]), 0, intval($truncatecoursecodes))
604                                  : trim($matches[1]);
605         $ship->courseid = $DB->get_field('course', 'id', array('idnumber'=>$ship->coursecode));
606     }
607     if($ship->courseid && preg_match_all('{<member>(.*?)</member>}is', $tagcontents, $membermatches, PREG_SET_ORDER)){
608         $courseobj = new stdClass();
609         $courseobj->id = $ship->courseid;
611         foreach($membermatches as $mmatch){
612             $member = new stdClass();
613             $memberstoreobj = new stdClass();
614             if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $mmatch[1], $matches)){
615                 $member->idnumber = trim($matches[1]);
616             }
617             if(preg_match('{<role\s+roletype=["\'](.+?)["\'].*?>}is', $mmatch[1], $matches)){
618                 $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
619             } elseif($imscapitafix && preg_match('{<roletype>(.+?)</roletype>}is', $mmatch[1], $matches)){
620                 // The XML that comes out of Capita Student Records seems to contain a misinterpretation of the IMS specification!
621                 $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
622             }
623             if(preg_match('{<role\b.*?<status>(.+?)</status>.*?</role>}is', $mmatch[1], $matches)){
624                 $member->status = trim($matches[1]); // 1 means active, 0 means inactive - treat this as enrol vs unenrol
625             }
627             $recstatus = ($this->get_recstatus($mmatch[1], 'role'));
628             if($recstatus==3){
629               $member->status = 0; // See above - recstatus of 3 (==delete) is treated the same as status of 0
630               //echo "<p>process_membership_tag: unenrolling member due to recstatus of 3</p>";
631             }
633             $timeframe = new stdClass();
634             $timeframe->begin = 0;
635             $timeframe->end = 0;
636             if(preg_match('{<role\b.*?<timeframe>(.+?)</timeframe>.*?</role>}is', $mmatch[1], $matches)){
637                 $timeframe = $this->decode_timeframe($matches[1]);
638             }
639             if(preg_match('{<role\b.*?<extension>.*?<cohort>(.+?)</cohort>.*?</extension>.*?</role>}is', $mmatch[1], $matches)){
640                 $member->groupname = trim($matches[1]);
641                 // The actual processing (ensuring a group record exists, etc) occurs below, in the enrol-a-student clause
642             }
644             $rolecontext = context_course::instance($ship->courseid);
645             $rolecontext = $rolecontext->id; // All we really want is the ID
646 //$this->log_line("Context instance for course $ship->courseid is...");
647 //print_r($rolecontext);
649             // Add or remove this student or teacher to the course...
650             $memberstoreobj->userid = $DB->get_field('user', 'id', array('idnumber'=>$member->idnumber));
651             $memberstoreobj->enrol = 'imsenterprise';
652             $memberstoreobj->course = $ship->courseid;
653             $memberstoreobj->time = time();
654             $memberstoreobj->timemodified = time();
655             if($memberstoreobj->userid){
657                 // Decide the "real" role (i.e. the Moodle role) that this user should be assigned to.
658                 // Zero means this roletype is supposed to be skipped.
659                 $moodleroleid = $this->rolemappings[$member->roletype];
660                 if(!$moodleroleid) {
661                     $this->log_line("SKIPPING role $member->roletype for $memberstoreobj->userid ($member->idnumber) in course $memberstoreobj->course");
662                     continue;
663                 }
665                 if(intval($member->status) == 1) {
666                     // Enrol the member
668                     $einstance = $DB->get_record('enrol',
669                                     array('courseid' => $courseobj->id, 'enrol' => $memberstoreobj->enrol));
670                     if (empty($einstance)) {
671                         // Only add an enrol instance to the course if non-existent
672                         $enrolid = $this->add_instance($courseobj);
673                         $einstance = $DB->get_record('enrol', array('id' => $enrolid));
674                     }
676                     $this->enrol_user($einstance, $memberstoreobj->userid, $moodleroleid, $timeframe->begin, $timeframe->end);
678                     $this->log_line("Enrolled user #$memberstoreobj->userid ($member->idnumber) to role $member->roletype in course $memberstoreobj->course");
679                     $memberstally++;
681                     // At this point we can also ensure the group membership is recorded if present
682                     if(isset($member->groupname)){
683                         // Create the group if it doesn't exist - either way, make sure we know the group ID
684                         if(isset($groupids[$member->groupname])) {
685                             $member->groupid = $groupids[$member->groupname]; // Recall the group ID from cache if available
686                         } else {
687                             if($groupid = $DB->get_field('groups', 'id', array('courseid'=>$ship->courseid, 'name'=>$member->groupname))){
688                                 $member->groupid = $groupid;
689                                 $groupids[$member->groupname] = $groupid; // Store ID in cache
690                             } else {
691                                 // Attempt to create the group
692                                 $group = new stdClass();
693                                 $group->name = $member->groupname;
694                                 $group->courseid = $ship->courseid;
695                                 $group->timecreated = time();
696                                 $group->timemodified = time();
697                                 $groupid = $DB->insert_record('groups', $group);
698                                 $this->log_line('Added a new group for this course: '.$group->name);
699                                 $groupids[$member->groupname] = $groupid; // Store ID in cache
700                                 $member->groupid = $groupid;
701                             }
702                         }
703                         // Add the user-to-group association if it doesn't already exist
704                         if($member->groupid) {
705                             groups_add_member($member->groupid, $memberstoreobj->userid);
706                         }
707                     } // End of group-enrolment (from member.role.extension.cohort tag)
709                 } elseif ($this->get_config('imsunenrol')) {
710                     // Unenrol member
712                     $einstances = $DB->get_records('enrol',
713                                     array('enrol' => $memberstoreobj->enrol, 'courseid' => $courseobj->id));
714                     foreach ($einstances as $einstance) {
715                         // Unenrol the user from all imsenterprise enrolment instances
716                         $this->unenrol_user($einstance, $memberstoreobj->userid);
717                     }
719                     $membersuntally++;
720                     $this->log_line("Unenrolled $member->idnumber from role $moodleroleid in course");
721                 }
723             }
724         }
725         $this->log_line("Added $memberstally users to course $ship->coursecode");
726         if($membersuntally > 0){
727             $this->log_line("Removed $membersuntally users from course $ship->coursecode");
728         }
729     }
730 } // End process_membership_tag()
732 /**
733 * Process the properties tag. The only data from this element
734 * that is relevant is whether a <target> is specified.
735 * @param string $tagconents The raw contents of the XML element
736 */
737 function process_properties_tag($tagcontents){
738     $imsrestricttarget = $this->get_config('imsrestricttarget');
740     if ($imsrestricttarget) {
741         if(!(preg_match('{<target>'.preg_quote($imsrestricttarget).'</target>}is', $tagcontents, $matches))){
742             $this->log_line("Skipping processing: required target \"$imsrestricttarget\" not specified in this data.");
743             $this->continueprocessing = false;
744         }
745     }
748 /**
749 * Store logging information. This does two things: uses the {@link mtrace()}
750 * function to print info to screen/STDOUT, and also writes log to a text file
751 * if a path has been specified.
752 * @param string $string Text to write (newline will be added automatically)
753 */
754 function log_line($string){
755     mtrace($string);
756     if($this->logfp) {
757         fwrite($this->logfp, $string . "\n");
758     }
761 /**
762 * Process the INNER contents of a <timeframe> tag, to return beginning/ending dates.
763 */
764 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
765     $ret = new stdClass();
766     $ret->begin = $ret->end = 0;
767     // Explanatory note: The matching will ONLY match if the attribute restrict="1"
768     // because otherwise the time markers should be ignored (participation should be
769     // allowed outside the period)
770     if(preg_match('{<begin\s+restrict="1">(\d\d\d\d)-(\d\d)-(\d\d)</begin>}is', $string, $matches)){
771         $ret->begin = mktime(0,0,0, $matches[2], $matches[3], $matches[1]);
772     }
773     if(preg_match('{<end\s+restrict="1">(\d\d\d\d)-(\d\d)-(\d\d)</end>}is', $string, $matches)){
774         $ret->end = mktime(0,0,0, $matches[2], $matches[3], $matches[1]);
775     }
776     return $ret;
777 } // End decode_timeframe
779 /**
780 * Load the role mappings (from the config), so we can easily refer to
781 * how an IMS-E role corresponds to a Moodle role
782 */
783 function load_role_mappings() {
784     require_once('locallib.php');
785     global $DB;
787     $imsroles = new imsenterprise_roles();
788     $imsroles = $imsroles->get_imsroles();
790     $this->rolemappings = array();
791     foreach($imsroles as $imsrolenum=>$imsrolename) {
792         $this->rolemappings[$imsrolenum] = $this->rolemappings[$imsrolename] = $this->get_config('imsrolemap' . $imsrolenum);
793     }
796 } // end of class