Inheritance diagram for ilObjAuthSettingsGUI:
Collaboration diagram for ilObjAuthSettingsGUI:
Public Member Functions | |
| ilObjAuthSettingsGUI ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true) | |
| Constructor public. | |
| viewObject () | |
| display settings menu | |
| saveObject () | |
| save object public | |
| getTabs (&$tabs_gui) | |
| get tabs public | |
| setAuthModeObject () | |
| editLDAPObject () | |
| Configure LDAP settings. | |
| saveLDAPObject () | |
| validates all input data, save them to database if correct and active chosen auth mode | |
| editScriptObject () | |
| Configure Custom settings. | |
| saveScriptObject () | |
| validates all input data, save them to database if correct and active chosen auth mode | |
| getAuthModeTitle () | |
| get the title of auth mode | |
Detailed Description
Definition at line 36 of file class.ilObjAuthSettingsGUI.php.
Member Function Documentation
| ilObjAuthSettingsGUI::editLDAPObject | ( | ) |
Configure LDAP settings.
public
Definition at line 222 of file class.ilObjAuthSettingsGUI.php.
References $_SESSION, $rbacsystem, $settings, and ilObjectGUI::getTemplateFile().
{
global $rbacsystem;
if (!$rbacsystem->checkAccess("write",$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
if ($_SESSION["error_post_vars"])
{
if ($_SESSION["error_post_vars"]["ldap"]["tls"] == "1")
{
$this->tpl->setVariable("LDAP_TLS_CHK", "checked=\"checked\"");
}
if ($_SESSION["error_post_vars"]["ldap"]["version"] == "3")
{
$this->tpl->setVariable("LDAP_VERSION3_CHK", "checked=\"checked\"");
}
else
{
$this->tpl->setVariable("LDAP_VERSION2_CHK", "checked=\"checked\"");
}
$this->tpl->setVariable("LDAP_SERVER", $_SESSION["error_post_vars"]["ldap"]["server"]);
$this->tpl->setVariable("LDAP_BASEDN", $_SESSION["error_post_vars"]["ldap"]["basedn"]);
$this->tpl->setVariable("LDAP_SEARCH_BASE", $_SESSION["error_post_vars"]["ldap"]["search_base"]);
$this->tpl->setVariable("LDAP_PORT", $_SESSION["error_post_vars"]["ldap"]["port"]);
$this->tpl->setVariable("LDAP_LOGIN_KEY", $_SESSION["error_post_vars"]["ldap"]["login_key"]);
$this->tpl->setVariable("LDAP_OBJECTCLASS", $_SESSION["error_post_vars"]["ldap"]["objectclass"]);
}
else
{
// set already saved data or default value for port
$settings = $this->ilias->getAllSettings();
if ($settings["ldap_tls"] == "1")
{
$this->tpl->setVariable("LDAP_TLS_CHK", "checked=\"checked\"");
}
$this->tpl->setVariable("LDAP_SERVER", $settings["ldap_server"]);
$this->tpl->setVariable("LDAP_BASEDN", $settings["ldap_basedn"]);
$this->tpl->setVariable("LDAP_SEARCH_BASE", $settings["ldap_search_base"]);
if (empty($settings["ldap_port"]))
{
$this->tpl->setVariable("LDAP_PORT", "389");
}
else
{
$this->tpl->setVariable("LDAP_PORT", $settings["ldap_port"]);
}
if (empty($settings["ldap_login_key"]))
{
$this->tpl->setVariable("LDAP_LOGIN_KEY", "uid");
}
else
{
$this->tpl->setVariable("LDAP_LOGIN_KEY", $settings["ldap_login_key"]);
}
if (empty($settings["ldap_objectclass"]))
{
$this->tpl->setVariable("LDAP_OBJECTCLASS", "posixAccount");
}
else
{
$this->tpl->setVariable("LDAP_OBJECTCLASS", $settings["ldap_objectclass"]);
}
if (empty($settings["ldap_version"]) or $settings["ldap_version"] == "2")
{
$this->tpl->setVariable("LDAP_VERSION2_CHK", "checked=\"checked\"");
}
else
{
$this->tpl->setVariable("LDAP_VERSION3_CHK", "checked=\"checked\"");
}
}
$this->getTemplateFile("ldap");
$this->tpl->setVariable("FORMACTION", "adm_object.php?ref_id=".$this->ref_id."&cmd=gateway");
$this->tpl->setVariable("COLSPAN", 3);
$this->tpl->setVariable("TXT_LDAP_TITLE", $this->lng->txt("ldap_configure"));
$this->tpl->setVariable("TXT_OPTIONS", $this->lng->txt("options"));
$this->tpl->setVariable("TXT_LDAP_TLS", $this->lng->txt("ldap_tls"));
$this->tpl->setVariable("TXT_LDAP_SERVER", $this->lng->txt("ldap_server"));
$this->tpl->setVariable("TXT_LDAP_BASEDN", $this->lng->txt("ldap_basedn"));
$this->tpl->setVariable("TXT_LDAP_SEARCH_BASE", $this->lng->txt("ldap_search_base"));
$this->tpl->setVariable("TXT_LDAP_PORT", $this->lng->txt("ldap_port"));
$this->tpl->setVariable("TXT_LDAP_TLS", $this->lng->txt("ldap_tls"));
$this->tpl->setVariable("TXT_LDAP_VERSION", $this->lng->txt("ldap_version"));
$this->tpl->setVariable("TXT_LDAP_VERSION2", $this->lng->txt("ldap_v2"));
$this->tpl->setVariable("TXT_LDAP_VERSION3", $this->lng->txt("ldap_v3"));
$this->tpl->setVariable("TXT_LDAP_LOGIN_KEY", $this->lng->txt("ldap_login_key"));
$this->tpl->setVariable("TXT_LDAP_OBJECTCLASS", $this->lng->txt("ldap_objectclass"));
$this->tpl->setVariable("TXT_LDAP_PASSWD", $this->lng->txt("ldap_passwd"));
$this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
$this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
$this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
$this->tpl->setVariable("CMD_SUBMIT", "saveLDAP");
}
Here is the call graph for this function:
| ilObjAuthSettingsGUI::editScriptObject | ( | ) |
Configure Custom settings.
public
Definition at line 451 of file class.ilObjAuthSettingsGUI.php.
References $_SESSION, $rbacsystem, $settings, and ilObjectGUI::getTemplateFile().
{
global $rbacsystem;
if (!$rbacsystem->checkAccess("write",$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
if ($_SESSION["error_post_vars"])
{
$this->tpl->setVariable("AUTH_SCRIPT_NAME", $_SESSION["error_post_vars"]["auth_script"]["name"]);
}
else
{
// set already saved data
$settings = $this->ilias->getAllSettings();
$this->tpl->setVariable("AUTH_SCRIPT_NAME", $settings["auth_script_name"]);
}
$this->getTemplateFile("script");
$this->tpl->setVariable("FORMACTION", "adm_object.php?ref_id=".$this->ref_id."&cmd=gateway");
$this->tpl->setVariable("COLSPAN", 3);
$this->tpl->setVariable("TXT_AUTH_SCRIPT_TITLE", $this->lng->txt("auth_script_configure"));
$this->tpl->setVariable("TXT_OPTIONS", $this->lng->txt("options"));
$this->tpl->setVariable("TXT_AUTH_SCRIPT_NAME", $this->lng->txt("auth_script_name"));
$this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
$this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
$this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
$this->tpl->setVariable("CMD_SUBMIT", "saveScript");
}
Here is the call graph for this function:
| ilObjAuthSettingsGUI::getAuthModeTitle | ( | ) |
get the title of auth mode
public
- Returns:
- string language dependent title of auth mode
Definition at line 522 of file class.ilObjAuthSettingsGUI.php.
Referenced by saveLDAPObject(), saveScriptObject(), and setAuthModeObject().
{
switch ($this->ilias->getSetting("auth_mode"))
{
case AUTH_LOCAL:
return $this->lng->txt("auth_local");
break;
case AUTH_LDAP:
return $this->lng->txt("auth_ldap");
break;
case AUTH_RADIUS:
return $this->lng->txt("auth_radius");
break;
case AUTH_SCRIPT:
return $this->lng->txt("auth_script");
break;
default:
return $this->lng->txt("unknown");
break;
}
}
Here is the caller graph for this function:
| ilObjAuthSettingsGUI::getTabs | ( | &$ | tabs_gui | ) |
get tabs public
- Parameters:
-
object tabs gui object
Reimplemented from ilObjectGUI.
Definition at line 158 of file class.ilObjAuthSettingsGUI.php.
{
// tabs are defined manually here. The autogeneration via objects.xml will be deprecated in future
// for usage examples see ilObjGroupGUI or ilObjSystemFolderGUI
}
| ilObjAuthSettingsGUI::ilObjAuthSettingsGUI | ( | $ | a_data, | |
| $ | a_id, | |||
| $ | a_call_by_reference, | |||
| $ | a_prepare_output = true | |||
| ) |
Constructor public.
Definition at line 42 of file class.ilObjAuthSettingsGUI.php.
References ilObjectGUI::ilObjectGUI().
{
$this->type = "auth";
$this->ilObjectGUI($a_data,$a_id,$a_call_by_reference,$a_prepare_output);
}
Here is the call graph for this function:
| ilObjAuthSettingsGUI::saveLDAPObject | ( | ) |
validates all input data, save them to database if correct and active chosen auth mode
public
Definition at line 338 of file class.ilObjAuthSettingsGUI.php.
References $_POST, $ilUser, getAuthModeTitle(), ilObjectGUI::getReturnLocation(), ilUtil::redirect(), and sendInfo().
{
global $ilUser;
// validate required data
if (!$_POST["ldap"]["server"] or !$_POST["ldap"]["basedn"] or !$_POST["ldap"]["port"] or !$_POST["ldap"]["login_key"] or !$_POST["ldap"]["objectclass"])
{
$this->ilias->raiseError($this->lng->txt("fill_out_all_required_fields"),$this->ilias->error_obj->MESSAGE);
}
// validate password
if (!$_POST["ldap"]["passwd"])
{
$this->ilias->raiseError($this->lng->txt("err_enter_current_passwd"),$this->ilias->error_obj->MESSAGE);
}
// validate port
if ((preg_match("/^[0-9]{0,5}$/",$_POST["ldap"]["port"])) == false)
{
$this->ilias->raiseError($this->lng->txt("err_invalid_port"),$this->ilias->error_obj->MESSAGE);
}
// TODO: implement TLS support
if ($_POST["ldap"]["tls"] != "1")
{
$_POST["ldap"]["tls"] = "0";
}
// check connection to ldap server
$ldap_host = $_POST["ldap"]["server"];
$ldap_port = $_POST["ldap"]["port"];
$ldap_pass = $_POST["ldap"]["passwd"];
$ldap_userattr = $_POST["ldap"]["login_key"];
$ldap_useroc = $_POST["ldap"]["objectclass"];
$ldap_dn = $ldap_userattr."=".$this->ilias->account->getLogin().",";
// create base_dn
if ($_POST["ldap"]["search_base"])
{
$ldap_searchbase .= $_POST["ldap"]["search_base"].",";
}
$ldap_searchbase .= $_POST["ldap"]["basedn"];
$ldap_dn .= $ldap_searchbase;
// test connection
$ldap_conn = ldap_connect($ldap_host,$ldap_port);
@ldap_set_option($ldap_conn, LDAP_OPT_PROTOCOL_VERSION, $_POST["ldap"]["version"]);
// bind anonymously
if (($ldap_bind = ldap_bind($ldap_conn)) == false)
{
$this->ilias->raiseError($this->lng->txt("err_ldap_connect_failed"),$this->ilias->error_obj->MESSAGE);
}
// make user search
$filter = sprintf('(&(objectClass=%s)(%s=%s))', $ldap_useroc, $ldap_userattr, $ilUser->getLogin());
// make functions params array
$func_params = array($ldap_conn, $ldap_searchbase, $filter, array($ldap_userattr));
// search
if (($result_id = @call_user_func_array('ldap_search', $func_params)) == false)
{
$this->ilias->raiseError($this->lng->txt("err_ldap_search_failed"),$this->ilias->error_obj->MESSAGE);
}
if (ldap_count_entries($ldap_conn, $result_id) != 1)
{
$this->ilias->raiseError($this->lng->txt("err_ldap_user_not_found"),$this->ilias->error_obj->MESSAGE);
}
// then get the user dn
$entry_id = ldap_first_entry($ldap_conn, $result_id);
$user_dn = ldap_get_dn($ldap_conn, $entry_id);
ldap_free_result($result_id);
// bind with password
if (@ldap_bind($ldap_conn, $user_dn, $ldap_pass) == false)
{
$this->ilias->raiseError($this->lng->txt("err_ldap_auth_failed"),$this->ilias->error_obj->MESSAGE);
}
// close connection
@ldap_unbind($ldap_conn);
// all ok. save settings and activate LDAP
$this->ilias->setSetting("ldap_tls", $_POST["ldap"]["tls"]);
$this->ilias->setSetting("ldap_server", $_POST["ldap"]["server"]);
$this->ilias->setSetting("ldap_basedn", $_POST["ldap"]["basedn"]);
$this->ilias->setSetting("ldap_search_base", $_POST["ldap"]["search_base"]);
$this->ilias->setSetting("ldap_port", $_POST["ldap"]["port"]);
$this->ilias->setSetting("ldap_version", $_POST["ldap"]["version"]);
$this->ilias->setSetting("ldap_login_key", $_POST["ldap"]["login_key"]);
$this->ilias->setSetting("ldap_objectclass", $_POST["ldap"]["objectclass"]);
$this->ilias->setSetting("auth_mode", AUTH_LDAP);
sendInfo($this->lng->txt("auth_mode_changed_to")." ".$this->getAuthModeTitle(),true);
ilUtil::redirect($this->getReturnLocation("view",$this->ctrl->getLinkTarget($this,"")));
}
Here is the call graph for this function:
| ilObjAuthSettingsGUI::saveObject | ( | ) |
save object public
Reimplemented from ilObjectGUI.
Definition at line 132 of file class.ilObjAuthSettingsGUI.php.
References $rbacadmin, ilObjectGUI::getReturnLocation(), ilUtil::redirect(), and sendInfo().
{
global $rbacadmin;
// create and insert forum in objecttree
$newObj = parent::saveObject();
// setup rolefolder & default local roles
//$roles = $newObj->initDefaultRoles();
// ...finally assign role to creator of object
//$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "y");
// put here object specific stuff
// always send a message
sendInfo($this->lng->txt("object_added"),true);
ilUtil::redirect($this->getReturnLocation("save",$this->ctrl->getLinkTarget($this,"")));
}
Here is the call graph for this function:
| ilObjAuthSettingsGUI::saveScriptObject | ( | ) |
validates all input data, save them to database if correct and active chosen auth mode
public
Definition at line 491 of file class.ilObjAuthSettingsGUI.php.
References $_POST, getAuthModeTitle(), ilObjectGUI::getReturnLocation(), ilUtil::redirect(), and sendInfo().
{
// validate required data
if (!$_POST["auth_script"]["name"])
{
$this->ilias->raiseError($this->lng->txt("fill_out_all_required_fields"),$this->ilias->error_obj->MESSAGE);
}
// validate script url
/*
if (( TODO ,$_POST["ldap"]["server"])) == false)
{
$this->ilias->raiseError($this->lng->txt("err_invalid_server"),$this->ilias->error_obj->MESSAGE);
}*/
// TODO: check connection to server
// all ok. save settings and activate auth by external script
$this->ilias->setSetting("auth_script_name", $_POST["auth_script"]["name"]);
$this->ilias->setSetting("auth_mode", AUTH_SCRIPT);
sendInfo($this->lng->txt("auth_mode_changed_to")." ".$this->getAuthModeTitle(),true);
ilUtil::redirect($this->getReturnLocation("view",$this->ctrl->getLinkTarget($this,"")));
}
Here is the call graph for this function:
| ilObjAuthSettingsGUI::setAuthModeObject | ( | ) |
Definition at line 164 of file class.ilObjAuthSettingsGUI.php.
References $_POST, $rbacsystem, getAuthModeTitle(), ilObjectGUI::getReturnLocation(), ilUtil::redirect(), and sendInfo().
{
global $rbacsystem;
if (!$rbacsystem->checkAccess("write",$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
if (empty($_POST["auth_mode"]))
{
$this->ilias->raiseError($this->lng->txt("auth_err_no_mode_selected"),$this->ilias->error_obj->MESSAGE);
}
if ($_POST["auth_mode"] == AUTH_CURRENT)
{
sendInfo($this->lng->txt("auth_mode").": ".$this->getAuthModeTitle()." ".$this->lng->txt("auth_mode_not_changed"),true);
ilUtil::redirect($this->getReturnLocation("view",$this->ctrl->getLinkTarget($this,"")));
}
switch ($_POST["auth_mode"])
{
case AUTH_LDAP:
if ($this->object->checkAuthLDAP() !== true)
{
sendInfo($this->lng->txt("auth_ldap_not_configured"),true);
ilUtil::redirect($this->getReturnLocation("view",$this->ctrl->getLinkTarget($this,"editLDAP")));
}
break;
case AUTH_RADIUS:
if ($this->object->checkAuthRADIUS() !== true)
{
sendInfo($this->lng->txt("auth_radius_not_configured"),true);
ilUtil::redirect($this->getReturnLocation("view",$this->ctrl->getLinkTarget($this,"editRADIUS")));
}
break;
case AUTH_SCRIPT:
if ($this->object->checkAuthScript() !== true)
{
sendInfo($this->lng->txt("auth_script_not_configured"),true);
ilUtil::redirect($this->getReturnLocation("view",$this->ctrl->getLinkTarget($this,"editScript")));
}
break;
}
$this->ilias->setSetting("auth_mode",$_POST["auth_mode"]);
sendInfo($this->lng->txt("auth_mode_changed_to")." ".$this->getAuthModeTitle(),true);
ilUtil::redirect($this->getReturnLocation("view",$this->ctrl->getLinkTarget($this,"")));
}
Here is the call graph for this function:
| ilObjAuthSettingsGUI::viewObject | ( | ) |
display settings menu
public
Reimplemented from ilObjectGUI.
Definition at line 53 of file class.ilObjAuthSettingsGUI.php.
References $rbacsystem, and ilObjectGUI::getTemplateFile().
{
global $rbacsystem;
if (!$rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
$this->getTemplateFile("general");
$this->tpl->setVariable("FORMACTION", "adm_object.php?ref_id=".$this->ref_id."&cmd=gateway");
$this->tpl->setVariable("COLSPAN", 3);
$this->tpl->setVariable("TXT_AUTH_TITLE", $this->lng->txt("auth_select"));
$this->tpl->setVariable("TXT_OPTIONS", $this->lng->txt("options"));
$this->tpl->setVariable("TXT_LOCAL", $this->lng->txt("auth_local"));
$this->tpl->setVariable("TXT_LOCAL_DESC", $this->lng->txt("auth_local_desc"));
$this->tpl->setVariable("TXT_LDAP", $this->lng->txt("auth_ldap"));
$this->tpl->setVariable("TXT_LDAP_DESC", $this->lng->txt("auth_ldap_desc"));
$this->tpl->setVariable("TXT_RADIUS", $this->lng->txt("auth_radius"));
$this->tpl->setVariable("TXT_RADIUS_DESC", $this->lng->txt("auth_radius_desc"));
$this->tpl->setVariable("TXT_SCRIPT", $this->lng->txt("auth_script"));
$this->tpl->setVariable("TXT_SCRIPT_DESC", $this->lng->txt("auth_script_desc"));
$this->tpl->setVariable("TXT_CONFIGURE", $this->lng->txt("auth_configure"));
$this->tpl->setVariable("TXT_AUTH_REMARK", $this->lng->txt("auth_remark_non_local_auth"));
$this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
$this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
$this->tpl->setVariable("CMD_SUBMIT", "setAuthMode");
// local vars
$checked = "checked=\"checked\"";
$disabled = "disabled=\"disabled\"";
$style_disabled = "_disabled";
// alter style and disable buttons depending on current selection
switch (AUTH_CURRENT)
{
case AUTH_LOCAL: // default
$this->tpl->setVariable("CHK_LOCAL", $checked);
$this->tpl->setVariable("SUB_LDAP", $style_disabled);
$this->tpl->setVariable("BTN_LDAP", $disabled);
$this->tpl->setVariable("SUB_RADIUS", $style_disabled);
$this->tpl->setVariable("BTN_RADIUS", $disabled);
$this->tpl->setVariable("SUB_SCRIPT", $style_disabled);
$this->tpl->setVariable("BTN_SCRIPT", $disabled);
break;
case AUTH_LDAP: // LDAP
$this->tpl->setVariable("CHK_LDAP", $checked);
$this->tpl->setVariable("SUB_RADIUS", $style_disabled);
$this->tpl->setVariable("BTN_RADIUS", $disabled);
$this->tpl->setVariable("SUB_SCRIPT", $style_disabled);
$this->tpl->setVariable("BTN_SCRIPT", $disabled);
break;
case AUTH_RADIUS: // RADIUS
$this->tpl->setVariable("CHK_RADIUS", $checked);
$this->tpl->setVariable("SUB_LDAP", $style_disabled);
$this->tpl->setVariable("BTN_LDAP", $disabled);
$this->tpl->setVariable("SUB_SCRIPT", $style_disabled);
$this->tpl->setVariable("BTN_SCRIPT", $disabled);
break;
case AUTH_SCRIPT: // script
$this->tpl->setVariable("CHK_SCRIPT", $checked);
$this->tpl->setVariable("SUB_LDAP", $style_disabled);
$this->tpl->setVariable("BTN_LDAP", $disabled);
$this->tpl->setVariable("SUB_RADIUS", $style_disabled);
$this->tpl->setVariable("BTN_RADIUS", $disabled);
break;
}
}
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- classes/class.ilObjAuthSettingsGUI.php
