ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes
ilUserImportParser Class Reference

User Import Parser. More...

+ Inheritance diagram for ilUserImportParser:
+ Collaboration diagram for ilUserImportParser:

Public Member Functions

 ilUserImportParser ($a_xml_file= '', $a_mode=IL_USER_IMPORT, $a_conflict_rule=IL_FAIL_ON_CONFLICT)
 Constructor.
 setFolderId ($a_folder_id)
 assign users to this folder (normally the usr_folder) But if called from local admin => the ref_id of the category public
 getFolderId ()
 setHandlers ($a_xml_parser)
 set event handler should be overwritten by inherited class private
 startParsing ()
 start the parser
 setRoleAssignment ($a_assign)
 set import to local role assignemt
 buildTag ($type, $name, $attr="")
 generate a tag with given name and attributes
 handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
 handler for begin of element
 extractRolesBeginTag ($a_xml_parser, $a_name, $a_attribs)
 handler for begin of element in extract roles mode
 importBeginTag ($a_xml_parser, $a_name, $a_attribs)
 handler for begin of element in user import mode
 verifyBeginTag ($a_xml_parser, $a_name, $a_attribs)
 handler for begin of element
 handlerEndTag ($a_xml_parser, $a_name)
 handler for end of element
 extractRolesEndTag ($a_xml_parser, $a_name)
 handler for end of element when in extract roles mode.
 getRoleObject ($a_role_id)
 Returns the parent object of the role folder object which contains the specified role.
 getCourseMembersObjectForRole ($a_role_id)
 Returns the parent object of the role folder object which contains the specified role.
 assignToRole ($a_user_obj, $a_role_id)
 Assigns a user to a role.
 getParentRoleIds ($a_role_id)
 Get array of parent role ids from cache.
 assignToRoleWithParents ($a_user_obj, $a_role_id)
 Assigns a user to a role and to all parent roles.
 detachFromRole ($a_user_obj, $a_role_id)
 Detachs a user from a role.
 importEndTag ($a_xml_parser, $a_name)
 handler for end of element when in import user mode.
 saveTempImage ($image_data, $filename)
 Saves binary image data to a temporary image file and returns the name of the image file on success.
 verifyEndTag ($a_xml_parser, $a_name)
 handler for end of element when in verify mode.
 handlerCharacterData ($a_xml_parser, $a_data)
 handler for character data
 getCollectedRoles ()
 get collected roles
 getUserCount ()
 get count of User elements
 logWarning ($aLogin, $aMessage)
 Writes a warning log message to the protocol.
 logFailure ($aLogin, $aMessage)
 Writes a failure log message to the protocol.
 logSuccess ($aLogin, $userid, $action)
 Writes a success log message to the protocol.
 getProtocol ()
 Returns the protocol.
 getProtocolAsHTML ($a_log_title)
 Returns the protocol as a HTML table.
 isSuccess ()
 Returns true, if the import was successful.
 getErrorLevel ()
 Returns the error level.
 getUserMapping ()
 returns a map user_id <=> login
 sendAccountMail ()
 send account mail
 setSendMail ($value)
 write access to property send mail
 isSendMail ()
 read access to property send mail
 setUserMappingMode ($value)
 write access to user mapping mode
 getUserMappingMode ()
 read access to user mapping mode
- Public Member Functions inherited from ilSaxParser
 ilSaxParser ($a_xml_file= '', $throwException=false)
 Constructor setup ILIAS global object public.
 setXMLContent ($a_xml_content)
 getXMLContent ()
 getInputType ()
 createParser ()
 create parser
 setOptions ($a_xml_parser)
 set parser options
 openXMLFile ()
 open xml file
 parse ($a_xml_parser, $a_fp=null)
 parse xml file
 freeParser ($a_xml_parser)
 free xml parser handle
 setThrowException ($throwException)
 set error handling
- Public Member Functions inherited from PEAR
 PEAR ($error_class=null)
 Constructor.
 _PEAR ()
 Destructor (the emulated type of...).
& getStaticProperty ($class, $var)
 If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them.
 registerShutdownFunc ($func, $args=array())
 Use this function to register a shutdown method for static classes.
 isError ($data, $code=null)
 Tell whether a value is a PEAR error.
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled.
 expectError ($code= '*')
 This method is used to tell which errors you expect to get.
 popExpect ()
 This method pops one element off the expected error codes stack.
 _checkDelExpect ($error_code)
 This method checks unsets an error code if available.
 delExpect ($error_code)
 This method deletes all occurences of the specified element from the expected error codes stack.
& raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
 This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied.
& throwError ($message=null, $code=null, $userinfo=null)
 Simpler form of raiseError with fewer options.
 staticPushErrorHandling ($mode, $options=null)
 staticPopErrorHandling ()
 pushErrorHandling ($mode, $options=null)
 Push a new error handler on top of the error handler options stack.
 popErrorHandling ()
 Pop the last error handler used.
 loadExtension ($ext)
 OS independant PHP extension load.

Data Fields

 $approve_date_set = false
 $time_limit_set = false
 $time_limit_owner_set = false
 $updateLookAndSkin = false
 boolean to determine if look and skin should be updated
 $folder_id
 $roles
 $action
 The Action attribute determines what to do for the current User element.
 $protocol
 The variable holds the protocol of the import.
 $logins
 This variable is used to collect each login that we encounter in the import data.
 $conflict_rule
 Conflict handling rule.
 $send_mail
 $error_level
 This variable is used to report the error level of the validation process or the importing process.
 $currPasswordType
 The password type of the current user.
 $currPassword
 The password of the current user.
 $currActive
 The active state of the current user.
 $userCount
 The count of user elements in the XML file.
 $user_mapping
 $mapping_mode
 $localRoleCache
 Cached local roles.
 $personalPicture
 Cached personal picture of the actual user This is used because the ilObjUser object has no field for the personal picture.
 $parentRolesCache
 Cached parent roles.
 $skin
 ILIAS skin.
 $style
 ILIAS style.
 $userStyles
 User assigned styles.
 $hideSkin
 Indicates if the skins are hidden.
 $disableSkin
 Indicates if the skins are enabled.
 $user_id
- Data Fields inherited from ilSaxParser
 $input_type = null
 $xml_content = ''
 $ilias
 $lng
 $xml_file
 $throwException = false
- Data Fields inherited from PEAR
 $_debug = false
 $_default_error_mode = null
 $_default_error_options = null
 $_default_error_handler = ''
 $_error_class = 'PEAR_Error'
 $_expected_errors = array()

Protected Member Functions

 isFieldRequired ($fieldname)
 determine if a field $fieldname is to a required field (global setting)
- Protected Member Functions inherited from ilSaxParser
 handleError ($message, $code)
 use given error handler to handle error message or internal ilias error message handle

Protected Attributes

 $currPasswordSalt

Private Member Functions

 readAccountMailFromCache ($lang_key)
 readRequiredFields ()
 read required fields
 checkProfileIncomplete ($user_obj)
 Check if profile is incomplete Will set the usr_data field profile_incomplete if any required field is missing.
 verifyPref ($key, $value)
 updateMailPreferences ($usr_id)

Private Attributes

 $userObj
 $current_messenger_type

Static Private Attributes

static $account_mail_cache = array()

Detailed Description

User Import Parser.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 49 of file class.ilUserImportParser.php.

Member Function Documentation

ilUserImportParser::assignToRole (   $a_user_obj,
  $a_role_id 
)

Assigns a user to a role.

Definition at line 796 of file class.ilUserImportParser.php.

References $ref_id, ilObjUser\_addDesktopItem(), ilObject\_getAllReferences(), and ilObject\_lookupType().

Referenced by assignToRoleWithParents(), and importEndTag().

{
require_once "./Services/AccessControl/classes/class.ilObjRole.php";
include_once('./Services/Object/classes/class.ilObject.php');
#require_once "Modules/Course/classes/class.ilObjCourse.php";
#require_once "Modules/Course/classes/class.ilCourseParticipants.php";
global $rbacreview, $rbacadmin, $tree;
// Do nothing, if the user is already assigned to the role.
// Specifically, we do not want to put a course object or
// group object on the personal desktop again, if a user
// has removed it from the personal desktop.
if ($rbacreview->isAssigned($a_user_obj->getId(), $a_role_id))
{
return;
}
// If it is a course role, use the ilCourseMember object to assign
// the user to the role
$rbacadmin->assignUser($a_role_id, $a_user_obj->getId(), true);
$obj_id = $rbacreview->getObjectOfRole($a_role_id);
switch($type = ilObject::_lookupType($obj_id))
{
case 'grp':
case 'crs':
$ref_ids = ilObject::_getAllReferences($obj_id);
$ref_id = current((array) $ref_ids);
if($ref_id)
{
ilObjUser::_addDesktopItem($a_user_obj->getId(),$ref_id,$type);
}
break;
default:
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::assignToRoleWithParents (   $a_user_obj,
  $a_role_id 
)

Assigns a user to a role and to all parent roles.

Definition at line 892 of file class.ilUserImportParser.php.

References assignToRole(), and getParentRoleIds().

Referenced by importEndTag().

{
$this->assignToRole($a_user_obj, $a_role_id);
$parent_role_ids = $this->getParentRoleIds($a_role_id);
foreach ($parent_role_ids as $parent_role_id)
{
$this->assignToRole($a_user_obj, $parent_role_id);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::buildTag (   $type,
  $name,
  $attr = "" 
)

generate a tag with given name and attributes

Parameters
string"start" | "end" for starting or ending tag
stringelement/tag name
arrayarray of attributes

Definition at line 406 of file class.ilUserImportParser.php.

{
$tag = "<";
if ($type == "end")
$tag.= "/";
$tag.= $name;
if (is_array($attr))
{
while (list($k,$v) = each($attr))
$tag.= " ".$k."=\"$v\"";
}
$tag.= ">";
return $tag;
}
ilUserImportParser::checkProfileIncomplete (   $user_obj)
private

Check if profile is incomplete Will set the usr_data field profile_incomplete if any required field is missing.

private

Definition at line 2366 of file class.ilUserImportParser.php.

References ilUserProfile\isProfileIncomplete().

Referenced by importEndTag().

{
include_once "Services/User/classes/class.ilUserProfile.php";
return ilUserProfile::isProfileIncomplete($user_obj);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::detachFromRole (   $a_user_obj,
  $a_role_id 
)

Detachs a user from a role.

Definition at line 905 of file class.ilUserImportParser.php.

References $ref_id, ilObjUser\_dropDesktopItem(), ilObject\_getAllReferences(), ilObject\_lookupTitle(), and ilObject\_lookupType().

Referenced by importEndTag().

{
global $rbacreview, $rbacadmin, $tree;
$rbacadmin->deassignUser($a_role_id, $a_user_obj->getId());
if (substr(ilObject::_lookupTitle($a_role_id),0,6) == 'il_crs' or
substr(ilObject::_lookupTitle($a_role_id),0,6) == 'il_grp')
{
$obj = $rbacreview->getObjectOfRole($a_role_id);
$ref = ilObject::_getAllReferences($obj);
$ref_id = end($ref);
ilObjUser::_dropDesktopItem($a_user_obj->getId(), $ref_id, ilObject::_lookupType($obj));
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::extractRolesBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

handler for begin of element in extract roles mode

Definition at line 450 of file class.ilUserImportParser.php.

References ilUtil\__extractId().

Referenced by handlerBeginTag().

{
switch($a_name)
{
case "Role":
// detect numeric, ilias id (then extract role id) or alphanumeric
$this->current_role_id = $a_attribs["Id"];
if ($internal_id = ilUtil::__extractId($this->current_role_id, IL_INST_ID))
{
$this->current_role_id = $internal_id;
}
$this->current_role_type = $a_attribs["Type"];
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::extractRolesEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element when in extract roles mode.

Definition at line 738 of file class.ilUserImportParser.php.

Referenced by handlerEndTag().

{
switch($a_name)
{
case "Role":
$this->roles[$this->current_role_id]["name"] = $this->cdata;
$this->roles[$this->current_role_id]["type"] =
$this->current_role_type;
break;
}
}

+ Here is the caller graph for this function:

ilUserImportParser::getCollectedRoles ( )

get collected roles

Definition at line 2100 of file class.ilUserImportParser.php.

References $roles.

{
return $this->roles;
}
ilUserImportParser::getCourseMembersObjectForRole (   $a_role_id)

Returns the parent object of the role folder object which contains the specified role.

Definition at line 771 of file class.ilUserImportParser.php.

References ilCourseParticipants\_getInstanceByObjId().

{
global $rbacreview, $rbacadmin, $tree;
if (array_key_exists($a_role_id.'_courseMembersObject', $this->localRoleCache))
{
return $this->localRoleCache[$a_role_id.'_courseMembersObject'];
}
else
{
require_once("Modules/Course/classes/class.ilObjCourse.php");
require_once("Modules/Course/classes/class.ilCourseParticipants.php");
$course_refs = $rbacreview->getFoldersAssignedToRole($a_role_id, true);
$course_ref = $course_refs[0];
$course_obj = new ilObjCourse($course_ref, true);
$crsmembers_obj = ilCourseParticipants::_getInstanceByObjId($course_obj->getId());
$this->localRoleCache[$a_role_id.'_courseMembersObject'] = $crsmembers_obj;
return $crsmembers_obj;
}
}

+ Here is the call graph for this function:

ilUserImportParser::getErrorLevel ( )

Returns the error level.

Returns
IL_IMPORT_SUCCESS | IL_IMPORT_WARNING | IL_IMPORT_FAILURE

Definition at line 2222 of file class.ilUserImportParser.php.

References $error_level.

{
return $this->error_level;
}
ilUserImportParser::getFolderId ( )

Definition at line 364 of file class.ilUserImportParser.php.

References $folder_id.

Referenced by importEndTag().

{
return $this->folder_id;
}

+ Here is the caller graph for this function:

ilUserImportParser::getParentRoleIds (   $a_role_id)

Get array of parent role ids from cache.

If necessary, create a new cache entry.

Definition at line 838 of file class.ilUserImportParser.php.

References getRoleObject().

Referenced by assignToRoleWithParents().

{
global $rbacreview;
if (! array_key_exists($a_role_id, $this->parentRolesCache))
{
$parent_role_ids = array();
$role_obj = $this->getRoleObject($a_role_id);
$short_role_title = substr($role_obj->getTitle(),0,12);
$folders = $rbacreview->getFoldersAssignedToRole($a_role_id, true);
if (count($folders) > 0)
{
$all_parent_role_ids = $rbacreview->getParentRoleIds($folders[0]);
foreach ($all_parent_role_ids as $parent_role_id => $parent_role_data)
{
if ($parent_role_id != $a_role_id)
{
switch (substr($parent_role_data['title'],0,12))
{
case 'il_crs_admin' :
case 'il_grp_admin' :
if ($short_role_title == 'il_crs_admin' || $short_role_title == 'il_grp_admin')
{
$parent_role_ids[] = $parent_role_id;
}
break;
case 'il_crs_tutor' :
case 'il_grp_tutor' :
if ($short_role_title == 'il_crs_tutor' || $short_role_title == 'il_grp_tutor')
{
$parent_role_ids[] = $parent_role_id;
}
break;
case 'il_crs_membe' :
case 'il_grp_membe' :
if ($short_role_title == 'il_crs_membe' || $short_role_title == 'il_grp_membe')
{
$parent_role_ids[] = $parent_role_id;
}
break;
default :
break;
}
}
}
}
$this->parentRolesCache[$a_role_id] = $parent_role_ids;
}
return $this->parentRolesCache[$a_role_id];
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::getProtocol ( )

Returns the protocol.

The protocol is an associative array. Keys are login names. Values are non-associative arrays. Each array element contains an error message.

Definition at line 2173 of file class.ilUserImportParser.php.

References $protocol.

Referenced by getProtocolAsHTML().

{
return $this->protocol;
}

+ Here is the caller graph for this function:

ilUserImportParser::getProtocolAsHTML (   $a_log_title)

Returns the protocol as a HTML table.

Definition at line 2180 of file class.ilUserImportParser.php.

References ilSaxParser\$lng, $messages, and getProtocol().

{
global $lng;
$block = new ilTemplate("tpl.usr_import_log_block.html", true, true, "Services/User");
$block->setVariable("TXT_LOG_TITLE", $a_log_title);
$block->setVariable("TXT_MESSAGE_ID", $lng->txt("login"));
$block->setVariable("TXT_MESSAGE_TEXT", $lng->txt("message"));
foreach ($this->getProtocol() as $login => $messages)
{
$block->setCurrentBlock("log_row");
$reason = "";
foreach ($messages as $message)
{
if ($reason == "")
{
$reason = $message;
}
else
{
$reason = $reason."<br>".$message;
}
}
$block->setVariable("MESSAGE_ID", $login);
$block->setVariable("MESSAGE_TEXT", $reason);
$block->parseCurrentBlock();
}
return $block->get();
}

+ Here is the call graph for this function:

ilUserImportParser::getRoleObject (   $a_role_id)

Returns the parent object of the role folder object which contains the specified role.

Definition at line 753 of file class.ilUserImportParser.php.

Referenced by getParentRoleIds().

{
if (array_key_exists($a_role_id, $this->localRoleCache))
{
return $this->localRoleCache[$a_role_id];
}
else
{
$role_obj = new ilObjRole($a_role_id, false);
$role_obj->read();
$this->localRoleCache[$a_role_id] = $role_obj;
return $role_obj;
}
}

+ Here is the caller graph for this function:

ilUserImportParser::getUserCount ( )

get count of User elements

Definition at line 2107 of file class.ilUserImportParser.php.

References $userCount.

{
return $this->userCount;
}
ilUserImportParser::getUserMapping ( )

returns a map user_id <=> login

Returns
assoc array, with user_id as key and login as value

Definition at line 2232 of file class.ilUserImportParser.php.

References $user_mapping.

{
return $this->user_mapping;
}
ilUserImportParser::getUserMappingMode ( )

read access to user mapping mode

Returns
int one of IL_USER_MAPPING_ID or IL_USER_MAPPING_LOGIN

Definition at line 2328 of file class.ilUserImportParser.php.

References $mapping_mode.

Referenced by importBeginTag(), and verifyBeginTag().

{
return $this->mapping_mode;
}

+ Here is the caller graph for this function:

ilUserImportParser::handlerBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

handler for begin of element

Definition at line 429 of file class.ilUserImportParser.php.

References extractRolesBeginTag(), IL_EXTRACT_ROLES, IL_USER_IMPORT, IL_VERIFY, importBeginTag(), and verifyBeginTag().

{
switch ($this->mode)
{
case IL_EXTRACT_ROLES :
$this->extractRolesBeginTag($a_xml_parser, $a_name, $a_attribs);
break;
case IL_USER_IMPORT :
$this->importBeginTag($a_xml_parser, $a_name, $a_attribs);
break;
case IL_VERIFY :
$this->verifyBeginTag($a_xml_parser, $a_name, $a_attribs);
break;
}
$this->cdata = "";
}

+ Here is the call graph for this function:

ilUserImportParser::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

handler for character data

Definition at line 2084 of file class.ilUserImportParser.php.

{
// DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
// TODO: Mit Alex klären, ob das noch benötigt wird $a_data = preg_replace("/\n/","",$a_data);
// TODO: Mit Alex klären, ob das noch benötigt wird $a_data = preg_replace("/\t+/","",$a_data);
if($a_data != "\n") $a_data = preg_replace("/\t+/"," ",$a_data);
if(strlen($a_data) > 0)
{
$this->cdata .= $a_data;
}
}
ilUserImportParser::handlerEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element

Definition at line 719 of file class.ilUserImportParser.php.

References extractRolesEndTag(), IL_EXTRACT_ROLES, IL_USER_IMPORT, IL_VERIFY, importEndTag(), and verifyEndTag().

{
switch ($this->mode)
{
case IL_EXTRACT_ROLES :
$this->extractRolesEndTag($a_xml_parser, $a_name);
break;
case IL_USER_IMPORT :
$this->importEndTag($a_xml_parser, $a_name);
break;
case IL_VERIFY :
$this->verifyEndTag($a_xml_parser, $a_name);
break;
}
}

+ Here is the call graph for this function:

ilUserImportParser::ilUserImportParser (   $a_xml_file = '',
  $a_mode = IL_USER_IMPORT,
  $a_conflict_rule = IL_FAIL_ON_CONFLICT 
)

Constructor.

Parameters
string$a_xml_filexml file
int$a_modeIL_EXTRACT_ROLES | IL_USER_IMPORT | IL_VERIFY
int$a_conflict_rueIL_FAIL_ON_CONFLICT | IL_UPDATE_ON_CONFLICT | IL_IGNORE_ON_CONFLICT

public

Definition at line 286 of file class.ilUserImportParser.php.

References ilSaxParser\$ilias, $ilUser, ilSaxParser\$lng, $style, ilStyleDefinition\_getAllTemplates(), ilObjStyleSettings\_lookupActivatedStyle(), IL_IMPORT_SUCCESS, IL_USER_MAPPING_LOGIN, and ilSaxParser\ilSaxParser().

{
global $lng, $tree, $ilias, $ilUser, $styleDefinition;
$this->roles = array();
$this->mode = $a_mode;
$this->conflict_rule = $a_conflict_rule;
$this->error_level = IL_IMPORT_SUCCESS;
$this->protocol = array();
$this->logins = array();
$this->userCount = 0;
$this->localRoleCache = array();
$this->parentRolesCache = array();
$this->send_mail = false;
$this->mapping_mode = IL_USER_MAPPING_LOGIN;
// get all active style instead of only assigned ones -> cannot transfer all to another otherwise
$this->userStyles = array();
include_once("./Services/Style/classes/class.ilObjStyleSettings.php");
include_once './Services/Style/classes/class.ilStyleDefinition.php';
$templates = ilStyleDefinition::_getAllTemplates();
if (is_array($templates))
{
foreach($templates as $template)
{
// get styles information of template
$styleDef =& new ilStyleDefinition($template["id"]);
$styleDef->startParsing();
$styles = $styleDef->getStyles();
foreach($styles as $style)
{
if (!ilObjStyleSettings::_lookupActivatedStyle($template["id"],$style["id"]))
{
continue;
}
$this->userStyles [] = $template["id"].":".$style["id"];
}
}
}
$settings = $ilias->getAllSettings();
if ($settings["usr_settings_hide_skin_style"] == 1)
{
$this->hideSkin = TRUE;
}
else
{
$this->hideSkin = FALSE;
}
if ($settings["usr_settings_disable_skin_style"] == 1)
{
$this->disableSkin = TRUE;
}
else
{
$this->disableSkin = FALSE;
}
include_once("Services/Mail/classes/class.ilAccountMail.php");
$this->acc_mail = new ilAccountMail();
$this->acc_mail->useLangVariablesAsFallback(true);
parent::ilSaxParser($a_xml_file);
}

+ Here is the call graph for this function:

ilUserImportParser::importBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

handler for begin of element in user import mode

Definition at line 469 of file class.ilUserImportParser.php.

References ilSaxParser\$ilias, ilSaxParser\$lng, ilUtil\__extractId(), getUserMappingMode(), IL_USER_MAPPING_ID, and logFailure().

Referenced by handlerBeginTag().

{
global $ilias,$lng;
switch($a_name)
{
case "Role":
$this->current_role_id = $a_attribs["Id"];
if ($internal_id = ilUtil::__extractId($this->current_role_id, IL_INST_ID))
{
$this->current_role_id = $internal_id;
}
$this->current_role_type = $a_attribs["Type"];
$this->current_role_action = (is_null($a_attribs["Action"])) ? "Assign" : $a_attribs["Action"];
break;
case "PersonalPicture":
$this->personalPicture = array(
"encoding" => $a_attribs["encoding"],
"imagetype" => $a_attribs["imagetype"],
"content" => ""
);
break;
case "Look":
$this->skin = $a_attribs["Skin"];
$this->style = $a_attribs["Style"];
break;
case "User":
$this->acc_mail->reset();
$this->prefs = array();
$this->currentPrefKey = null;
$this->auth_mode_set = false;
$this->approve_date_set = false;
$this->time_limit_set = false;
$this->time_limit_owner_set = false;
$this->updateLookAndSkin = false;
$this->skin = "";
$this->style = "";
$this->personalPicture = null;
$this->userCount++;
$this->userObj = new ilObjUser();
// user defined fields
$this->udf_data = array();
// if we have an object id, store it
$this->user_id = -1;
if (!is_null($a_attribs["Id"]) && $this->getUserMappingMode() == IL_USER_MAPPING_ID)
{
if (is_numeric($a_attribs["Id"]))
{
$this->user_id = $a_attribs["Id"];
}
elseif ($id = ilUtil::__extractId ($a_attribs["Id"], IL_INST_ID))
{
$this->user_id = $id;
}
}
$this->userObj->setPref("skin",
$ilias->ini->readVariable("layout","skin"));
$this->userObj->setPref("style",
$ilias->ini->readVariable("layout","style"));
$this->userObj->setLanguage($a_attribs["Language"]);
$this->userObj->setImportId($a_attribs["Id"]);
$this->action = (is_null($a_attribs["Action"])) ? "Insert" : $a_attribs["Action"];
$this->currPassword = null;
$this->currPasswordType = null;
$this->currPasswordSalt = null;
$this->currActive = null;
$this->multi_values = array();
break;
case 'Password':
$this->currPasswordType = $a_attribs['Type'];
$this->currPasswordSalt = $a_attribs['Salt'];
break;
case "AuthMode":
if (array_key_exists("type", $a_attribs))
{
switch ($a_attribs["type"])
{
case "default":
case "local":
case "ldap":
case "radius":
case "shibboleth":
case "script":
case "cas":
case "soap":
case "openid":
// begin-patch auth_plugin
default:
$this->auth_mode_set = true;
$this->userObj->setAuthMode($a_attribs["type"]);
break;
/*
$this->logFailure($this->userObj->getLogin(),
sprintf($lng->txt("usrimport_xml_element_inapplicable"),"AuthMode",$a_attribs["type"]));
break;
*
*/
}
}
else
{
$this->logFailure($this->userObj->getLogin(),
sprintf($lng->txt("usrimport_xml_element_inapplicable"),"AuthMode",$a_attribs["type"]));
}
break;
case 'UserDefinedField':
$this->tmp_udf_id = $a_attribs['Id'];
$this->tmp_udf_name = $a_attribs['Name'];
break;
case 'AccountInfo':
$this->current_messenger_type = strtolower($a_attribs["Type"]);
break;
case 'GMapInfo':
$this->userObj->setLatitude($a_attribs["latitude"]);
$this->userObj->setLongitude($a_attribs["longitude"]);
$this->userObj->setLocationZoom($a_attribs["zoom"]);
break;
case 'Pref':
$this->currentPrefKey = $a_attribs["key"];
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::importEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element when in import user mode.

Definition at line 924 of file class.ilUserImportParser.php.

References ilSaxParser\$ilias, $ilSetting, $ilUser, ilSaxParser\$lng, $timestamp, $user_id, ilObjUser\_checkExternalAuthAccount(), ilAuthUtils\_getAuthModeName(), ilUserDefinedFields\_getInstance(), ilObjUser\_lookupExternalAccount(), ilObjUser\_uploadPersonalPicture(), assignToRole(), assignToRoleWithParents(), checkProfileIncomplete(), detachFromRole(), getFolderId(), ilObjUser\getUserIdByLogin(), IL_CAL_DATETIME, IL_CAL_UNIX, IL_FAIL_ON_CONFLICT, IL_IGNORE_ON_CONFLICT, IL_PASSWD_CRYPTED, IL_PASSWD_PLAIN, IL_UPDATE_ON_CONFLICT, ilUserXMLWriter\isPrefExportable(), logFailure(), logSuccess(), logWarning(), saveTempImage(), sendAccountMail(), ilUserDefinedData\set(), and updateMailPreferences().

Referenced by handlerEndTag().

{
global $ilias, $rbacadmin, $rbacreview, $ilUser, $lng, $ilSetting;
switch($a_name)
{
case "Role":
$this->roles[$this->current_role_id]["name"] = $this->cdata;
$this->roles[$this->current_role_id]["type"] = $this->current_role_type;
$this->roles[$this->current_role_id]["action"] = $this->current_role_action;
break;
case "PersonalPicture":
switch ($this->personalPicture["encoding"])
{
case "Base64":
$this->personalPicture["content"] = base64_decode($this->cdata);
break;
case "UUEncode":
// this only works with PHP >= 5
if (version_compare(PHP_VERSION,'5','>='))
{
$this->personalPicture["content"] = convert_uudecode($this->cdata);
}
break;
}
break;
case "User":
$this->userObj->setFullname();
// Fetch the user_id from the database, if we didn't have it in xml file
// fetch as well, if we are trying to insert -> recognize duplicates!
if ($this->user_id == -1 || $this->action=="Insert")
$user_id = ilObjUser::getUserIdByLogin($this->userObj->getLogin());
else
$user_id = $this->user_id;
//echo $user_id.":".$this->userObj->getLogin();
// Handle conflicts
switch ($this->conflict_rule)
{
case IL_FAIL_ON_CONFLICT :
// do not change action
break;
case IL_UPDATE_ON_CONFLICT :
switch ($this->action)
{
case "Insert" :
if ($user_id)
{
$this->logWarning($this->userObj->getLogin(),sprintf($lng->txt("usrimport_action_replaced"),"Insert","Update"));
$this->action = "Update";
}
break;
case "Update" :
if (! $user_id)
{
$this->logWarning($this->userObj->getLogin(),sprintf($lng->txt("usrimport_action_replaced"),"Update","Insert"));
$this->action = "Insert";
}
break;
case "Delete" :
if (! $user_id)
{
$this->logWarning($this->userObj->getLogin(),sprintf($lng->txt("usrimport_action_ignored"),"Delete"));
$this->action = "Ignore";
}
break;
}
break;
case IL_IGNORE_ON_CONFLICT :
switch ($this->action)
{
case "Insert" :
if ($user_id)
{
$this->logWarning($this->userObj->getLogin(),sprintf($lng->txt("usrimport_action_ignored"),"Insert"));
$this->action = "Ignore";
}
break;
case "Update" :
if (! $user_id)
{
$this->logWarning($this->userObj->getLogin(),sprintf($lng->txt("usrimport_action_ignored"),"Update"));
$this->action = "Ignore";
}
break;
case "Delete" :
if (! $user_id)
{
$this->logWarning($this->userObj->getLogin(),sprintf($lng->txt("usrimport_action_ignored"),"Delete"));
$this->action = "Ignore";
}
break;
}
break;
}
// check external account conflict (if external account is already used)
// note: we cannot apply conflict rules in the same manner as to logins here
// so we ignore records with already existing external accounts.
//echo $this->userObj->getAuthMode().'h';
$am = ($this->userObj->getAuthMode() == "default" || $this->userObj->getAuthMode() == "")
? ilAuthUtils::_getAuthModeName($ilSetting->get('auth_mode'))
: $this->userObj->getAuthMode();
$loginForExternalAccount = ($this->userObj->getExternalAccount() == "")
? ""
: ilObjUser::_checkExternalAuthAccount($am, $this->userObj->getExternalAccount());
switch ($this->action)
{
case "Insert" :
if ($loginForExternalAccount != "")
{
$this->logWarning($this->userObj->getLogin(), $lng->txt("usrimport_no_insert_ext_account_exists")." (".$this->userObj->getExternalAccount().")");
$this->action = "Ignore";
}
break;
case "Update" :
// this variable describes the ILIAS login which belongs to the given external account!!!
// it is NOT nescessarily the ILIAS login of the current user record !!
// so if we found an ILIAS login according to the authentication method
// check if the ILIAS login belongs to the current user record, otherwise somebody else is using it!
if ($loginForExternalAccount != "")
{
// check if we changed the value!
$externalAccountHasChanged = $this->userObj->getExternalAccount() != ilObjUser::_lookupExternalAccount($this->user_id);
// if it has changed and the external login
if ($externalAccountHasChanged && trim($loginForExternalAccount) != trim($this->userObj->getLogin()))
{
$this->logWarning($this->userObj->getLogin(), $lng->txt("usrimport_no_update_ext_account_exists")." (".$this->userObj->getExternalAccount().")");
$this->action = "Ignore";
}
}
break;
}
if(sizeof($this->multi_values))
{
if(isset($this->multi_values["GeneralInterest"]))
{
$this->userObj->setGeneralInterests($this->multi_values["GeneralInterest"]);
}
if(isset($this->multi_values["OfferingHelp"]))
{
$this->userObj->setOfferingHelp($this->multi_values["OfferingHelp"]);
}
if(isset($this->multi_values["LookingForHelp"]))
{
$this->userObj->setLookingForHelp($this->multi_values["LookingForHelp"]);
}
}
// Perform the action
switch ($this->action)
{
case "Insert" :
if ($user_id)
{
$this->logFailure($this->userObj->getLogin(),$lng->txt("usrimport_cant_insert"));
}
else
{
if(!strlen($this->currPassword) == 0)
{
switch($this->currPasswordType)
{
case "BCRYPT":
if(!strlen($this->currPasswordSalt))
{
$this->logFailure($this->userObj->getLogin(), $lng->txt("usrimport_xml_pw_bcrypt_missing_salt"));
}
$this->userObj->setPasswd($this->currPassword, IL_PASSWD_CRYPTED);
$this->userObj->setPasswordEncodingType('bcrypt');
$this->userObj->setPasswordSalt($this->currPasswordSalt);
break;
case "MD5":
case "ILIAS3":
$this->userObj->setPasswd($this->currPassword, IL_PASSWD_CRYPTED);
$this->userObj->setPasswordEncodingType('md5');
$this->userObj->setPasswordSalt('');
break;
case "PLAIN":
$this->userObj->setPasswd($this->currPassword, IL_PASSWD_PLAIN);
$this->acc_mail->setUserPassword($this->currPassword);
break;
}
}
else
{
// this does the trick for empty passwords
// since a MD5 string has always 32 characters,
// no hashed password combination will ever equal to
// an empty string
$this->userObj->setPasswd("", IL_PASSWD_CRYPTED);
}
$this->userObj->setTitle($this->userObj->getFullname());
$this->userObj->setDescription($this->userObj->getEmail());
if(!$this->time_limit_owner_set)
{
$this->userObj->setTimeLimitOwner($this->getFolderId());
}
// default time limit settings
if(!$this->time_limit_set)
{
$this->userObj->setTimeLimitUnlimited(1);
$this->userObj->setTimeLimitMessage(0);
if (! $this->approve_date_set)
{
$this->userObj->setApproveDate(date("Y-m-d H:i:s"));
}
}
$this->userObj->setActive($this->currActive == 'true' || is_null($this->currActive));
// Finally before saving new user.
// Check if profile is incomplete
// #8759
if(count($this->udf_data))
{
$this->userObj->setUserDefinedData($this->udf_data);
}
$this->userObj->setProfileIncomplete($this->checkProfileIncomplete($this->userObj));
$this->userObj->create();
//insert user data in table user_data
$this->userObj->saveAsNew(false);
// Set default prefs
$this->userObj->setPref('hits_per_page',$ilSetting->get('hits_per_page',30));
$this->userObj->setPref('show_users_online',$ilSetting->get('show_users_online','y'));
if (count ($this->prefs))
{
foreach ($this->prefs as $key => $value)
{
if ($key != "mail_incoming_type" &&
$key != "mail_signature" &&
$key != "mail_linebreak"
)
{
$this->userObj->setPref($key, $value);
}
}
}
$this->userObj->writePrefs();
// update mail preferences, to be extended
$this->updateMailPreferences($this->userObj->getId());
if (is_array($this->personalPicture))
{
if (strlen($this->personalPicture["content"]))
{
$extension = "jpg";
if (preg_match("/.*(png|jpg|gif|jpeg)$/", $this->personalPicture["imagetype"], $matches))
{
$extension = $matches[1];
}
$tmp_name = $this->saveTempImage($this->personalPicture["content"], ".$extension");
if (strlen($tmp_name))
{
ilObjUser::_uploadPersonalPicture($tmp_name, $this->userObj->getId());
unlink($tmp_name);
}
}
}
//set role entries
foreach($this->roles as $role_id => $role)
{
if ($this->role_assign[$role_id])
{
$this->assignToRole($this->userObj, $this->role_assign[$role_id]);
}
}
if(count($this->udf_data))
{
include_once './Services/User/classes/class.ilUserDefinedData.php';
$udd = new ilUserDefinedData($this->userObj->getId());
foreach($this->udf_data as $field => $value)
{
$udd->set("f_".$field,$value);
}
$udd->update();
}
$this->sendAccountMail();
$this->logSuccess($this->userObj->getLogin(),$this->userObj->getId(), "Insert");
// reset account mail object
$this->acc_mail->reset();
}
break;
case "Update" :
if (! $user_id)
{
$this->logFailure($this->userObj->getLogin(),$lng->txt("usrimport_cant_update"));
}
else
{
$updateUser = new ilObjUser($user_id);
$updateUser->read();
$updateUser->readPrefs();
if ($this->currPassword != null)
{
switch ($this->currPasswordType)
{
case "BCRYPT":
if(!strlen($this->currPasswordSalt))
{
$this->logFailure($this->userObj->getLogin(), $lng->txt("usrimport_xml_pw_bcrypt_missing_salt"));
}
$updateUser->setPasswd($this->currPassword, IL_PASSWD_CRYPTED);
$updateUser->setPasswordEncodingType('bcrypt');
$updateUser->setPasswordSalt($this->currPasswordSalt);
break;
case "MD5":
case "ILIAS3":
$updateUser->setPasswd($this->currPassword, IL_PASSWD_CRYPTED);
$updateUser->setPasswordEncodingType('md5');
$updateUser->setPasswordSalt('');
break;
case "PLAIN":
$updateUser->setPasswd($this->currPassword, IL_PASSWD_PLAIN);
$this->acc_mail->setUserPassword($this->currPassword);
break;
}
}
if (! is_null($this->userObj->getFirstname())) $updateUser->setFirstname($this->userObj->getFirstname());
if (! is_null($this->userObj->getLastname())) $updateUser->setLastname($this->userObj->getLastname());
if (! is_null($this->userObj->getUTitle())) $updateUser->setUTitle($this->userObj->getUTitle());
if (! is_null($this->userObj->getGender())) $updateUser->setGender($this->userObj->getGender());
if (! is_null($this->userObj->getEmail())) $updateUser->setEmail($this->userObj->getEmail());
if (! is_null($this->userObj->getBirthday())) $updateUser->setBirthday($this->userObj->getBirthday());
if (! is_null($this->userObj->getInstitution())) $updateUser->setInstitution($this->userObj->getInstitution());
if (! is_null($this->userObj->getStreet())) $updateUser->setStreet($this->userObj->getStreet());
if (! is_null($this->userObj->getCity())) $updateUser->setCity($this->userObj->getCity());
if (! is_null($this->userObj->getZipCode())) $updateUser->setZipCode($this->userObj->getZipCode());
if (! is_null($this->userObj->getCountry())) $updateUser->setCountry($this->userObj->getCountry());
if (! is_null($this->userObj->getPhoneOffice())) $updateUser->setPhoneOffice($this->userObj->getPhoneOffice());
if (! is_null($this->userObj->getPhoneHome())) $updateUser->setPhoneHome($this->userObj->getPhoneHome());
if (! is_null($this->userObj->getPhoneMobile())) $updateUser->setPhoneMobile($this->userObj->getPhoneMobile());
if (! is_null($this->userObj->getFax())) $updateUser->setFax($this->userObj->getFax());
if (! is_null($this->userObj->getHobby())) $updateUser->setHobby($this->userObj->getHobby());
if (! is_null($this->userObj->getGeneralInterests())) $updateUser->setGeneralInterests($this->userObj->getGeneralInterests());
if (! is_null($this->userObj->getOfferingHelp())) $updateUser->setOfferingHelp($this->userObj->getOfferingHelp());
if (! is_null($this->userObj->getLookingForHelp())) $updateUser->setLookingForHelp($this->userObj->getLookingForHelp());
if (! is_null($this->userObj->getComment())) $updateUser->setComment($this->userObj->getComment());
if (! is_null($this->userObj->getDepartment())) $updateUser->setDepartment($this->userObj->getDepartment());
if (! is_null($this->userObj->getMatriculation())) $updateUser->setMatriculation($this->userObj->getMatriculation());
if (! is_null($this->currActive)) $updateUser->setActive($this->currActive == "true", is_object($ilUser) ? $ilUser->getId() : 0);
if (! is_null($this->userObj->getClientIP())) $updateUser->setClientIP($this->userObj->getClientIP());
if (! is_null($this->userObj->getTimeLimitUnlimited())) $updateUser->setTimeLimitUnlimited($this->userObj->getTimeLimitUnlimited());
if (! is_null($this->userObj->getTimeLimitFrom())) $updateUser->setTimeLimitFrom($this->userObj->getTimeLimitFrom());
if (! is_null($this->userObj->getTimeLimitUntil())) $updateUser->setTimeLimitUntil($this->userObj->getTimeLimitUntil());
if (! is_null($this->userObj->getTimeLimitMessage())) $updateUser->setTimeLimitMessage($this->userObj->getTimeLimitMessage());
if (! is_null($this->userObj->getApproveDate())) $updateUser->setApproveDate($this->userObj->getApproveDate());
if (! is_null($this->userObj->getAgreeDate())) $updateUser->setAgreeDate($this->userObj->getAgreeDate());
if (! is_null($this->userObj->getLanguage())) $updateUser->setLanguage($this->userObj->getLanguage());
if (! is_null($this->userObj->getExternalAccount())) $updateUser->setExternalAccount($this->userObj->getExternalAccount());
// Fixed: if auth_mode is not set, it was always overwritten with auth_default
#if (! is_null($this->userObj->getAuthMode())) $updateUser->setAuthMode($this->userObj->getAuthMode());
if($this->auth_mode_set)
$updateUser->setAuthMode($this->userObj->getAuthMode());
if (! is_null($this->userObj->getInstantMessengerId("aim"))) $updateUser->setInstantMessengerId("aim", $this->userObj->getInstantMessengerId("aim"));
if (! is_null($this->userObj->getInstantMessengerId("msn"))) $updateUser->setInstantMessengerId("msn", $this->userObj->getInstantMessengerId("msn"));
if (! is_null($this->userObj->getInstantMessengerId("icq"))) $updateUser->setInstantMessengerId("icq", $this->userObj->getInstantMessengerId("icq"));
if (! is_null($this->userObj->getInstantMessengerId("yahoo"))) $updateUser->setInstantMessengerId("yahoo", $this->userObj->getInstantMessengerId("yahoo"));
if (! is_null($this->userObj->getInstantMessengerId("skype"))) $updateUser->setInstantMessengerId("skype", $this->userObj->getInstantMessengerId("skype"));
if (! is_null($this->userObj->getInstantMessengerId("jabber"))) $updateUser->setInstantMessengerId("jabber", $this->userObj->getInstantMessengerId("jabber"));
if (! is_null($this->userObj->getInstantMessengerId("voip"))) $updateUser->setInstantMessengerId("voip", $this->userObj->getInstantMessengerId("voip"));
// Special handlin since it defaults to 7 (USER_FOLDER_ID)
if($this->time_limit_owner_set)
{
$updateUser->setTimeLimitOwner($this->userObj->getTimeLimitOwner());
}
if (count ($this->prefs))
{
foreach ($this->prefs as $key => $value)
{
if ($key != "mail_incoming_type" &&
$key != "mail_signature" &&
$key != "mail_linebreak"
){
$updateUser->setPref($key, $value);
}
}
}
// save user preferences (skin and style)
if ($this->updateLookAndSkin)
{
$updateUser->setPref("skin", $this->userObj->getPref("skin"));
$updateUser->setPref("style", $this->userObj->getPref("style"));
}
$updateUser->writePrefs();
// update mail preferences, to be extended
$this->updateMailPreferences($updateUser->getId());
// #8759
if(count($this->udf_data))
{
$updateUser->setUserDefinedData($this->udf_data);
}
$updateUser->setProfileIncomplete($this->checkProfileIncomplete($updateUser));
$updateUser->setTitle($updateUser->getFullname());
$updateUser->setDescription($updateUser->getEmail());
$updateUser->update();
if(count($this->udf_data))
{
include_once './Services/User/classes/class.ilUserDefinedData.php';
$udd = new ilUserDefinedData($updateUser->getId());
foreach($this->udf_data as $field => $value)
{
$udd->set("f_".$field,$value);
}
$udd->update();
}
// update login
if (!is_null($this->userObj->getLogin()) && $this->user_id != -1)
{
try
{
$updateUser->updateLogin($this->userObj->getLogin());
}
catch (ilUserException $e)
{
}
}
// if language has changed
if (is_array($this->personalPicture))
{
if (strlen($this->personalPicture["content"]))
{
$extension = "jpg";
if (preg_match("/.*(png|jpg|gif|jpeg)$/", $this->personalPicture["imagetype"], $matches))
{
$extension = $matches[1];
}
$tmp_name = $this->saveTempImage($this->personalPicture["content"], ".$extension");
if (strlen($tmp_name))
{
ilObjUser::_uploadPersonalPicture($tmp_name, $this->userObj->getId());
unlink($tmp_name);
}
}
}
//update role entries
//-------------------
foreach ($this->roles as $role_id => $role)
{
if ($this->role_assign[$role_id])
{
switch ($role["action"])
{
case "Assign" :
$this->assignToRole($updateUser, $this->role_assign[$role_id]);
break;
case "AssignWithParents" :
$this->assignToRoleWithParents($updateUser, $this->role_assign[$role_id]);
break;
case "Detach" :
$this->detachFromRole($updateUser, $this->role_assign[$role_id]);
break;
}
}
}
$this->logSuccess($updateUser->getLogin(), $user_id, "Update");
}
break;
case "Delete" :
if (! $user_id)
{
$this->logFailure($this->userObj->getLogin(),$lng->txt("usrimport_cant_delete"));
}
else
{
$deleteUser = new ilObjUser($user_id);
$deleteUser->delete();
$this->logSuccess($this->userObj->getLogin(),$user_id, "Delete");
}
break;
}
// init role array for next user
$this->roles = array();
break;
case "Login":
$this->userObj->setLogin($this->cdata);
break;
case "Password":
$this->currPassword = $this->cdata;
break;
case "Firstname":
$this->userObj->setFirstname($this->cdata);
break;
case "Lastname":
$this->userObj->setLastname($this->cdata);
break;
case "Title":
$this->userObj->setUTitle($this->cdata);
break;
case "Gender":
$this->userObj->setGender($this->cdata);
break;
case "Email":
$this->userObj->setEmail($this->cdata);
break;
case "Birthday":
$timestamp = strtotime($this->cdata);
if ($timestamp !== false)
{
$this->userObj->setBirthday($this->cdata);
}
break;
case "Institution":
$this->userObj->setInstitution($this->cdata);
break;
case "Street":
$this->userObj->setStreet($this->cdata);
break;
case "City":
$this->userObj->setCity($this->cdata);
break;
case "PostalCode":
$this->userObj->setZipCode($this->cdata);
break;
case "Country":
$this->userObj->setCountry($this->cdata);
break;
case "PhoneOffice":
$this->userObj->setPhoneOffice($this->cdata);
break;
case "PhoneHome":
$this->userObj->setPhoneHome($this->cdata);
break;
case "PhoneMobile":
$this->userObj->setPhoneMobile($this->cdata);
break;
case "Fax":
$this->userObj->setFax($this->cdata);
break;
case "Hobby":
$this->userObj->setHobby($this->cdata);
break;
case "GeneralInterest":
case "OfferingHelp":
case "LookingForHelp":
$this->multi_values[$a_name][] = $this->cdata;
break;
case "Comment":
$this->userObj->setComment($this->cdata);
break;
case "Department":
$this->userObj->setDepartment($this->cdata);
break;
case "Matriculation":
$this->userObj->setMatriculation($this->cdata);
break;
case "Active":
$this->currActive = $this->cdata;
break;
case "ClientIP":
$this->userObj->setClientIP($this->cdata);
break;
case "TimeLimitOwner":
$this->time_limit_owner_set = true;
$this->userObj->setTimeLimitOwner($this->cdata);
break;
case "TimeLimitUnlimited":
$this->time_limit_set = true;
$this->userObj->setTimeLimitUnlimited($this->cdata);
break;
case "TimeLimitFrom":
if (is_numeric($this->cdata))
{
// Treat cdata as a unix timestamp
$this->userObj->setTimeLimitFrom($this->cdata);
}
else
{
// Try to convert cdata into unix timestamp, or ignore it
$timestamp = strtotime($this->cdata);
if ($timestamp !== false && trim($this->cdata) != "0000-00-00 00:00:00")
{
$this->userObj->setTimeLimitFrom($timestamp);
}
elseif ($this->cdata == "0000-00-00 00:00:00")
{
$this->userObj->setTimeLimitFrom(null);
}
}
break;
case "TimeLimitUntil":
if (is_numeric($this->cdata))
{
// Treat cdata as a unix timestamp
$this->userObj->setTimeLimitUntil($this->cdata);
}
else
{
// Try to convert cdata into unix timestamp, or ignore it
$timestamp = strtotime($this->cdata);
if ($timestamp !== false && trim($this->cdata) != "0000-00-00 00:00:00")
{
$this->userObj->setTimeLimitUntil($timestamp);
}
elseif ($this->cdata == "0000-00-00 00:00:00")
{
$this->userObj->setTimeLimitUntil(null);
}
}
break;
case "TimeLimitMessage":
$this->userObj->setTimeLimitMessage($this->cdata);
break;
case "ApproveDate":
$this->approve_date_set = true;
if (is_numeric($this->cdata))
{
// Treat cdata as a unix timestamp
$tmp_date = new ilDateTime($this->cdata,IL_CAL_UNIX);
$this->userObj->setApproveDate($tmp_date->get(IL_CAL_DATETIME));
}
else
{
// Try to convert cdata into unix timestamp, or ignore it
$timestamp = strtotime($this->cdata);
if ($timestamp !== false && trim($this->cdata) != "0000-00-00 00:00:00")
{
$tmp_date = new ilDateTime($timestamp,IL_CAL_UNIX);
$this->userObj->setApproveDate($tmp_date->get(IL_CAL_DATETIME));
}
elseif ($this->cdata == "0000-00-00 00:00:00")
{
$this->userObj->setApproveDate(null);
}
}
break;
case "AgreeDate":
if (is_numeric($this->cdata))
{
// Treat cdata as a unix timestamp
$tmp_date = new ilDateTime($this->cdata,IL_CAL_UNIX);
$this->userObj->setAgreeDate($tmp_date->get(IL_CAL_DATETIME));
}
else
{
// Try to convert cdata into unix timestamp, or ignore it
$timestamp = strtotime($this->cdata);
if ($timestamp !== false && trim($this->cdata) != "0000-00-00 00:00:00")
{
$tmp_date = new ilDateTime($timestamp,IL_CAL_UNIX);
$this->userObj->setAgreeDate($tmp_date->get(IL_CAL_DATETIME));
}
elseif ($this->cdata == "0000-00-00 00:00:00")
{
$this->userObj->setAgreeDate(null);
}
}
break;
case "ExternalAccount":
$this->userObj->setExternalAccount($this->cdata);
break;
case "Look":
$this->updateLookAndSkin = false;
if (!$this->hideSkin)
{
// TODO: what to do with disabled skins? is it possible to change the skin via import?
if ((strlen($this->skin) > 0) && (strlen($this->style) > 0))
{
if (is_array($this->userStyles))
{
if (in_array($this->skin . ":" . $this->style, $this->userStyles))
{
$this->userObj->setPref("skin", $this->skin);
$this->userObj->setPref("style", $this->style);
$this->updateLookAndSkin = true;
}
}
}
}
break;
case 'UserDefinedField':
include_once './Services/User/classes/class.ilUserDefinedFields.php';
$udf = ilUserDefinedFields::_getInstance();
if($field_id = $udf->fetchFieldIdFromImportId($this->tmp_udf_id))
{
$this->udf_data[$field_id] = $this->cdata;
}
elseif($field_id = $udf->fetchFieldIdFromName($this->tmp_udf_name))
{
$this->udf_data[$field_id] = $this->cdata;
}
break;
case 'AccountInfo':
if ($this->current_messenger_type =="delicious")
{
$this->userObj->setDelicious($this->cdata);
}
elseif ($this->current_messenger_type =="external")
{
$this->userObj->setExternalAccount($this->cdata);
}
else
{
$this->userObj->setInstantMessengerId($this->current_messenger_type, $this->cdata);
}
break;
case 'Pref':
if ($this->currentPrefKey != null && strlen(trim($this->cdata)) > 0
&& ilUserXMLWriter::isPrefExportable($this->currentPrefKey))
$this->prefs[$this->currentPrefKey] = trim($this->cdata);
$this->currentPrefKey = null;
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::isFieldRequired (   $fieldname)
protected

determine if a field $fieldname is to a required field (global setting)

Parameters
$fieldnamestring value of fieldname, e.g. gender
Returns
true, if field of required fields contains fieldname as key, false otherwise.

Definition at line 2378 of file class.ilUserImportParser.php.

References readRequiredFields().

Referenced by verifyEndTag().

{
$requiredFields = $this->readRequiredFields();
$fieldname = strtolower(trim($fieldname));
return array_key_exists($fieldname, $requiredFields);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::isSendMail ( )

read access to property send mail

Returns
boolean

Definition at line 2307 of file class.ilUserImportParser.php.

References $send_mail.

Referenced by sendAccountMail().

{
return $this->send_mail;
}

+ Here is the caller graph for this function:

ilUserImportParser::isSuccess ( )

Returns true, if the import was successful.

Definition at line 2213 of file class.ilUserImportParser.php.

References IL_IMPORT_SUCCESS.

{
return $this->error_level == IL_IMPORT_SUCCESS;
}
ilUserImportParser::logFailure (   $aLogin,
  $aMessage 
)

Writes a failure log message to the protocol.

Parameters
stringlogin
stringmessage

Definition at line 2139 of file class.ilUserImportParser.php.

References IL_IMPORT_FAILURE.

Referenced by importBeginTag(), importEndTag(), verifyBeginTag(), verifyEndTag(), and verifyPref().

{
if (! array_key_exists($aLogin, $this->protocol))
{
$this->protocol[$aLogin] = array();
}
if ($aMessage)
{
$this->protocol[$aLogin][] = $aMessage;
}
$this->error_level = IL_IMPORT_FAILURE;
}

+ Here is the caller graph for this function:

ilUserImportParser::logSuccess (   $aLogin,
  $userid,
  $action 
)

Writes a success log message to the protocol.

Parameters
stringlogin
stringuserid
stringaction

Definition at line 2159 of file class.ilUserImportParser.php.

References $action.

Referenced by importEndTag().

{
$this->user_mapping[$userid] = array("login" => $aLogin, "action" => $action, "message" => "successful");
}

+ Here is the caller graph for this function:

ilUserImportParser::logWarning (   $aLogin,
  $aMessage 
)

Writes a warning log message to the protocol.

Parameters
stringlogin
stringmessage

Definition at line 2118 of file class.ilUserImportParser.php.

References IL_IMPORT_SUCCESS, and IL_IMPORT_WARNING.

Referenced by importEndTag(), and verifyEndTag().

{
if (! array_key_exists($aLogin, $this->protocol))
{
$this->protocol[$aLogin] = array();
}
if ($aMessage)
{
$this->protocol[$aLogin][] = $aMessage;
}
if ($this->error_level == IL_IMPORT_SUCCESS)
{
$this->error_level = IL_IMPORT_WARNING;
}
}

+ Here is the caller graph for this function:

ilUserImportParser::readAccountMailFromCache (   $lang_key)
private
Parameters
$lang_key
Returns
mixed

Definition at line 2264 of file class.ilUserImportParser.php.

References $GLOBALS, and ilObjUserFolder\_lookupNewAccountMail().

Referenced by sendAccountMail().

{
if(!isset(self::$account_mail_cache[$lang_key]))
{
$default_lang_key = $GLOBALS["lng"]->getDefaultLanguage();
// try individual account mail in user administration
include_once './Services/User/classes/class.ilObjUserFolder.php';
$amail = ilObjUserFolder::_lookupNewAccountMail($lang_key);
if (trim($amail["body"]) != "" && trim($amail["subject"]) != "")
{
self::$account_mail_cache[$lang_key] = $amail;
}
else
{
$lang_key = $default_lang_key;
}
if(!isset(self::$account_mail_cache[$default_lang_key]))
{
$amail = ilObjUserFolder::_lookupNewAccountMail($default_lang_key);
self::$account_mail_cache[$default_lang_key] = $amail;
}
}
return self::$account_mail_cache[$lang_key];
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::readRequiredFields ( )
private

read required fields

private

Definition at line 2339 of file class.ilUserImportParser.php.

References $ilSetting.

Referenced by isFieldRequired().

{
global $ilSetting;
if(is_array($this->required_fields))
{
return $this->required_fields;
}
foreach($ilSetting->getAll() as $field => $value)
{
if(substr($field,0,8) == 'require_' and $value == 1)
{
$value = substr($field,8);
$this->required_fields[$value] = $value;
}
}
return $this->required_fields ? $this->required_fields : array();
}

+ Here is the caller graph for this function:

ilUserImportParser::saveTempImage (   $image_data,
  $filename 
)

Saves binary image data to a temporary image file and returns the name of the image file on success.

Definition at line 1716 of file class.ilUserImportParser.php.

References $filename, and ilUtil\ilTempnam().

Referenced by importEndTag().

{
$tempname = ilUtil::ilTempnam() . $filename;
$fh = fopen($tempname, "wb");
if ($fh == false)
{
return "";
}
$imagefile = fwrite($fh, $image_data);
fclose($fh);
return $tempname;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::sendAccountMail ( )

send account mail

Definition at line 2239 of file class.ilUserImportParser.php.

References $_POST, $path, isSendMail(), readAccountMailFromCache(), and USER_FOLDER_ID.

Referenced by importEndTag().

{
if($_POST["send_mail"] != "" ||
($this->isSendMail() && $this->userObj->getEmail() != ""))
{
$this->acc_mail->setUser($this->userObj);
$amail = $this->readAccountMailFromCache($this->userObj->getLanguage());
if($amail["att_file"])
{
include_once "Services/User/classes/class.ilFSStorageUserFolder.php";
$fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
$fs->create();
$path = $fs->getAbsolutePath() . "/";
$this->acc_mail->addAttachment($path . "/" . $amail["lang"], $amail["att_file"]);
}
$this->acc_mail->send();
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::setFolderId (   $a_folder_id)

assign users to this folder (normally the usr_folder) But if called from local admin => the ref_id of the category public

Definition at line 359 of file class.ilUserImportParser.php.

{
$this->folder_id = $a_folder_id;
}
ilUserImportParser::setHandlers (   $a_xml_parser)

set event handler should be overwritten by inherited class private

Reimplemented from ilSaxParser.

Definition at line 374 of file class.ilUserImportParser.php.

{
xml_set_object($a_xml_parser,$this);
xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
}
ilUserImportParser::setRoleAssignment (   $a_assign)

set import to local role assignemt

Parameters
arrayrole assignment (key: import id; value: local role id)

Definition at line 394 of file class.ilUserImportParser.php.

{
$this->role_assign = $a_assign;
}
ilUserImportParser::setSendMail (   $value)

write access to property send mail

Parameters
mixed$value

Definition at line 2298 of file class.ilUserImportParser.php.

{
$this->send_mail = $value ? true: false;
}
ilUserImportParser::setUserMappingMode (   $value)

write access to user mapping mode

Parameters
int$valuemust be one of IL_USER_MAPPING_ID or IL_USER_MAPPING_LOGIN, die otherwise

Definition at line 2316 of file class.ilUserImportParser.php.

References IL_USER_MAPPING_ID, and IL_USER_MAPPING_LOGIN.

{
if ($value == IL_USER_MAPPING_ID || $value == IL_USER_MAPPING_LOGIN)
$this->mapping_mode = $value;
else die ("wrong argument using methode setUserMappingMethod in ".__FILE__);
}
ilUserImportParser::startParsing ( )

start the parser

Reimplemented from ilSaxParser.

Definition at line 384 of file class.ilUserImportParser.php.

{
parent::startParsing();
}
ilUserImportParser::updateMailPreferences (   $usr_id)
private

Definition at line 2464 of file class.ilUserImportParser.php.

Referenced by importEndTag().

{
if (array_key_exists("mail_incoming_type", $this->prefs) ||
array_key_exists("mail_signature", $this->prefs) ||
array_key_exists("mail_linebreak", $this->prefs)
)
{
include_once("Services/Mail/classes/class.ilMailOptions.php");
$mailOptions = new ilMailOptions($usr_id);
$mailOptions->updateOptions(
array_key_exists("mail_signature", $this->prefs) ? $this->prefs["mail_signature"] : $mailOptions->getSignature(),
array_key_exists("mail_linebreak", $this->prefs) ? $this->prefs["mail_linebreak"] : $mailOptions->getLinebreak(),
array_key_exists("mail_incoming_type", $this->prefs) ? $this->prefs["mail_incoming_type"] : $mailOptions->getIncomingType(),
$mailOptions->getCronjobNotification()
);
}
}

+ Here is the caller graph for this function:

ilUserImportParser::verifyBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

handler for begin of element

Definition at line 604 of file class.ilUserImportParser.php.

References $action, ilSaxParser\$lng, ilUtil\__extractId(), getUserMappingMode(), IL_USER_MAPPING_ID, and logFailure().

Referenced by handlerBeginTag().

{
global $lng;
switch($a_name)
{
case "Role":
if (is_null($a_attribs['Id'])
|| $a_attribs['Id'] == "")
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_attribute_missing"),"Role","Id"));
}
$this->current_role_id = $a_attribs["Id"];
$this->current_role_type = $a_attribs["Type"];
if ($this->current_role_type != 'Global'
&& $this->current_role_type != 'Local')
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_attribute_missing"),"Role","Type"));
}
$this->current_role_action = (is_null($a_attribs["Action"])) ? "Assign" : $a_attribs["Action"];
if ($this->current_role_action != "Assign"
&& $this->current_role_action != "AssignWithParents"
&& $this->current_role_action != "Detach")
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_attribute_value_illegal"),"Role","Action",$a_attribs["Action"]));
}
if ($this->action == "Insert"
&& $this->current_role_action == "Detach")
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_attribute_value_inapplicable"),"Role","Action",$this->current_role_action,$this->action));
}
if ($this->action == "Delete")
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_element_inapplicable"),"Role","Delete"));
}
break;
case "User":
$this->userCount++;
$this->userObj = new ilObjUser();
$this->userObj->setLanguage($a_attribs["Language"]);
$this->userObj->setImportId($a_attribs["Id"]);
$this->currentPrefKey = null;
// if we have an object id, store it
$this->user_id = -1;
if (!is_null($a_attribs["Id"]) && $this->getUserMappingMode() == IL_USER_MAPPING_ID)
{
if (is_numeric($a_attribs["Id"]))
{
$this->user_id = $a_attribs["Id"];
}
elseif ($id = ilUtil::__extractId ($a_attribs["Id"], IL_INST_ID))
{
$this->user_id = $id;
}
}
$this->action = (is_null($a_attribs["Action"])) ? "Insert" : $a_attribs["Action"];
if ($this->action != "Insert"
&& $this->action != "Update"
&& $this->action != "Delete")
{
$this->logFailure($this->userObj->getImportId(), sprintf($lng->txt("usrimport_xml_attribute_value_illegal"),"User","Action",$a_attribs["Action"]));
}
$this->currPassword = null;
$this->currPasswordType = null;
$this->currPasswordSalt = null;
break;
case 'Password':
$this->currPasswordType = $a_attribs['Type'];
$this->currPasswordSalt = $a_attribs['Salt'];
break;
case "AuthMode":
if (array_key_exists("type", $a_attribs))
{
switch ($a_attribs["type"])
{
case "default":
case "local":
case "ldap":
case "radius":
case "shibboleth":
case "script":
case "cas":
case "soap":
case "openid":
// begin-patch auth_plugin
default:
$this->userObj->setAuthMode($a_attribs["type"]);
break;
/*
default:
$this->logFailure($this->userObj->getImportId(), sprintf($lng->txt("usrimport_xml_attribute_value_illegal"),"AuthMode","type",$a_attribs["type"]));
break;
*
*/
}
}
else
{
$this->logFailure($this->userObj->getImportId(), sprintf($lng->txt("usrimport_xml_attribute_value_illegal"),"AuthMode","type",""));
}
break;
case 'Pref':
$this->currentPrefKey = $a_attribs["key"];
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::verifyEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element when in verify mode.

Definition at line 1732 of file class.ilUserImportParser.php.

References $currPasswordType, $ilSetting, ilSaxParser\$lng, $user_id, ilObjUser\_checkExternalAuthAccount(), ilAuthUtils\_getAuthModeName(), ilObjUser\_lookupExternalAccount(), ilObjUser\_lookupId(), ilObjUser\_lookupLogin(), ilObjUser\getUserIdByLogin(), IL_FAIL_ON_CONFLICT, IL_PASSWD_CRYPTED, IL_PASSWD_PLAIN, isFieldRequired(), logFailure(), logWarning(), USER_FOLDER_ID, and verifyPref().

Referenced by handlerEndTag().

{
global $lng,$ilAccess,$ilSetting,$ilObjDataCache;
switch($a_name)
{
case "Role":
$this->roles[$this->current_role_id]["name"] = $this->cdata;
$this->roles[$this->current_role_id]["type"] = $this->current_role_type;
$this->roles[$this->current_role_id]["action"] = $this->current_role_action;
break;
case "User":
$this->userObj->setFullname();
if ($this->user_id != -1 && ($this->action == "Update" || $this->action == "Delete"))
$user_exists = !is_null(ilObjUser::_lookupLogin($this->user_id));
else
$user_exists = ilObjUser::getUserIdByLogin($this->userObj->getLogin()) != 0;
if (is_null($this->userObj->getLogin()))
{
$this->logFailure("---",sprintf($lng->txt("usrimport_xml_element_for_action_required"),"Login", "Insert"));
}
switch ($this->action)
{
case "Insert" :
if ($user_exists and $this->conflict_rule == IL_FAIL_ON_CONFLICT)
{
$this->logWarning($this->userObj->getLogin(),$lng->txt("usrimport_cant_insert"));
}
if (is_null($this->userObj->getGender()) && $this->isFieldRequired("gender"))
{
$this->logFailure($this->userObj->getLogin(),sprintf($lng->txt("usrimport_xml_element_for_action_required"),"Gender", "Insert"));
}
if (is_null($this->userObj->getFirstname()))
{
$this->logFailure($this->userObj->getLogin(),sprintf($lng->txt("usrimport_xml_element_for_action_required"),"Firstname", "Insert"));
}
if (is_null($this->userObj->getLastname()))
{
$this->logFailure($this->userObj->getLogin(),sprintf($lng->txt("usrimport_xml_element_for_action_required"),"Lastname", "Insert"));
}
if (count($this->roles) == 0)
{
$this->logFailure($this->userObj->getLogin(),sprintf($lng->txt("usrimport_xml_element_for_action_required"),"Role", "Insert"));
}
else
{
$has_global_role = false;
foreach ($this->roles as $role)
{
if ($role['type'] == 'Global')
{
$has_global_role = true;
break;
}
}
if (! $has_global_role)
{
$this->logFailure($this->userObj->getLogin(),sprintf($lng->txt("usrimport_global_role_for_action_required"),"Insert"));
}
}
break;
case "Update" :
if(!$user_exists)
{
$this->logWarning($this->userObj->getLogin(),$lng->txt("usrimport_cant_update"));
}
elseif($this->user_id != -1 && !is_null($this->userObj->getLogin()))
// check if someone owns the new login name!
{
$someonesId = ilObjUser::_lookupId($this->userObj->getLogin());
if (is_numeric($someonesId ) && $someonesId != $this->user_id) {
$this->logFailure($this->userObj->getLogin(), $lng->txt("usrimport_login_is_not_unique"));
}
}
break;
case "Delete" :
if(!$user_exists)
{
$this->logWarning($this->userObj->getLogin(),$lng->txt("usrimport_cant_delete"));
}
break;
}
// init role array for next user
$this->roles = array();
break;
case "Login":
if (array_key_exists($this->cdata, $this->logins))
{
$this->logWarning($this->cdata, $lng->txt("usrimport_login_is_not_unique"));
}
else
{
$this->logins[$this->cdata] = $this->cdata;
}
$this->userObj->setLogin($this->cdata);
break;
case "Password":
switch ($this->currPasswordType)
{
case "BCRYPT":
if(!strlen($this->currPasswordSalt))
{
$this->logFailure($this->userObj->getLogin(), $lng->txt("usrimport_xml_pw_bcrypt_missing_salt"));
}
$this->userObj->setPasswd($this->cdata, IL_PASSWD_CRYPTED);
$this->userObj->setPasswordEncodingType('bcrypt');
$this->userObj->setPasswordSalt($this->currPasswordSalt);
break;
case "MD5":
case "ILIAS3":
$this->userObj->setPasswd($this->cdata, IL_PASSWD_CRYPTED);
$this->userObj->setPasswordEncodingType('md5');
$this->userObj->setPasswordSalt('');
break;
case "PLAIN":
$this->userObj->setPasswd($this->cdata, IL_PASSWD_PLAIN);
$this->acc_mail->setUserPassword($this->currPassword);
break;
default :
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_attribute_value_illegal"),"Type","Password",$this->currPasswordType));
break;
}
break;
case "Firstname":
$this->userObj->setFirstname($this->cdata);
break;
case "Lastname":
$this->userObj->setLastname($this->cdata);
break;
case "Title":
$this->userObj->setUTitle($this->cdata);
break;
case "Gender":
if ($this->cdata != "m"
&& $this->cdata != "f")
{
$this->logFailure(
$this->userObj->getLogin(),
sprintf($lng->txt("usrimport_xml_element_content_illegal"),"Gender",$this->cdata)
);
}
$this->userObj->setGender($this->cdata);
break;
case "Email":
$this->userObj->setEmail($this->cdata);
break;
case "Institution":
$this->userObj->setInstitution($this->cdata);
break;
case "Street":
$this->userObj->setStreet($this->cdata);
break;
case "City":
$this->userObj->setCity($this->cdata);
break;
case "PostalCode":
$this->userObj->setZipCode($this->cdata);
break;
case "Country":
$this->userObj->setCountry($this->cdata);
break;
case "PhoneOffice":
$this->userObj->setPhoneOffice($this->cdata);
break;
case "PhoneHome":
$this->userObj->setPhoneHome($this->cdata);
break;
case "PhoneMobile":
$this->userObj->setPhoneMobile($this->cdata);
break;
case "Fax":
$this->userObj->setFax($this->cdata);
break;
case "Hobby":
$this->userObj->setHobby($this->cdata);
break;
case "GeneralInterest":
case "OfferingHelp":
case "LookingForHelp":
$this->multi_values[$a_name][] = $this->cdata;
break;
case "Comment":
$this->userObj->setComment($this->cdata);
break;
case "Department":
$this->userObj->setDepartment($this->cdata);
break;
case "Matriculation":
$this->userObj->setMatriculation($this->cdata);
break;
case "ExternalAccount":
//echo "-".$this->userObj->getAuthMode()."-".$this->userObj->getLogin()."-";
$am = ($this->userObj->getAuthMode() == "default" || $this->userObj->getAuthMode() == "")
? ilAuthUtils::_getAuthModeName($ilSetting->get('auth_mode'))
: $this->userObj->getAuthMode();
$loginForExternalAccount = (trim($this->cdata) == "")
? ""
: ilObjUser::_checkExternalAuthAccount($am, trim($this->cdata));
switch ($this->action)
{
case "Insert" :
if ($loginForExternalAccount != "")
{
$this->logWarning($this->userObj->getLogin(), $lng->txt("usrimport_no_insert_ext_account_exists")." (".$this->cdata.")");
}
break;
case "Update" :
if ($loginForExternalAccount != "")
{
$externalAccountHasChanged = trim($this->cdata) != ilObjUser::_lookupExternalAccount($this->user_id);
if ($externalAccountHasChanged && trim($loginForExternalAccount) != trim($this->userObj->getLogin()))
{
$this->logWarning($this->userObj->getLogin(),
$lng->txt("usrimport_no_update_ext_account_exists")." (".$this->cdata." for ".$loginForExternalAccount.")");
}
}
break;
}
if ($externalAccountHasChanged)
$this->userObj->setExternalAccount(trim($this->cdata));
break;
case "Active":
if ($this->cdata != "true"
&& $this->cdata != "false")
{
$this->logFailure($this->userObj->getLogin(),
sprintf($lng->txt("usrimport_xml_element_content_illegal"),"Active",$this->cdata));
}
$this->currActive = $this->cdata;
break;
case "TimeLimitOwner":
if (!preg_match("/\d+/", $this->cdata))
{
$this->logFailure($this->userObj->getLogin(),
sprintf($lng->txt("usrimport_xml_element_content_illegal"),"TimeLimitOwner",$this->cdata));
}
elseif(!$ilAccess->checkAccess('cat_administrate_users','',$this->cdata))
{
$this->logFailure($this->userObj->getLogin(),
sprintf($lng->txt("usrimport_xml_element_content_illegal"),"TimeLimitOwner",$this->cdata));
}
elseif($ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($this->cdata)) != 'cat' && !(int) $this->cdata == USER_FOLDER_ID)
{
$this->logFailure($this->userObj->getLogin(),
sprintf($lng->txt("usrimport_xml_element_content_illegal"),"TimeLimitOwner",$this->cdata));
}
$this->userObj->setTimeLimitOwner($this->cdata);
break;
case "TimeLimitUnlimited":
switch (strtolower($this->cdata))
{
case "true":
case "1":
$this->userObj->setTimeLimitUnlimited(1);
break;
case "false":
case "0":
$this->userObj->setTimeLimitUnlimited(0);
break;
default:
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_element_content_illegal"),"TimeLimitUnlimited",$this->cdata));
break;
}
break;
case "TimeLimitFrom":
// Accept datetime or Unix timestamp
if (strtotime($this->cdata) === false && ! is_numeric($this->cdata))
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_element_content_illegal"),"TimeLimitFrom",$this->cdata));
}
$this->userObj->setTimeLimitFrom($this->cdata);
break;
case "TimeLimitUntil":
// Accept datetime or Unix timestamp
if (strtotime($this->cdata) === false && ! is_numeric($this->cdata))
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_element_content_illegal"),"TimeLimitUntil",$this->cdata));
}
$this->userObj->setTimeLimitUntil($this->cdata);
break;
case "TimeLimitMessage":
switch (strtolower($this->cdata))
{
case "1":
$this->userObj->setTimeLimitMessage(1);
break;
case "0":
$this->userObj->setTimeLimitMessage(0);
break;
default:
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_element_content_illegal"),"TimeLimitMessage",$this->cdata));
break;
}
break;
case "ApproveDate":
// Accept datetime or Unix timestamp
if (strtotime($this->cdata) === false && ! is_numeric($this->cdata) && !$this->cdata == "0000-00-00 00:00:00")
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_element_content_illegal"),"ApproveDate",$this->cdata));
}
break;
case "AgreeDate":
// Accept datetime or Unix timestamp
if (strtotime($this->cdata) === false && ! is_numeric($this->cdata) && !$this->cdata == "0000-00-00 00:00:00")
{
$this->logFailure($this->userObj->getLogin(), sprintf($lng->txt("usrimport_xml_element_content_illegal"),"AgreeDate",$this->cdata));
}
break;
case "Pref":
if ($this->currentPrefKey != null)
$this->verifyPref($this->currentPrefKey, $this->cdata);
$this->currentPrefKey == null;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilUserImportParser::verifyPref (   $key,
  $value 
)
private

Definition at line 2385 of file class.ilUserImportParser.php.

References ilTimeZone\_getInstance(), ilUserXMLWriter\isPrefExportable(), and logFailure().

Referenced by verifyEndTag().

{
switch ($key) {
case 'mail_linebreak':
case 'hits_per_page':
if (!is_numeric($value) || $value < 0)
$this->logFailure("---", "Wrong value '$value': Positiv numeric value expected for preference $key.");
break;
case 'language':
case 'skin':
case 'style':
case 'ilPageEditor_HTMLMode':
case 'ilPageEditor_JavaScript':
case 'ilPageEditor_MediaMode':
case 'tst_javascript':
case 'tst_lastquestiontype':
case 'tst_multiline_answers':
case 'tst_use_previous_answers':
case 'graphicalAnswerSetting':
case 'priv_feed_pass':
$this->logFailure("---", "Preference $key is not supported.");
break;
case 'public_city':
case 'public_country':
case 'public_department':
case 'public_email':
case 'public_fax':
case 'public_hobby':
case 'public_institution':
case 'public_matriculation':
case 'public_phone':
case 'public_phone_home':
case 'public_phone_mobile':
case 'public_phone_office':
case 'public_street':
case 'public_upload':
case 'public_zip':
case 'public_interests_general':
case 'public_interests_help_offered':
case 'public_interests_help_looking':
case 'send_info_mails':
case 'hide_own_online_status':
if (!in_array($value, array('y', 'n')))
$this->logFailure("---", "Wrong value '$value': Value 'y' or 'n' expected for preference $key.");
break;
case 'public_profile':
if (!in_array($value, array('y', 'n', 'g')))
$this->logFailure("---", "Wrong value '$value': Value 'y', 'g' or 'n' expected for preference $key.");
break;
case 'show_users_online':
if (!in_array($value, array('y', 'n', 'associated')))
$this->logFailure("---", "Wrong value '$value': Value 'y' or 'n' or 'associated' expected for preference $key.");
break;
case 'mail_incoming_type':
if (!in_array((int) $value, array("0","1","2")))
$this->logFailure("---", "Wrong value '$value': Value \"0\" (LOCAL),\"1\" (EMAIL) or \"2\" (BOTH) expected for preference $key.");
break;
case 'weekstart':
if (!in_array($value, array ("0","1")))
$this->logFailure("---", "Wrong value '$value': Value \"0\" (Sunday) or \"1\" (Monday) expected for preference $key.");
break;
case 'mail_signature':
break;
case 'user_tz':
include_once('Services/Calendar/classes/class.ilTimeZone.php');
try {
$tz = ilTimeZone::_getInstance($value);
return true;
} catch (ilTimeZoneException $tze) {
$this->logFailure("---", "Wrong value '$value': Invalid timezone $value detected for preference $key.");
}
break;
default:
if (!ilUserXMLWriter::isPrefExportable($key))
$this->logFailure("---", "Preference $key is not supported.");
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilUserImportParser::$account_mail_cache = array()
staticprivate

Definition at line 275 of file class.ilUserImportParser.php.

ilUserImportParser::$action

The Action attribute determines what to do for the current User element.

This variable supports the following values: "Insert","Update","Delete".

Definition at line 65 of file class.ilUserImportParser.php.

Referenced by logSuccess(), and verifyBeginTag().

ilUserImportParser::$approve_date_set = false

Definition at line 51 of file class.ilUserImportParser.php.

ilUserImportParser::$conflict_rule

Conflict handling rule.

Values: IL_FAIL_ON_CONFLICT IL_UPDATE_ON_CONFLICT IL_IGNORE_ON_CONFLICT

Definition at line 93 of file class.ilUserImportParser.php.

ilUserImportParser::$currActive

The active state of the current user.

Definition at line 182 of file class.ilUserImportParser.php.

ilUserImportParser::$current_messenger_type
private

Definition at line 270 of file class.ilUserImportParser.php.

ilUserImportParser::$currPassword

The password of the current user.

Definition at line 173 of file class.ilUserImportParser.php.

ilUserImportParser::$currPasswordSalt
protected

Definition at line 178 of file class.ilUserImportParser.php.

ilUserImportParser::$currPasswordType

The password type of the current user.

Definition at line 169 of file class.ilUserImportParser.php.

Referenced by verifyEndTag().

ilUserImportParser::$disableSkin

Indicates if the skins are enabled.

Definition at line 250 of file class.ilUserImportParser.php.

ilUserImportParser::$error_level

This variable is used to report the error level of the validation process or the importing process. 

Values:  IL_IMPORT_SUCCESS
         IL_IMPORT_WARNING
         IL_IMPORT_FAILURE

Meaning of the values when in validation mode: IL_IMPORT_WARNING Some of the entity actions can not be processed as specified in the XML file. One or more of the following conflicts have occurred:

  • An "Insert" action has been specified for a user who is already in the database.
  • An "Update" action has been specified for a user who is not in the database.
  • A "Delete" action has been specified for a user who is not in the database. IL_IMPORT_FAILURE Some of the XML elements are invalid.

Meaning of the values when in import mode: IL_IMPORT_WARNING Some of the entity actions have not beeen processed as specified in the XML file.

In IL_UPDATE_ON_CONFLICT mode, the following may have occured:

  • An "Insert" action has been replaced by a "Update" action for a user who is already in the database.
    • An "Update" action has been replaced by a "Insert" action for a user who is not in the database.
  • A "Delete" action has been replaced by a "Ignore" action for a user who is not in the database.

In IL_IGNORE_ON_CONFLICT mode, the following may have occured:

  • An "Insert" action has been replaced by a "Ignore" action for a user who is already in the database.
  • An "Update" action has been replaced by a "Ignore" action for a user who is not in the database.
    • A "Delete" action has been replaced by a "Ignore" action for a user who is not in the database.

IL_IMPORT_FAILURE The import could not be completed.

In IL_FAIL_ON_CONFLICT mode, the following may have occured:

  • An "Insert" action has failed for a user who is already in the database.
  • An "Update" action has failed for a user who is not in the database.
  • A "Delete" action has failed for a user who is not in the database.

Definition at line 164 of file class.ilUserImportParser.php.

Referenced by getErrorLevel().

ilUserImportParser::$folder_id

Definition at line 59 of file class.ilUserImportParser.php.

Referenced by getFolderId().

ilUserImportParser::$hideSkin

Indicates if the skins are hidden.

Definition at line 245 of file class.ilUserImportParser.php.

ilUserImportParser::$localRoleCache

Cached local roles.

This is used to speed up access to local roles. This is an associative array. The key is either a role_id or a role_id with the string "_courseMembersObject" appended. The value is a role object or the course members object for which the role is defined

Definition at line 210 of file class.ilUserImportParser.php.

ilUserImportParser::$logins

This variable is used to collect each login that we encounter in the import data.

This variable is needed to detect duplicate logins in the import data. The variable is an associative array. (I would prefer using a set, but PHP does not appear to support sets.) Keys are logins. Values are logins.

Definition at line 84 of file class.ilUserImportParser.php.

ilUserImportParser::$mapping_mode

Definition at line 201 of file class.ilUserImportParser.php.

Referenced by getUserMappingMode().

ilUserImportParser::$parentRolesCache

Cached parent roles.

This is used to speed up assignment to local roles with parents. This is an associative array. The key is a role_id . The value is an array of role_ids containing all parent roles.

Definition at line 225 of file class.ilUserImportParser.php.

ilUserImportParser::$personalPicture

Cached personal picture of the actual user This is used because the ilObjUser object has no field for the personal picture.

Definition at line 216 of file class.ilUserImportParser.php.

ilUserImportParser::$protocol

The variable holds the protocol of the import.

This variable is an associative array.

  • Keys are login names of users or "missing login", if the login name is missing.
  • Values are an array of error messages associated with the login. If the value array is empty, then the user was imported successfully.

Definition at line 74 of file class.ilUserImportParser.php.

Referenced by getProtocol().

ilUserImportParser::$roles

Definition at line 60 of file class.ilUserImportParser.php.

Referenced by getCollectedRoles().

ilUserImportParser::$send_mail

Definition at line 101 of file class.ilUserImportParser.php.

Referenced by isSendMail().

ilUserImportParser::$skin

ILIAS skin.

Definition at line 230 of file class.ilUserImportParser.php.

ilUserImportParser::$style

ILIAS style.

Definition at line 235 of file class.ilUserImportParser.php.

Referenced by ilUserImportParser().

ilUserImportParser::$time_limit_owner_set = false

Definition at line 53 of file class.ilUserImportParser.php.

ilUserImportParser::$time_limit_set = false

Definition at line 52 of file class.ilUserImportParser.php.

ilUserImportParser::$updateLookAndSkin = false

boolean to determine if look and skin should be updated

Definition at line 58 of file class.ilUserImportParser.php.

ilUserImportParser::$user_id

Definition at line 257 of file class.ilUserImportParser.php.

Referenced by importEndTag(), and verifyEndTag().

ilUserImportParser::$user_mapping

Definition at line 193 of file class.ilUserImportParser.php.

Referenced by getUserMapping().

ilUserImportParser::$userCount

The count of user elements in the XML file.

Definition at line 186 of file class.ilUserImportParser.php.

Referenced by getUserCount().

ilUserImportParser::$userObj
private

Definition at line 263 of file class.ilUserImportParser.php.

ilUserImportParser::$userStyles

User assigned styles.

Definition at line 240 of file class.ilUserImportParser.php.

The documentation for this class was generated from the following file: