New setting for identification use

common/lib.php

@@ -85,15 +85,15 @@ function equella_getssotoken($course = null) {
             // see if the user has a role that is linked to an equella role
             $shareid = $CFG->{"equella_{$role->shortname}_shareid"};
             if (!empty($shareid)) {
-                return equella_getssotoken_raw($USER->username, $shareid, $CFG->{"equella_{$role->shortname}_sharedsecret"});
+                return equella_getssotoken_raw($USER->equellauser, $shareid, $CFG->{"equella_{$role->shortname}_sharedsecret"});
             }
         }
     }
 
     // no roles found, use the default shareid and secret
     $shareid = $CFG->equella_shareid;
     if (!empty($shareid)) {
-        return equella_getssotoken_raw($USER->username, $shareid, $CFG->equella_sharedsecret);
+        return equella_getssotoken_raw($USER->equellauser, $shareid, $CFG->equella_sharedsecret);
     }
 }
 

lang/en/equella.php

@@ -70,6 +70,10 @@
    1. Use "selectOrAdd" for EQUELLA 6.0 and older, for EQUELLA 6.1 onward please use "structured"
    2. There should not be a ? or a & at the start or end of the string.';
 
+$string['config.userfield.title'] = 'User field to use';
+$string['config.userfield.desc'] = 'Choose the user field to be used instead of username';
+$string['config.userfield.username'] = 'Username';
+
 $string['config.restriction.title'] = 'Restrict selections';
 $string['config.restriction.desc'] = 'Choose whether course editors should only be able to select items, attachments, packages or anything. Please note that the restrictions only working for EQUELLA 6.0 and higher.';
 $string['config.restriction.none'] = 'No restrictions';

lib.php

@@ -635,3 +635,17 @@ function equella_grade_item_delete($eq) {
     return grade_update(EQUELLA_SOURCE, $eq->courseid, EQUELLA_ITEM_TYPE, EQUELLA_ITEM_MODULE, $eq->id, 0, NULL, array('deleted'=>1));
 }
 
+/**
+ * Select the corresponding field to allocate the username to $USER
+ */
+function mod_equella_after_config(){
+    global $USER, $CFG;
+    if(!isset($USER->equellauser) && isset($USER->username)) {
+        $userfield = $CFG->equella_userfield;
+        if ($userfield != 'default' && isset($USER->profile[$userfield])) {
+            $USER->equellauser = $USER->profile[$userfield];
+        } else {
+            $USER->equellauser = $USER->username;
+        }
+    }
+}

locallib.php

@@ -310,7 +310,7 @@ function equella_lti_params($equella, $course, $extra = array()) {
     $requestparams['lis_person_name_family'] = $USER->lastname;
     $requestparams['lis_person_name_full'] = fullname($USER);
     $requestparams['lis_person_contact_email_primary'] = $USER->email;
-    $requestparams['lis_person_sourcedid'] = $USER->username;
+    $requestparams['lis_person_sourcedid'] = $USER->equellauser;
     $requestparams["ext_lms"] = "moodle-2";
     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
@@ -351,7 +351,7 @@ function equella_add_lmsinfo_parameters(&$params, $course, $contributiontype) {
     $params['course/fullname'] = $course->fullname;
     $params['course/shortname'] = $course->shortname;
     $params['course/code'] = $course->idnumber;
-    $params['user/username'] = $USER->username;
+    $params['user/username'] = $USER->equellauser;
     $params['user/firstname'] = $USER->firstname;
     $params['user/lastname'] = $USER->lastname;
     //$params['moodle/section'] = get_section_name($course, $sectionid));

ltilaunch.php

@@ -104,7 +104,7 @@ function get_item_xml($course, $sectionid) {
 
     // User
     $integuserxml = $integxml->addChild('user');
-    $integuserxml->addChild('username', $USER->username);
+    $integuserxml->addChild('username', $USER->equellauser);
     $integuserxml->addChild('firstname', $USER->firstname);
     $integuserxml->addChild('lastname', $USER->lastname);
 

settings.php

@@ -38,6 +38,13 @@ function ecs($configoption, $params = null) {
     $settings->add(new admin_setting_configtext('equella_url', ecs('url.title'), ecs('url.desc'), ''));
     $settings->add(new admin_setting_configtext('equella_action', ecs('action.title'), ecs('action.desc'), ''));
 
+    $userfieldoptions = array();
+    $userfieldoptions = array('default' => ecs('userfield.username'));
+    foreach($DB->get_records('user_info_field') as $params){
+        $userfieldoptions[$params->shortname] = $params->name;
+    }
+    $settings->add(new admin_setting_configselect('equella_userfield', ecs('userfield.title'), ecs('userfield.desc'), 'default', $userfieldoptions));
+
     $restrictionOptions = array(EQUELLA_CONFIG_SELECT_RESTRICT_NONE => trim(ecs('restriction.none')),EQUELLA_CONFIG_SELECT_RESTRICT_ITEMS_ONLY => trim(ecs('restriction.itemsonly')),EQUELLA_CONFIG_SELECT_RESTRICT_ATTACHMENTS_ONLY => trim(ecs('restriction.attachmentsonly')),
         EQUELLA_CONFIG_SELECT_RESTRICT_PACKAGES_ONLY => trim(ecs('restriction.packagesonly')));
 

version.php

@@ -15,7 +15,7 @@
 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2023070300;
+$plugin->version   = 2023070300.3;
 $plugin->requires  = 2014041101;    // Requires this Moodle version
 $plugin->component = 'mod_equella'; // Full name of the plugin (used for diagnostics)
 $plugin->release = '1.3.1';