(\d\d\d\d)-(\d\d)-(\d\d)}is', $string, $matches)){
- $ret->end = mktime(0,0,0, $matches[2], $matches[3], $matches[1]);
- }
- return $ret;
-} // End decode_timeframe
-
-/**
-* Load the role mappings (from the config), so we can easily refer to
-* how an IMS-E role corresponds to a Moodle role
-*/
-function load_role_mappings() {
- global $DB;
-
- $this->rolemappings = array();
- foreach($this->imsroles as $imsrolenum=>$imsrolename) {
- $this->rolemappings[$imsrolenum] = $this->rolemappings[$imsrolename]
- = $DB->get_field('config', 'value', array('name'=>'enrol_imse_imsrolemap' . $imsrolenum));
- }
-}
-
-} // end of class
-
-
diff --git a/enrol/imsenterprise/importnow.php b/enrol/imsenterprise/importnow.php
index 32267af..e9379bc 100644
--- a/enrol/imsenterprise/importnow.php
+++ b/enrol/imsenterprise/importnow.php
@@ -1,25 +1,29 @@
set_context(get_context_instance(CONTEXT_SYSTEM));
$PAGE->set_url('/enrol/imsenterprise/importnow.php');
-$PAGE->set_title("$site->shortname: $str->enrolments");
-$PAGE->set_heading($site->fullname);
-$PAGE->navbar->add($str->administration, new moodle_url('/admin/index.php'));
-$PAGE->navbar->add($str->enrolments);
-$PAGE->navbar->add('IMS import');
+$PAGE->set_title(get_string('importimsfile', 'enrol_imsenterprise'));
+$PAGE->set_heading(get_string('importimsfile', 'enrol_imsenterprise'));
+$PAGE->navbar->add(get_string('administrationsite'));
+$PAGE->navbar->add(get_string('plugins', 'admin'));
+$PAGE->navbar->add(get_string('enrolments', 'enrol'));
+$PAGE->navbar->add(get_string('pluginname', 'enrol_imsenterprise'), new moodle_url('/admin/settings.php', array('section'=>'enrolsettingsimsenterprise')));
+$PAGE->navbar->add(get_string('importimsfile', 'enrol_imsenterprise'));
+$PAGE->navigation->clear_cache();
+
echo $OUTPUT->header();
-require_once('enrol.php');
+require_once('lib.php');
//echo "Creating the IMS Enterprise enroller object\n";
-$enrol = new enrolment_plugin_imsenterprise();
+$enrol = new enrol_imsenterprise_plugin();
?>
Launching the IMS Enterprise "cron" function. The import log will appear below (giving details of any
diff --git a/enrol/imsenterprise/lang/en/enrol_imsenterprise.php b/enrol/imsenterprise/lang/en/enrol_imsenterprise.php
index a81ad1c..1905862 100644
--- a/enrol/imsenterprise/lang/en/enrol_imsenterprise.php
+++ b/enrol/imsenterprise/lang/en/enrol_imsenterprise.php
@@ -42,9 +42,9 @@ Users are searched for first by their "idnumber", and second by their Moodle use
$string['cronfrequency'] = 'Frequency of processing';
$string['deleteusers'] = 'Delete user accounts when specified in IMS data';
$string['deleteusers_help'] = 'If enabled, IMS Enterprise enrolment data can specify the deletion of user accounts (if the "recstatus" flag is set to 3, which represents deletion of an account). As is standard in Moodle, the user record isn\'t actually deleted from Moodle\'s database, but a flag is set to mark the account as deleted.';
-$string['description'] = 'This method will repeatedly check for and process a specially-formatted text file in the location that you specify. The file must follow the IMS Enterprise specifications containing person, group, and membership XML elements.';
+$string['pluginname_desc'] = 'This method will repeatedly check for and process a specially-formatted text file in the location that you specify. The file must follow the IMS Enterprise specifications containing person, group, and membership XML elements.';
$string['doitnow'] = 'perform an IMS Enterprise import right now';
-$string['enrolname'] = 'IMS Enterprise file';
+$string['pluginname'] = 'IMS Enterprise file';
$string['filelockedmail'] = 'The text file you are using for IMS-file-based enrolments ({$a}) can not be deleted by the cron process. This usually means the permissions are wrong on it. Please fix the permissions so that Moodle can delete the file, otherwise it might be processed repeatedly.';
$string['filelockedmailsubject'] = 'Important error: Enrolment file';
$string['fixcasepersonalnames'] = 'Change personal names to Title Case';
@@ -71,3 +71,6 @@ $string['usecapitafix'] = 'Tick this box if using "Capita" (their XML
$string['usecapitafix_help'] = 'The student data system produced by Capita has been found to have one slight error in its XML output. If you are using Capita you should enable this setting - otherwise leave it un-ticked.';
$string['usersettings'] = 'User data options';
$string['zeroisnotruncation'] = '0 indicates no truncation';
+$string['roles'] = 'Roles';
+$string['ignore'] = 'Ignore';
+$string['importimsfile'] = 'Import IMS Enterprise file';
diff --git a/enrol/imsenterprise/lib.php b/enrol/imsenterprise/lib.php
new file mode 100644
index 0000000..84ddb7c
--- /dev/null
+++ b/enrol/imsenterprise/lib.php
@@ -0,0 +1,762 @@
+.
+
+/**
+ * IMS Enterprise file enrolment plugin.
+ *
+ * This plugin lets the user specify an IMS Enterprise file to be processed.
+ * The IMS Enterprise file is mainly parsed on a regular cron,
+ * but can also be imported via the UI (Admin Settings).
+ * @package enrol_imsenterprise
+ * @copyright 2010 Eugene Venter
+ * @author Eugene Venter - based on code by Dan Stowell
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/*
+
+Note for programmers:
+
+This class uses regular expressions to mine the data file. The main reason is
+that XML handling changes from PHP 4 to PHP 5, so this should work on both.
+
+One drawback is that the pattern-matching doesn't (currently) handle XML
+namespaces - it only copes with a tag if it says , and not
+(for example) .
+
+This should also be able to handle VERY LARGE FILES - so the entire IMS file is
+NOT loaded into memory at once. It's handled line-by-line, 'forgetting' tags as
+soon as they are processed.
+
+N.B. The "sourcedid" ID code is translated to Moodle's "idnumber" field, both
+for users and for courses.
+
+*/
+
+require_once($CFG->dirroot.'/group/lib.php');
+
+
+class enrol_imsenterprise_plugin extends enrol_plugin {
+
+var $log;
+
+
+/**
+* Read in an IMS Enterprise file.
+* Originally designed to handle v1.1 files but should be able to handle
+* earlier types as well, I believe.
+*
+*/
+function cron() {
+ global $CFG;
+
+ // Get configs
+ $imsfilelocation = $this->get_config('imsfilelocation');
+ $logtolocation = $this->get_config('logtolocation');
+ $mailadmins = $this->get_config('mailadmins');
+ $prev_time = $this->get_config('prev_time');
+ $prev_md5 = $this->get_config('prev_md5');
+ $prev_path = $this->get_config('prev_path');
+
+ if (empty($imsfilelocation)) {
+ // $filename = "$CFG->dirroot/enrol/imsenterprise/example.xml"; // Default location
+ $filename = "$CFG->dataroot/1/imsenterprise-enrol.xml"; // Default location
+ } else {
+ $filename = $imsfilelocation;
+ }
+
+ $this->logfp = false; // File pointer for writing log data to
+ if(!empty($logtolocation)) {
+ $this->logfp = fopen($logtolocation, 'a');
+ }
+
+ if ( file_exists($filename) ) {
+ @set_time_limit(0);
+ $starttime = time();
+
+ $this->log_line('----------------------------------------------------------------------');
+ $this->log_line("IMS Enterprise enrol cron process launched at " . userdate(time()));
+ $this->log_line('Found file '.$filename);
+ $this->xmlcache = '';
+
+ // Make sure we understand how to map the IMS-E roles to Moodle roles
+ $this->load_role_mappings();
+
+ $md5 = md5_file($filename); // NB We'll write this value back to the database at the end of the cron
+ $filemtime = filemtime($filename);
+
+ // Decide if we want to process the file (based on filepath, modification time, and MD5 hash)
+ // This is so we avoid wasting the server's efforts processing a file unnecessarily
+ if(empty($prev_path) || ($filename != $prev_path)) {
+ $fileisnew = true;
+ } elseif(isset($prev_time) && ($filemtime <= $prev_time)) {
+ $fileisnew = false;
+ $this->log_line('File modification time is not more recent than last update - skipping processing.');
+ } elseif(isset($prev_md5) && ($md5 == $prev_md5)) {
+ $fileisnew = false;
+ $this->log_line('File MD5 hash is same as on last update - skipping processing.');
+ } else {
+ $fileisnew = true; // Let's process it!
+ }
+
+ if($fileisnew) {
+
+ $listoftags = array('group', 'person', 'member', 'membership', 'comments', 'properties'); // The list of tags which should trigger action (even if only cache trimming)
+ $this->continueprocessing = true; // The tag is allowed to halt processing if we're demanding a matching target
+
+ // FIRST PASS: Run through the file and process the group/person entries
+ if (($fh = fopen($filename, "r")) != false) {
+
+ $line = 0;
+ while ((!feof($fh)) && $this->continueprocessing) {
+
+ $line++;
+ $curline = fgets($fh);
+ $this->xmlcache .= $curline; // Add a line onto the XML cache
+
+ while (true) {
+ // If we've got a full tag (i.e. the most recent line has closed the tag) then process-it-and-forget-it.
+ // Must always make sure to remove tags from cache so they don't clog up our memory
+ if($tagcontents = $this->full_tag_found_in_cache('group', $curline)) {
+ $this->process_group_tag($tagcontents);
+ $this->remove_tag_from_cache('group');
+ } elseif($tagcontents = $this->full_tag_found_in_cache('person', $curline)) {
+ $this->process_person_tag($tagcontents);
+ $this->remove_tag_from_cache('person');
+ } elseif($tagcontents = $this->full_tag_found_in_cache('membership', $curline)) {
+ $this->process_membership_tag($tagcontents);
+ $this->remove_tag_from_cache('membership');
+ } elseif($tagcontents = $this->full_tag_found_in_cache('comments', $curline)) {
+ $this->remove_tag_from_cache('comments');
+ } elseif($tagcontents = $this->full_tag_found_in_cache('properties', $curline)) {
+ $this->process_properties_tag($tagcontents);
+ $this->remove_tag_from_cache('properties');
+ } else {
+ break;
+ }
+ } // End of while-tags-are-detected
+ } // end of while loop
+ fclose($fh);
+ fix_course_sortorder();
+ } // end of if(file_open) for first pass
+
+ /*
+
+
+ SECOND PASS REMOVED
+ Since the IMS specification v1.1 insists that "memberships" should come last,
+ and since vendors seem to have done this anyway (even with 1.0),
+ we can sensibly perform the import in one fell swoop.
+
+
+ // SECOND PASS: Now go through the file and process the membership entries
+ $this->xmlcache = '';
+ if (($fh = fopen($filename, "r")) != false) {
+ $line = 0;
+ while ((!feof($fh)) && $this->continueprocessing) {
+ $line++;
+ $curline = fgets($fh);
+ $this->xmlcache .= $curline; // Add a line onto the XML cache
+
+ while(true){
+ // Must always make sure to remove tags from cache so they don't clog up our memory
+ if($tagcontents = $this->full_tag_found_in_cache('group', $curline)){
+ $this->remove_tag_from_cache('group');
+ }elseif($tagcontents = $this->full_tag_found_in_cache('person', $curline)){
+ $this->remove_tag_from_cache('person');
+ }elseif($tagcontents = $this->full_tag_found_in_cache('membership', $curline)){
+ $this->process_membership_tag($tagcontents);
+ $this->remove_tag_from_cache('membership');
+ }elseif($tagcontents = $this->full_tag_found_in_cache('comments', $curline)){
+ $this->remove_tag_from_cache('comments');
+ }elseif($tagcontents = $this->full_tag_found_in_cache('properties', $curline)){
+ $this->remove_tag_from_cache('properties');
+ }else{
+ break;
+ }
+ }
+ } // end of while loop
+ fclose($fh);
+ } // end of if(file_open) for second pass
+
+
+ */
+
+ $timeelapsed = time() - $starttime;
+ $this->log_line('Process has completed. Time taken: '.$timeelapsed.' seconds.');
+
+
+ } // END of "if file is new"
+
+
+ // These variables are stored so we can compare them against the IMS file, next time round.
+ $this->set_config('prev_time', $filemtime);
+ $this->set_config('prev_md5', $md5);
+ $this->set_config('prev_path', $filename);
+
+
+
+ }else{ // end of if(file_exists)
+ $this->log_line('File not found: '.$filename);
+ }
+
+ if (!empty($mailadmins)) {
+ $msg = "An IMS enrolment has been carried out within Moodle.\nTime taken: $timeelapsed seconds.\n\n";
+ if(!empty($logtolocation)){
+ if($this->logfp){
+ $msg .= "Log data has been written to:\n";
+ $msg .= "$logtolocation\n";
+ $msg .= "(Log file size: ".ceil(filesize($logtolocation)/1024)."Kb)\n\n";
+ }else{
+ $msg .= "The log file appears not to have been successfully written.\nCheck that the file is writeable by the server:\n";
+ $msg .= "$logtolocation\n\n";
+ }
+ }else{
+ $msg .= "Logging is currently not active.";
+ }
+
+ $eventdata = new object();
+ $eventdata->modulename = 'moodle';
+ $eventdata->component = 'imsenterprise';
+ $eventdata->name = 'imsenterprise_enrolment';
+ $eventdata->userfrom = get_admin();
+ $eventdata->userto = get_admin();
+ $eventdata->subject = "Moodle IMS Enterprise enrolment notification";
+ $eventdata->fullmessage = $msg;
+ $eventdata->fullmessageformat = FORMAT_PLAIN;
+ $eventdata->fullmessagehtml = '';
+ $eventdata->smallmessage = '';
+ message_send($eventdata);
+
+ $this->log_line('Notification email sent to administrator.');
+
+ }
+
+ if($this->logfp){
+ fclose($this->logfp);
+ }
+
+
+} // end of cron() function
+
+/**
+* Check if a complete tag is found in the cached data, which usually happens
+* when the end of the tag has only just been loaded into the cache.
+* Returns either false, or the contents of the tag (including start and end).
+* @param string $tagname Name of tag to look for
+* @param string $latestline The very last line in the cache (used for speeding up the match)
+*/
+function full_tag_found_in_cache($tagname, $latestline){ // Return entire element if found. Otherwise return false.
+ if(strpos(strtolower($latestline), '')===false){
+ return false;
+ }elseif(preg_match('{(<'.$tagname.'\b.*?>.*?)}is', $this->xmlcache, $matches)){
+ return $matches[1];
+ }else return false;
+}
+
+/**
+* Remove complete tag from the cached data (including all its contents) - so
+* that the cache doesn't grow to unmanageable size
+* @param string $tagname Name of tag to look for
+*/
+function remove_tag_from_cache($tagname){ // Trim the cache so we're not in danger of running out of memory.
+ ///echo "remove_tag_from_cache: $tagname
"; flush(); ob_flush();
+ // echo "remove_tag_from_cache:
".htmlspecialchars($this->xmlcache);
+ $this->xmlcache = trim(preg_replace('{<'.$tagname.'\b.*?>.*?}is', '', $this->xmlcache, 1)); // "1" so that we replace only the FIRST instance
+ // echo "
".htmlspecialchars($this->xmlcache)."
";
+}
+
+/**
+* Very simple convenience function to return the "recstatus" found in person/group/role tags.
+* 1=Add, 2=Update, 3=Delete, as specified by IMS, and we also use 0 to indicate "unspecified".
+* @param string $tagdata the tag XML data
+* @param string $tagname the name of the tag we're interested in
+*/
+function get_recstatus($tagdata, $tagname){
+ if(preg_match('{<'.$tagname.'\b[^>]*recstatus\s*=\s*["\'](\d)["\']}is', $tagdata, $matches)){
+ // echo "get_recstatus($tagname) found status of $matches[1]
";
+ return intval($matches[1]);
+ }else{
+ // echo "get_recstatus($tagname) found nothing
";
+ return 0; // Unspecified
+ }
+}
+
+/**
+* Process the group tag. This defines a Moodle course.
+* @param string $tagconents The raw contents of the XML element
+*/
+function process_group_tag($tagcontents){
+ global $DB;
+
+ // Get configs
+ $truncatecoursecodes = $this->get_config('truncatecoursecodes');
+ $createnewcourses = $this->get_config('createnewcourses');
+ $createnewcategories = $this->get_config('createnewcategories');
+
+ // Process tag contents
+ unset($group);
+ if(preg_match('{.*?(.+?).*?}is', $tagcontents, $matches)){
+ $group->coursecode = trim($matches[1]);
+ }
+ if(preg_match('{.*?(.*?).*?}is', $tagcontents, $matches)){
+ $group->description = trim($matches[1]);
+ }
+ if(preg_match('{.*?(.*?).*?}is', $tagcontents, $matches)){
+ $group->category = trim($matches[1]);
+ }
+
+ $recstatus = ($this->get_recstatus($tagcontents, 'group'));
+ //echo "get_recstatus for this group returned $recstatus
";
+
+ if(!(strlen($group->coursecode)>0)){
+ $this->log_line('Error at line '.$line.': Unable to find course code in \'group\' element.');
+ }else{
+ // First, truncate the course code if desired
+ if(intval($truncatecoursecodes)>0){
+ $group->coursecode = ($truncatecoursecodes > 0)
+ ? substr($group->coursecode, 0, intval($truncatecoursecodes))
+ : $group->coursecode;
+ }
+
+ /* -----------Course aliasing is DEACTIVATED until a more general method is in place---------------
+
+ // Second, look in the course alias table to see if the code should be translated to something else
+ if($aliases = $DB->get_field('enrol_coursealias', 'toids', array('fromid'=>$group->coursecode))){
+ $this->log_line("Found alias of course code: Translated $group->coursecode to $aliases");
+ // Alias is allowed to be a comma-separated list, so let's split it
+ $group->coursecode = explode(',', $aliases);
+ }
+ */
+
+ // For compatibility with the (currently inactive) course aliasing, we need this to be an array
+ $group->coursecode = array($group->coursecode);
+
+ // Third, check if the course(s) exist
+ foreach($group->coursecode as $coursecode){
+ $coursecode = trim($coursecode);
+ if(!$DB->get_field('course', 'id', array('idnumber'=>$coursecode))) {
+ if(!$createnewcourses) {
+ $this->log_line("Course $coursecode not found in Moodle's course idnumbers.");
+ } else {
+ // Create the (hidden) course(s) if not found
+ $course = new object();
+ $course->fullname = $group->description;
+ $course->shortname = $coursecode;
+ $course->idnumber = $coursecode;
+ $course->format = 'topics';
+ $course->visible = 0;
+ // Insert default names for teachers/students, from the current language
+ $site = get_site();
+
+ // Handle course categorisation (taken from the group.org.orgunit field if present)
+ if(strlen($group->category)>0){
+ // If the category is defined and exists in Moodle, we want to store it in that one
+ if($catid = $DB->get_field('course_categories', 'id', array('name'=>$group->category))){
+ $course->category = $catid;
+ } elseif($createnewcategories) {
+ // Else if we're allowed to create new categories, let's create this one
+ $newcat->name = $group->category;
+ $newcat->visible = 0;
+ if($catid = $DB->insert_record('course_categories', $newcat)){
+ $course->category = $catid;
+ $this->log_line("Created new (hidden) category, #$catid: $newcat->name");
+ }else{
+ $this->log_line('Failed to create new category: '.$newcat->name);
+ }
+ }else{
+ // If not found and not allowed to create, stick with default
+ $this->log_line('Category '.$group->category.' not found in Moodle database, so using default category instead.');
+ $course->category = 1;
+ }
+ }else{
+ $course->category = 1;
+ }
+ $course->timecreated = time();
+ $course->startdate = time();
+ $course->numsections = 1;
+ // Choose a sort order that puts us at the start of the list!
+ $course->sortorder = 0;
+
+ if ($courseid = $DB->insert_record('course', $course)) {
+
+ // Setup the blocks
+ $course = $DB->get_record('course', array('id' => $courseid));
+ blocks_add_default_course_blocks($course);
+
+ $section = new object();
+ $section->course = $course->id; // Create a default section.
+ $section->section = 0;
+ $section->summaryformat = FORMAT_HTML;
+ $section->id = $DB->insert_record("course_sections", $section);
+
+ add_to_log(SITEID, "course", "new", "view.php?id=$course->id", "$course->fullname (ID $course->id)");
+
+ $this->log_line("Created course $coursecode in Moodle (Moodle ID is $course->id)");
+ }else{
+ $this->log_line('Failed to create course '.$coursecode.' in Moodle');
+ }
+ }
+ }elseif($recstatus==3 && ($courseid = $DB->get_field('course', 'id', array('idnumber'=>$coursecode)))){
+ // If course does exist, but recstatus==3 (delete), then set the course as hidden
+ $DB->set_field('course', 'visible', '0', array('id'=>$courseid));
+ }
+ } // End of foreach(coursecode)
+ }
+} // End process_group_tag()
+
+/**
+* Process the person tag. This defines a Moodle user.
+* @param string $tagconents The raw contents of the XML element
+*/
+function process_person_tag($tagcontents){
+ global $CFG, $DB;
+
+ // Get plugin configs
+ $imssourcedidfallback = $this->get_config('imssourcedidfallback');
+ $fixcaseusernames = $this->get_config('fixcaseusernames');
+ $fixcasepersonalnames = $this->get_config('fixcasepersonalnames');
+ $imsdeleteusers = $this->get_config('imsdeleteusers');
+ $createnewusers = $this->get_config('createnewusers');
+
+ if(preg_match('{.*?(.+?).*?}is', $tagcontents, $matches)){
+ $person->idnumber = trim($matches[1]);
+ }
+ if(preg_match('{.*?.*?(.+?).*?.*?}is', $tagcontents, $matches)){
+ $person->firstname = trim($matches[1]);
+ }
+ if(preg_match('{.*?.*?(.+?).*?.*?}is', $tagcontents, $matches)){
+ $person->lastname = trim($matches[1]);
+ }
+ if(preg_match('{(.*?)}is', $tagcontents, $matches)){
+ $person->username = trim($matches[1]);
+ }
+ if($imssourcedidfallback && trim($person->username)==''){
+ // This is the point where we can fall back to useing the "sourcedid" if "userid" is not supplied
+ // NB We don't use an "elseif" because the tag may be supplied-but-empty
+ $person->username = $person->idnumber;
+ }
+ if(preg_match('{(.*?)}is', $tagcontents, $matches)){
+ $person->email = trim($matches[1]);
+ }
+ if(preg_match('{(.*?)}is', $tagcontents, $matches)){
+ $person->url = trim($matches[1]);
+ }
+ if(preg_match('{.*?(.+?).*?}is', $tagcontents, $matches)){
+ $person->city = trim($matches[1]);
+ }
+ if(preg_match('{.*?(.+?).*?}is', $tagcontents, $matches)){
+ $person->country = trim($matches[1]);
+ }
+
+ // Fix case of some of the fields if required
+ if($fixcaseusernames && isset($person->username)){
+ $person->username = strtolower($person->username);
+ }
+ if($fixcasepersonalnames){
+ if(isset($person->firstname)){
+ $person->firstname = ucwords(strtolower($person->firstname));
+ }
+ if(isset($person->lastname)){
+ $person->lastname = ucwords(strtolower($person->lastname));
+ }
+ }
+
+ $recstatus = ($this->get_recstatus($tagcontents, 'person'));
+
+
+ // Now if the recstatus is 3, we should delete the user if-and-only-if the setting for delete users is turned on
+ // In the "users" table we can do this by setting deleted=1
+ if($recstatus==3){
+
+ if($imsdeleteusers){ // If we're allowed to delete user records
+ // Make sure their "deleted" field is set to one
+ $DB->set_field('user', 'deleted', 1, array('username'=>$person->username));
+ $this->log_line("Marked user record for user '$person->username' (ID number $person->idnumber) as deleted.");
+ }else{
+ $this->log_line("Ignoring deletion request for user '$person->username' (ID number $person->idnumber).");
+ }
+
+ }else{ // Add or update record
+
+
+ // If the user exists (matching sourcedid) then we don't need to do anything.
+ if(!$DB->get_field('user', 'id', array('idnumber'=>$person->idnumber)) && $createnewusers){
+ // If they don't exist and haven't a defined username, we log this as a potential problem.
+ if((!isset($person->username)) || (strlen($person->username)==0)){
+ $this->log_line("Cannot create new user for ID # $person->idnumber - no username listed in IMS data for this person.");
+ } else if ($DB->get_field('user', 'id', array('username'=>$person->username))){
+ // If their idnumber is not registered but their user ID is, then add their idnumber to their record
+ $DB->set_field('user', 'idnumber', $person->idnumber, array('username'=>$person->username));
+ } else {
+
+ // If they don't exist and they have a defined username, and $createnewusers == true, we create them.
+ $person->lang = 'manual'; //TODO: this needs more work due tu multiauth changes
+ $person->auth = $CFG->auth;
+ $person->confirmed = 1;
+ $person->timemodified = time();
+ $person->mnethostid = $CFG->mnet_localhost_id;
+ if($id = $DB->insert_record('user', $person)){
+ /*
+ Photo processing is deactivated until we hear from Moodle dev forum about modification to gdlib.
+
+ //Antoni Mas. 07/12/2005. If a photo URL is specified then we might want to load
+ // it into the user's profile. Beware that this may cause a heavy overhead on the server.
+ if($CFG->enrol_processphoto){
+ if(preg_match('{.*?(.*?).*?}is', $tagcontents, $matches)){
+ $person->urlphoto = trim($matches[1]);
+ }
+ //Habilitam el flag que ens indica que el personatge t foto prpia.
+ $person->picture = 1;
+ //Llibreria creada per nosaltres mateixos.
+ require_once($CFG->dirroot.'/lib/gdlib.php');
+ if ($usernew->picture = save_profile_image($id, $person->urlphoto,'user')) {
+ $DB->set_field('user', 'picture', $usernew->picture, array('id'=>$id)); /// Note picture in DB
+ }
+ }
+ */
+ $this->log_line("Created user record for user '$person->username' (ID number $person->idnumber).");
+ }else{
+ $this->log_line("Database error while trying to create user record for user '$person->username' (ID number $person->idnumber).");
+ }
+ }
+ } elseif ($createnewusers) {
+ $this->log_line("User record already exists for user '$person->username' (ID number $person->idnumber).");
+
+ // Make sure their "deleted" field is set to zero.
+ $DB->set_field('user', 'deleted', 0, array('idnumber'=>$person->idnumber));
+ }else{
+ $this->log_line("No user record found for '$person->username' (ID number $person->idnumber).");
+ }
+
+ } // End of are-we-deleting-or-adding
+
+} // End process_person_tag()
+
+/**
+* Process the membership tag. This defines whether the specified Moodle users
+* should be added/removed as teachers/students.
+* @param string $tagconents The raw contents of the XML element
+*/
+function process_membership_tag($tagcontents){
+ global $DB;
+
+ // Get plugin configs
+ $truncatecoursecodes = $this->get_config('truncatecoursecodes');
+ $imscapitafix = $this->get_config('imscapitafix');
+
+ $memberstally = 0;
+ $membersuntally = 0;
+
+ // In order to reduce the number of db queries required, group name/id associations are cached in this array:
+ $groupids = array();
+
+ if(preg_match('{.*?(.+?).*?}is', $tagcontents, $matches)){
+ $ship->coursecode = ($truncatecoursecodes > 0)
+ ? substr(trim($matches[1]), 0, intval($truncatecoursecodes))
+ : trim($matches[1]);
+ $ship->courseid = $DB->get_field('course', 'id', array('idnumber'=>$ship->coursecode));
+ }
+ if($ship->courseid && preg_match_all('{(.*?)}is', $tagcontents, $membermatches, PREG_SET_ORDER)){
+ $courseobj = new stdClass();
+ $courseobj->id = $ship->courseid;
+
+ foreach($membermatches as $mmatch){
+ unset($member);
+ unset($memberstoreobj);
+ if(preg_match('{.*?(.+?).*?}is', $mmatch[1], $matches)){
+ $member->idnumber = trim($matches[1]);
+ }
+ if(preg_match('{}is', $mmatch[1], $matches)){
+ $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
+ } elseif($imscapitafix && preg_match('{(.+?)}is', $mmatch[1], $matches)){
+ // The XML that comes out of Capita Student Records seems to contain a misinterpretation of the IMS specification!
+ $member->roletype = trim($matches[1]); // 01 means Student, 02 means Instructor, 3 means ContentDeveloper, and there are more besides
+ }
+ if(preg_match('{(.+?).*?}is', $mmatch[1], $matches)){
+ $member->status = trim($matches[1]); // 1 means active, 0 means inactive - treat this as enrol vs unenrol
+ }
+
+ $recstatus = ($this->get_recstatus($mmatch[1], 'role'));
+ if($recstatus==3){
+ $member->status = 0; // See above - recstatus of 3 (==delete) is treated the same as status of 0
+ //echo "process_membership_tag: unenrolling member due to recstatus of 3
";
+ }
+
+ $timeframe->begin = 0;
+ $timeframe->end = 0;
+ if(preg_match('{(.+?)