Merge branch 'dev_MDL-29476_ws_participants_master' of git://github.com/dongsheng...
[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>.*?<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     }
325     $recstatus = ($this->get_recstatus($tagcontents, 'group'));
326     //echo "<p>get_recstatus for this group returned $recstatus</p>";
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         }
338         /* -----------Course aliasing is DEACTIVATED until a more general method is in place---------------
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        */
348         // For compatibility with the (currently inactive) course aliasing, we need this to be an array
349         $group->coursecode = array($group->coursecode);
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 stdClass();
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();
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 = new stdClass();
376                         $newcat->name = $group->category;
377                         $newcat->visible = 0;
378                         $catid = $DB->insert_record('course_categories', $newcat);
379                         $course->category = $catid;
380                         $this->log_line("Created new (hidden) category, #$catid: $newcat->name");
381                     }else{
382                         // If not found and not allowed to create, stick with default
383                         $this->log_line('Category '.$group->category.' not found in Moodle database, so using default category instead.');
384                         $course->category = 1;
385                     }
386                 }else{
387                     $course->category = 1;
388                 }
389                 $course->timecreated = time();
390                 $course->startdate = time();
391                 $course->numsections = 1;
392                 // Choose a sort order that puts us at the start of the list!
393                 $course->sortorder = 0;
395                 $courseid = $DB->insert_record('course', $course);
397                 // Setup the blocks
398                 $course = $DB->get_record('course', array('id' => $courseid));
399                 blocks_add_default_course_blocks($course);
401                 $section = new stdClass();
402                 $section->course = $course->id;   // Create a default section.
403                 $section->section = 0;
404                 $section->summaryformat = FORMAT_HTML;
405                 $section->id = $DB->insert_record("course_sections", $section);
407                 add_to_log(SITEID, "course", "new", "view.php?id=$course->id", "$course->fullname (ID $course->id)");
409                 $this->log_line("Created course $coursecode in Moodle (Moodle ID is $course->id)");
410               }
411             }elseif($recstatus==3 && ($courseid = $DB->get_field('course', 'id', array('idnumber'=>$coursecode)))){
412                 // If course does exist, but recstatus==3 (delete), then set the course as hidden
413                 $DB->set_field('course', 'visible', '0', array('id'=>$courseid));
414             }
415         } // End of foreach(coursecode)
416     }
417 } // End process_group_tag()
419 /**
420 * Process the person tag. This defines a Moodle user.
421 * @param string $tagconents The raw contents of the XML element
422 */
423 function process_person_tag($tagcontents){
424     global $CFG, $DB;
426     // Get plugin configs
427     $imssourcedidfallback   = $this->get_config('imssourcedidfallback');
428     $fixcaseusernames       = $this->get_config('fixcaseusernames');
429     $fixcasepersonalnames   = $this->get_config('fixcasepersonalnames');
430     $imsdeleteusers         = $this->get_config('imsdeleteusers');
431     $createnewusers         = $this->get_config('createnewusers');
433     $person = new stdClass();
434     if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)){
435         $person->idnumber = trim($matches[1]);
436     }
437     if(preg_match('{<name>.*?<n>.*?<given>(.+?)</given>.*?</n>.*?</name>}is', $tagcontents, $matches)){
438         $person->firstname = trim($matches[1]);
439     }
440     if(preg_match('{<name>.*?<n>.*?<family>(.+?)</family>.*?</n>.*?</name>}is', $tagcontents, $matches)){
441         $person->lastname = trim($matches[1]);
442     }
443     if(preg_match('{<userid>(.*?)</userid>}is', $tagcontents, $matches)){
444         $person->username = trim($matches[1]);
445     }
446     if($imssourcedidfallback && trim($person->username)==''){
447       // This is the point where we can fall back to useing the "sourcedid" if "userid" is not supplied
448       // NB We don't use an "elseif" because the tag may be supplied-but-empty
449         $person->username = $person->idnumber;
450     }
451     if(preg_match('{<email>(.*?)</email>}is', $tagcontents, $matches)){
452         $person->email = trim($matches[1]);
453     }
454     if(preg_match('{<url>(.*?)</url>}is', $tagcontents, $matches)){
455         $person->url = trim($matches[1]);
456     }
457     if(preg_match('{<adr>.*?<locality>(.+?)</locality>.*?</adr>}is', $tagcontents, $matches)){
458         $person->city = trim($matches[1]);
459     }
460     if(preg_match('{<adr>.*?<country>(.+?)</country>.*?</adr>}is', $tagcontents, $matches)){
461         $person->country = trim($matches[1]);
462     }
464     // Fix case of some of the fields if required
465     if($fixcaseusernames && isset($person->username)){
466         $person->username = strtolower($person->username);
467     }
468     if($fixcasepersonalnames){
469         if(isset($person->firstname)){
470             $person->firstname = ucwords(strtolower($person->firstname));
471         }
472         if(isset($person->lastname)){
473             $person->lastname = ucwords(strtolower($person->lastname));
474         }
475     }
477     $recstatus = ($this->get_recstatus($tagcontents, 'person'));
480     // Now if the recstatus is 3, we should delete the user if-and-only-if the setting for delete users is turned on
481     // In the "users" table we can do this by setting deleted=1
482     if($recstatus==3){
484         if($imsdeleteusers){ // If we're allowed to delete user records
485             // Make sure their "deleted" field is set to one
486             $DB->set_field('user', 'deleted', 1, array('username'=>$person->username));
487             $this->log_line("Marked user record for user '$person->username' (ID number $person->idnumber) as deleted.");
488         }else{
489             $this->log_line("Ignoring deletion request for user '$person->username' (ID number $person->idnumber).");
490         }
492     }else{ // Add or update record
495         // If the user exists (matching sourcedid) then we don't need to do anything.
496         if(!$DB->get_field('user', 'id', array('idnumber'=>$person->idnumber)) && $createnewusers){
497             // If they don't exist and haven't a defined username, we log this as a potential problem.
498             if((!isset($person->username)) || (strlen($person->username)==0)){
499                 $this->log_line("Cannot create new user for ID # $person->idnumber - no username listed in IMS data for this person.");
500             } else if ($DB->get_field('user', 'id', array('username'=>$person->username))){
501                 // If their idnumber is not registered but their user ID is, then add their idnumber to their record
502                 $DB->set_field('user', 'idnumber', $person->idnumber, array('username'=>$person->username));
503             } else {
505             // If they don't exist and they have a defined username, and $createnewusers == true, we create them.
506             $person->lang = 'manual'; //TODO: this needs more work due tu multiauth changes
507             $person->auth = $CFG->auth;
508             $person->confirmed = 1;
509             $person->timemodified = time();
510             $person->mnethostid = $CFG->mnet_localhost_id;
511             $id = $DB->insert_record('user', $person);
512     /*
513     Photo processing is deactivated until we hear from Moodle dev forum about modification to gdlib.
515                                  //Antoni Mas. 07/12/2005. If a photo URL is specified then we might want to load
516                                  // it into the user's profile. Beware that this may cause a heavy overhead on the server.
517                                  if($CFG->enrol_processphoto){
518                                    if(preg_match('{<photo>.*?<extref>(.*?)</extref>.*?</photo>}is', $tagcontents, $matches)){
519                                      $person->urlphoto = trim($matches[1]);
520                                    }
521                                    //Habilitam el flag que ens indica que el personatge t foto prpia.
522                                    $person->picture = 1;
523                                    //Llibreria creada per nosaltres mateixos.
524                                    require_once($CFG->dirroot.'/lib/gdlib.php');
525                                    if ($usernew->picture = save_profile_image($id, $person->urlphoto,'user')) { TODO: use process_new_icon() instead
526                                      $DB->set_field('user', 'picture', $usernew->picture, array('id'=>$id));  /// Note picture in DB
527                                    }
528                                  }
529     */
530                 $this->log_line("Created user record for user '$person->username' (ID number $person->idnumber).");
531             }
532         } elseif ($createnewusers) {
533             $this->log_line("User record already exists for user '$person->username' (ID number $person->idnumber).");
535             // Make sure their "deleted" field is set to zero.
536             $DB->set_field('user', 'deleted', 0, array('idnumber'=>$person->idnumber));
537         }else{
538             $this->log_line("No user record found for '$person->username' (ID number $person->idnumber).");
539         }
541     } // End of are-we-deleting-or-adding
543 } // End process_person_tag()
545 /**
546 * Process the membership tag. This defines whether the specified Moodle users
547 * should be added/removed as teachers/students.
548 * @param string $tagconents The raw contents of the XML element
549 */
550 function process_membership_tag($tagcontents){
551     global $DB;
553     // Get plugin configs
554     $truncatecoursecodes = $this->get_config('truncatecoursecodes');
555     $imscapitafix = $this->get_config('imscapitafix');
557     $memberstally = 0;
558     $membersuntally = 0;
560     // In order to reduce the number of db queries required, group name/id associations are cached in this array:
561     $groupids = array();
563     if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $tagcontents, $matches)){
564         $ship->coursecode = ($truncatecoursecodes > 0)
565                                  ? substr(trim($matches[1]), 0, intval($truncatecoursecodes))
566                                  : trim($matches[1]);
567         $ship->courseid = $DB->get_field('course', 'id', array('idnumber'=>$ship->coursecode));
568     }
569     if($ship->courseid && preg_match_all('{<member>(.*?)</member>}is', $tagcontents, $membermatches, PREG_SET_ORDER)){
570         $courseobj = new stdClass();
571         $courseobj->id = $ship->courseid;
573         foreach($membermatches as $mmatch){
574             unset($member);
575             unset($memberstoreobj);
576             if(preg_match('{<sourcedid>.*?<id>(.+?)</id>.*?</sourcedid>}is', $mmatch[1], $matches)){
577                 $member->idnumber = trim($matches[1]);
578             }
579             if(preg_match('{<role\s+roletype=["\'](.+?)["\'].*?>}is', $mmatch[1], $matches)){
580                 $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
581             } elseif($imscapitafix && preg_match('{<roletype>(.+?)</roletype>}is', $mmatch[1], $matches)){
582                 // The XML that comes out of Capita Student Records seems to contain a misinterpretation of the IMS specification!
583                 $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
584             }
585             if(preg_match('{<role\b.*?<status>(.+?)</status>.*?</role>}is', $mmatch[1], $matches)){
586                 $member->status = trim($matches[1]); // 1 means active, 0 means inactive - treat this as enrol vs unenrol
587             }
589             $recstatus = ($this->get_recstatus($mmatch[1], 'role'));
590             if($recstatus==3){
591               $member->status = 0; // See above - recstatus of 3 (==delete) is treated the same as status of 0
592               //echo "<p>process_membership_tag: unenrolling member due to recstatus of 3</p>";
593             }
595             $timeframe->begin = 0;
596             $timeframe->end = 0;
597             if(preg_match('{<role\b.*?<timeframe>(.+?)</timeframe>.*?</role>}is', $mmatch[1], $matches)){
598                 $timeframe = $this->decode_timeframe($matches[1]);
599             }
600             if(preg_match('{<role\b.*?<extension>.*?<cohort>(.+?)</cohort>.*?</extension>.*?</role>}is', $mmatch[1], $matches)){
601                 $member->groupname = trim($matches[1]);
602                 // The actual processing (ensuring a group record exists, etc) occurs below, in the enrol-a-student clause
603             }
605             $rolecontext = get_context_instance(CONTEXT_COURSE, $ship->courseid);
606             $rolecontext = $rolecontext->id; // All we really want is the ID
607 //$this->log_line("Context instance for course $ship->courseid is...");
608 //print_r($rolecontext);
610             // Add or remove this student or teacher to the course...
611             $memberstoreobj->userid = $DB->get_field('user', 'id', array('idnumber'=>$member->idnumber));
612             $memberstoreobj->enrol = 'imsenterprise';
613             $memberstoreobj->course = $ship->courseid;
614             $memberstoreobj->time = time();
615             $memberstoreobj->timemodified = time();
616             if($memberstoreobj->userid){
618                 // Decide the "real" role (i.e. the Moodle role) that this user should be assigned to.
619                 // Zero means this roletype is supposed to be skipped.
620                 $moodleroleid = $this->rolemappings[$member->roletype];
621                 if(!$moodleroleid) {
622                     $this->log_line("SKIPPING role $member->roletype for $memberstoreobj->userid ($member->idnumber) in course $memberstoreobj->course");
623                     continue;
624                 }
626                 if(intval($member->status) == 1) {
627                     // Enrol the member
629                     $einstance = $DB->get_record('enrol',
630                                     array('courseid' => $courseobj->id, 'enrol' => $memberstoreobj->enrol));
631                     if (empty($einstance)) {
632                         // Only add an enrol instance to the course if non-existent
633                         $enrolid = $this->add_instance($courseobj);
634                         $einstance = $DB->get_record('enrol', array('id' => $enrolid));
635                     }
637                     $this->enrol_user($einstance, $memberstoreobj->userid, $moodleroleid, $timeframe->begin, $timeframe->end);
639                     $this->log_line("Enrolled user #$memberstoreobj->userid ($member->idnumber) to role $member->roletype in course $memberstoreobj->course");
640                     $memberstally++;
642                     // At this point we can also ensure the group membership is recorded if present
643                     if(isset($member->groupname)){
644                         // Create the group if it doesn't exist - either way, make sure we know the group ID
645                         if(isset($groupids[$member->groupname])) {
646                             $member->groupid = $groupids[$member->groupname]; // Recall the group ID from cache if available
647                         } else {
648                             if($groupid = $DB->get_field('groups', 'id', array('courseid'=>$ship->courseid, 'name'=>$member->groupname))){
649                                 $member->groupid = $groupid;
650                                 $groupids[$member->groupname] = $groupid; // Store ID in cache
651                             } else {
652                                 // Attempt to create the group
653                                 $group->name = $member->groupname;
654                                 $group->courseid = $ship->courseid;
655                                 $group->timecreated = time();
656                                 $group->timemodified = time();
657                                 $groupid = $DB->insert_record('groups', $group);
658                                 $this->log_line('Added a new group for this course: '.$group->name);
659                                 $groupids[$member->groupname] = $groupid; // Store ID in cache
660                                 $member->groupid = $groupid;
661                             }
662                         }
663                         // Add the user-to-group association if it doesn't already exist
664                         if($member->groupid) {
665                             groups_add_member($member->groupid, $memberstoreobj->userid);
666                         }
667                     } // End of group-enrolment (from member.role.extension.cohort tag)
669                 } elseif ($this->get_config('imsunenrol')) {
670                     // Unenrol member
672                     $einstances = $DB->get_records('enrol',
673                                     array('enrol' => $memberstoreobj->enrol, 'courseid' => $courseobj->id));
674                     foreach ($einstances as $einstance) {
675                         // Unenrol the user from all imsenterprise enrolment instances
676                         $this->unenrol_user($einstance, $memberstoreobj->userid);
677                     }
679                     $membersuntally++;
680                     $this->log_line("Unenrolled $member->idnumber from role $moodleroleid in course");
681                 }
683             }
684         }
685         $this->log_line("Added $memberstally users to course $ship->coursecode");
686         if($membersuntally > 0){
687             $this->log_line("Removed $membersuntally users from course $ship->coursecode");
688         }
689     }
690 } // End process_membership_tag()
692 /**
693 * Process the properties tag. The only data from this element
694 * that is relevant is whether a <target> is specified.
695 * @param string $tagconents The raw contents of the XML element
696 */
697 function process_properties_tag($tagcontents){
698     $imsrestricttarget = $this->get_config('imsrestricttarget');
700     if ($imsrestricttarget) {
701         if(!(preg_match('{<target>'.preg_quote($imsrestricttarget).'</target>}is', $tagcontents, $matches))){
702             $this->log_line("Skipping processing: required target \"$imsrestricttarget\" not specified in this data.");
703             $this->continueprocessing = false;
704         }
705     }
708 /**
709 * Store logging information. This does two things: uses the {@link mtrace()}
710 * function to print info to screen/STDOUT, and also writes log to a text file
711 * if a path has been specified.
712 * @param string $string Text to write (newline will be added automatically)
713 */
714 function log_line($string){
715     mtrace($string);
716     if($this->logfp) {
717         fwrite($this->logfp, $string . "\n");
718     }
721 /**
722 * Process the INNER contents of a <timeframe> tag, to return beginning/ending dates.
723 */
724 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
725     $ret->begin = $ret->end = 0;
726     // Explanatory note: The matching will ONLY match if the attribute restrict="1"
727     // because otherwise the time markers should be ignored (participation should be
728     // allowed outside the period)
729     if(preg_match('{<begin\s+restrict="1">(\d\d\d\d)-(\d\d)-(\d\d)</begin>}is', $string, $matches)){
730         $ret->begin = mktime(0,0,0, $matches[2], $matches[3], $matches[1]);
731     }
732     if(preg_match('{<end\s+restrict="1">(\d\d\d\d)-(\d\d)-(\d\d)</end>}is', $string, $matches)){
733         $ret->end = mktime(0,0,0, $matches[2], $matches[3], $matches[1]);
734     }
735     return $ret;
736 } // End decode_timeframe
738 /**
739 * Load the role mappings (from the config), so we can easily refer to
740 * how an IMS-E role corresponds to a Moodle role
741 */
742 function load_role_mappings() {
743     require_once('locallib.php');
744     global $DB;
746     $imsroles = new imsenterprise_roles();
747     $imsroles = $imsroles->get_imsroles();
749     $this->rolemappings = array();
750     foreach($imsroles as $imsrolenum=>$imsrolename) {
751         $this->rolemappings[$imsrolenum] = $this->rolemappings[$imsrolename] = $this->get_config('imsrolemap' . $imsrolenum);
752     }
755 } // end of class