class.ilPasswordInputGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilPasswordInputGUI extends ilSubEnabledFormPropertyGUI
{
        protected $value;
        protected $size = 20;
        protected $validateauthpost = "";
        protected $requiredonauth = false;
        protected $maxlength = false;
        protected $use_strip_slashes = true;

        protected $autocomplete_disabled = true;
        
        function __construct($a_title = "", $a_postvar = "")
        {
                parent::__construct($a_title, $a_postvar);
                $this->setRetype(true);
                $this->setSkipSyntaxCheck(false);
        }

        function setValue($a_value)
        {
                $this->value = $a_value;
        }

        function getValue()
        {
                return $this->value;
        }

        function setRetype($a_val)
        {
                $this->retype = $a_val;
        }
        
        function getRetype()
        {
                return $this->retype;
        }
        
        function setRetypeValue($a_retypevalue)
        {
                $this->retypevalue = $a_retypevalue;
        }

        function getRetypeValue()
        {
                return $this->retypevalue;
        }

        function setMaxLength($a_maxlength)
        {
                $this->maxlength = $a_maxlength;
        }

        function getMaxLength()
        {
                return $this->maxlength;
        }

        function setSize($a_size)
        {
                $this->size = $a_size;
        }

        function setValueByArray($a_values)
        {
                $this->setValue($a_values[$this->getPostVar()]);
                $this->setRetypeValue($a_values[$this->getPostVar()."_retype"]);
        }

        function getSize()
        {
                return $this->size;
        }

        function setValidateAuthPost($a_validateauthpost)
        {
                $this->validateauthpost = $a_validateauthpost;
        }

        function getValidateAuthPost()
        {
                return $this->validateauthpost;
        }

        function setRequiredOnAuth($a_requiredonauth)
        {
                $this->requiredonauth = $a_requiredonauth;
        }

        function getRequiredOnAuth()
        {
                return $this->requiredonauth;
        }

        function setSkipSyntaxCheck($a_val)
        {
                $this->skip_syntax_check = $a_val;
        }
        
        function getSkipSyntaxCheck()
        {
                return $this->skip_syntax_check;
        }
        
        function setDisableHtmlAutoComplete($a_value)
        {
                $this->autocomplete_disabled = (bool)$a_value;
        }

        function isHtmlAutoCompleteDisabled()
        {
                return $this->autocomplete_disabled;
        }
        
        public function setUseStripSlashes($a_stat)
        {
                $this->use_strip_slashes = $a_stat;
        }
        
        public function getUseStripSlashes()
        {
                return $this->use_strip_slashes;
        }
        
        function checkInput()
        {
                global $lng;
                
                if($this->getUseStripSlashes())
                {
                        $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                        $_POST[$this->getPostVar()."_retype"] = ilUtil::stripSlashes($_POST[$this->getPostVar()."_retype"]);
                }
                if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                {
                        $this->setAlert($lng->txt("msg_input_is_required"));

                        return false;
                }
                if ($this->getValidateAuthPost() != "")
                {
                        $auth = ilAuthUtils::_getAuthMode($_POST[$this->getValidateAuthPost()]);

                        // check, if password is required dependent on auth mode
                        if ($this->getRequiredOnAuth() && ilAuthUtils::_allowPasswordModificationByAuthMode($auth)
                                && trim($_POST[$this->getPostVar()]) == "")
                        {
                                $this->setAlert($lng->txt("form_password_required_for_auth"));
        
                                return false;
                        }
                        
                        // check, if password is allowed to be set for given auth mode
                        if (trim($_POST[$this->getPostVar()]) != "" &&
                                !ilAuthUtils::_allowPasswordModificationByAuthMode($auth))
                        {
                                $this->setAlert($lng->txt("form_password_not_allowed_for_auth"));
        
                                return false;
                        }
                }
                if ($this->getRetype() &&
                        ($_POST[$this->getPostVar()] != $_POST[$this->getPostVar()."_retype"]))
                {
                        $this->setAlert($lng->txt("passwd_not_match"));

                        return false;
                }
                if (!$this->getSkipSyntaxCheck() &&
                        !ilUtil::isPassword($_POST[$this->getPostVar()],$custom_error) &&
                        $_POST[$this->getPostVar()] != "")
                {
                        if($custom_error != '') $this->setAlert($custom_error);
                        else $this->setAlert($lng->txt("passwd_invalid"));

                        return false;
                }
                
                return $this->checkSubItemsInput();
        }

        function render()
        {
                global $lng;
                
                $ptpl = new ilTemplate("tpl.prop_password.html", true, true, "Services/Form");
                
                if ($this->getRetype())
                {
                        $ptpl->setCurrentBlock("retype");
                        $ptpl->setVariable("RSIZE", $this->getSize());
                        $ptpl->setVariable("RID", $this->getFieldId());
                        $ptpl->setVariable("RMAXLENGTH", $this->getMaxLength());
                        $ptpl->setVariable("RPOST_VAR", $this->getPostVar());

                        if($this->isHtmlAutoCompleteDisabled())
                        {
                                $ptpl->setVariable("RAUTOCOMPLETE", "autocomplete=\"off\"");
                        }

                        // this is creating an "auto entry" in the setup, if the retype is missing
                        /*$retype_value = ($this->getRetypeValue() != "")
                                ? $this->getRetypeValue()
                                : $this->getValue();*/
                        $retype_value = $this->getRetypeValue();
                        $ptpl->setVariable("PROPERTY_RETYPE_VALUE", ilUtil::prepareFormOutput($retype_value));
                        if ($this->getDisabled())
                        {
                                $ptpl->setVariable("RDISABLED",
                                        " disabled=\"disabled\"");
                        }
                        $ptpl->setVariable("TXT_RETYPE", $lng->txt("form_retype_password"));
                        $ptpl->parseCurrentBlock();
                }

                if (strlen($this->getValue()))
                {
                        $ptpl->setCurrentBlock("prop_password_propval");
                        $ptpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
                        $ptpl->parseCurrentBlock();
                }
                $ptpl->setVariable("POST_VAR", $this->getPostVar());
                $ptpl->setVariable("ID", $this->getFieldId());
                $ptpl->setVariable("SIZE", $this->getSize());
                $ptpl->setVariable("MAXLENGTH", $this->getMaxLength());
                if ($this->getDisabled())
                {
                        $ptpl->setVariable("DISABLED",
                                " disabled=\"disabled\"");
                }
                if($this->isHtmlAutoCompleteDisabled())
                {
                        $ptpl->setVariable("AUTOCOMPLETE", "autocomplete=\"off\"");
                }
                if($this->getRequired())
                {
                        $ptpl->setVariable("REQUIRED", "required=\"required\"");
                }
                return $ptpl->get();
        }
        
        function insert($a_tpl)
        {
                $html = $this->render();

                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $html);
                $a_tpl->parseCurrentBlock();
        }
}
?>