Services/Init/classes/class.ilPasswordAssistanceGUI.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

class ilPasswordAssistanceGUI
{
        function ilPasswordAssistanceGUI()
        {
                global $ilCtrl;
                
                $this->ctrl =& $ilCtrl;
        }
        
        function &executeCommand()
        {
                global $ilias, $lng, $ilSetting, $ilErr, $ilAuth;
                
                // check hack attempts
                if (!$ilSetting->get("password_assistance")) // || AUTH_DEFAULT != AUTH_LOCAL)
                {
                        if (empty($_SESSION["AccountId"]) and $_SESSION["AccountId"] !== false)
                        {
                                $ilErr->raiseError($lng->txt("permission_denied"),$ilias->error_obj->WARNING);
                        }
                }
                
                // check correct setup
                if (!$ilSetting->get("setup_ok"))
                {
                        die("Setup is not completed. Please run setup routine again. (pwassist.php)");
                }

                // Change the language, if necessary. 
                // And load the 'pwassist' language module
                $lang = $_GET['lang'];
                if ($lang != null && $lang != "" && $lng->getLangKey() != $lang)
                {
                        $lng = new ilLanguage($lang);
                }
                $lng->loadLanguageModule('pwassist');

                $cmd = $this->ctrl->getCmd();
                $next_class = $this->ctrl->getNextClass($this);
                
                switch($next_class)
                {                               
                        default:
                                if ($cmd != "")
                                {
                                        return $this->$cmd();
                                }
                                else
                                {
                                        if (!empty($_GET["key"])) {
                                                $this->showAssignPasswordForm();
                                        } else {
                                                $this->showAssistanceForm();
                                        }
                                }
                                break;
                }
                
                // Logout current session
                //$ilAuth->logout();
                //session_destroy();

        }


        /* Shows the password assistance form.
         * This form is used to request a password assistance mail from ILIAS.
         *
         * This form contains the following fields: 
         * username 
         * email 
         *
         * When the user submits the form, then this script is invoked with the cmd
         * 'submitAssistanceForm'.
         *
         * @param message  A message to display on the form.
         * @param username The user name to be shown in the form.
         * @param email    The e-mail to be shown in the form.
         */
        function showAssistanceForm($message="", $username="", $email="")
        {
                global $tpl, $ilias, $lng;

                // Create the form
                $tpl->addBlockFile("CONTENT", "content", "tpl.pwassist_assistance.html");
                
                if ($message != "")
                {
                        $tpl->setCurrentBlock("pw_message");
                        $tpl->setVariable("TXT_MESSAGE", str_replace("\\n","<br>",$message));
                        $tpl->parseCurrentBlock();
                }
                
                $tpl->setVariable("FORMACTION",
                        $this->ctrl->getFormAction($this));
                $tpl->setVariable("TARGET","target=\"_parent\"");
                $tpl->setVariable("IMG_AUTH",
                        ilUtil::getImagePath("icon_auth_b.gif"));
                $tpl->setVariable("TXT_PAGEHEADLINE", $lng->txt("password_assistance"));
        
                $contact_address = $ilias->getSetting("admin_email");
                $tpl->setVariable
                (
                        "TXT_ENTER_USERNAME_AND_EMAIL", 
                        str_replace
                        (
                                "\\n","<br>",
                                sprintf
                                        (
                                        $lng->txt("pwassist_enter_username_and_email"),
                                        "<a href=\"mailto:".$contact_address."\">".$contact_address."</a>"
                                        )
                        )
                );
                $tpl->setVariable("TXT_USERNAME", $lng->txt("username"));
                $tpl->setVariable("TXT_EMAIL", $lng->txt("email"));
                $tpl->setVariable("USERNAME", $username);
                $tpl->setVariable("EMAIL", $email);
                $tpl->setVariable("TXT_SUBMIT", $lng->txt("submit"));
                $tpl->setVariable("BACK", $lng->txt("back"));
                $tpl->setVariable("LINK_BACK",
                        $this->ctrl->getLinkTargetByClass("ilstartupgui", "showLogin"));
                $tpl->setVariable("LANG", $lng->getLangKey());
        
                $tpl->show();
        }
        
        
        /* Shows the password assistance form.
         * This form is used to request a password assistance mail from ILIAS.
         *
         * This form contains the following fields: 
         * username 
         * email 
         *
         * When the user submits the form, then this script is invoked with the cmd
         * 'submitAssistanceForm'.
         *
         * @param message  A message to display on the form.
         * @param username The user name to be shown in the form.
         * @param email    The e-mail to be shown in the form.
         */
        function showUsernameAssistanceForm($message="", $username="", $email="")
        {
                global $tpl, $ilias, $lng;

                // Create the form
                $tpl->addBlockFile("CONTENT", "content", "tpl.pwassist_username_assistance.html");

                if ($message != "")
                {
                        $tpl->setCurrentBlock("pw_message");
                        $tpl->setVariable("TXT_MESSAGE", str_replace("\\n","<br>",$message));
                        $tpl->parseCurrentBlock();
                }

                $tpl->setVariable("FORMACTION",
                        $this->ctrl->getFormAction($this));
                $tpl->setVariable("IMG_AUTH",
                        ilUtil::getImagePath("icon_auth_b.gif"));
                $tpl->setVariable("TARGET","target=\"_parent\"");
                $tpl->setVariable("TXT_PAGEHEADLINE", $lng->txt("password_assistance"));
        
                $contact_address = $ilias->getSetting("admin_email");
                $tpl->setVariable
                (
                        "TXT_ENTER_USERNAME_AND_EMAIL", 
                        str_replace
                        (
                                "\\n","<br>",
                                sprintf
                                        (
                                        $lng->txt("pwassist_enter_email"),
                                        "<a href=\"mailto:".$contact_address."\">".$contact_address."</a>"
                                        )
                        )
                );
                $tpl->setVariable("TXT_USERNAME", $lng->txt("username"));
                $tpl->setVariable("TXT_EMAIL", $lng->txt("email"));
                $tpl->setVariable("USERNAME", $username);
                $tpl->setVariable("EMAIL", $email);
                $tpl->setVariable("TXT_SUBMIT", $lng->txt("submit"));
                $tpl->setVariable("BACK", $lng->txt("back"));
                $tpl->setVariable("LINK_BACK",
                        $this->ctrl->getLinkTargetByClass("ilstartupgui", "showLogin"));
                $tpl->setVariable("LANG", $lng->getLangKey());
        
                $tpl->show();
        }
        
        function submitAssistanceForm()
        {
                global $tpl, $ilias, $lng, $rbacadmin, $rbacreview;
                
                require_once "classes/class.ilObjUser.php";
                require_once "classes/class.ilUtil.php";
                
                // Retrieve form data
                $username = ilUtil::stripSlashes($_POST["username"]);
                $email = ilUtil::stripSlashes($_POST["email"]);
                
                // Retrieve a user object with matching user name and email address.
                $userObj = null;
                $userid = ilObjUser::getUserIdByLogin($username);
                $txt_key = "pwassist_invalid_username_or_email";
                if ($userid != 0)
                {
                        $userObj = new ilObjUser($userid);
                        if (strcasecmp($userObj->getEmail(), $email) != 0) 
                        {
                                $userObj = null;
                        } else if ($userObj->getAuthMode(true) != AUTH_LOCAL ||
                                 ($userObj->getAuthMode(true) == AUTH_DEFAULT && AUTH_DEFAULT != AUTH_LOCAL))                   
                        {
                            $userObj = null;
                            $txt_key = "pwassist_invalid_auth_mode";
                        }
                }
                
                // No matching user object found?
                // Show the password assistance form again, and display an error message.
                if ($userObj == null) 
                {
                        $this->showAssistanceForm
                        (
                                $lng->txt($txt_key),
                                $username,
                                $email
                        );
                }
        
                // Matching user object found?
                // Check if the user is permitted to use the password assistance function,
                // and then send a password assistance mail to the email address.
                else
                {
                        // FIXME: Extend this if-statement to check whether the user
                        // has the permission to use the password assistance function.
                        // The anonymous user and users who are system administrators are
                        // not allowed to use this feature
                        if ($rbacreview->isAssigned($userObj->getID, ANONYMOUS_ROLE_ID)
                        || $rbacreview->isAssigned($userObj->getID, SYSTEM_ROLE_ID)
                        ) 
                        {
                                $this->showAssistanceForm
                                (
                                        $lng->txt("pwassist_not_permitted"),
                                        $username,
                                        $email
                                );
                        }
                        else
                        {
                                $this->sendPasswordAssistanceMail($userObj);
                                $this->showMessageForm
                                (
                                        null,
                                        sprintf
                                        (
                                                $lng->txt("pwassist_mail_sent"),
                                                $email
                                        )
                                );
                        }
                }
        }
        
        function submitUsernameAssistanceForm()
        {
                global $tpl, $ilias, $lng, $rbacadmin, $rbacreview;
                
                require_once "classes/class.ilObjUser.php";
                require_once "classes/class.ilUtil.php";
                
                // Retrieve form data
                $email = ilUtil::stripSlashes($_POST["email"]);
                
                // Retrieve a user object with matching user name and email address.
                $logins = ilObjUser::_getUserIdsByEmail($email);
                
                // No matching user object found?
                // Show the password assistance form again, and display an error message.
                if (count($logins)< 1)  
                {
                        $this->showUsernameAssistanceForm
                        (
                                $lng->txt("pwassist_invalid_email"),
                                "",
                                $email
                        );
                }
        
                // Matching user object found?
                // Check if the user is permitted to use the password assistance function,
                // and then send a password assistance mail to the email address.
                else
                {
                        // FIXME: Extend this if-statement to check whether the user
                        // has the permission to use the password assistance function.
                        // The anonymous user and users who are system administrators are
                        // not allowed to use this feature
        /*              if ($rbacreview->isAssigned($userObj->getID, ANONYMOUS_ROLE_ID)
                        || $rbacreview->isAssigned($userObj->getID, SYSTEM_ROLE_ID)
                        ) 
                        {
                                $this->showAssistanceForm
                                (
                                        $lng->txt("pwassist_not_permitted"),
                                        $username,
                                        $email
                                );
                        } 
                        else */
                        {
                                $this->sendUsernameAssistanceMail($email, $logins);
                                $this->showMessageForm
                                (
                                        null,
                                        sprintf
                                        (
                                                $lng->txt("pwassist_mail_sent"),
                                                $email
                                        )
                                );
                        }
                }
        }
        
        function sendPasswordAssistanceMail($userObj)
        {
                global $lng, $ilias;
        
                include_once "classes/class.ilMailbox.php";
                include_once "classes/class.ilMimeMail.php";
                require_once "include/inc.pwassist_session_handler.php";
                
        
                // Check if we need to create a new session
                $pwassist_session = db_pwassist_session_find($userObj->getId());
                if (count($pwassist_session) == 0 || $pwassist_session["expires"] < time())
                {
                        // Create a new session id
                        db_set_save_handler();
                        session_start();
                        $pwassist_session["pwassist_id"] = db_pwassist_create_id();
                        session_destroy();
                        db_pwassist_session_write(
                                $pwassist_session["pwassist_id"],
                                3600, 
                                $userObj->getId()
                        );
                }
                $protocol = isset($_SERVER['HTTPS'])?"https://":"http://";
                // Compose the mail
                $server_url=$protocol.$_SERVER['HTTP_HOST'].
                        substr($_SERVER['PHP_SELF'],0,strrpos($_SERVER['PHP_SELF'],'/')).
                        '/';
                $pwassist_url=$protocol.$_SERVER['HTTP_HOST']
                .str_replace("ilias.php", "pwassist.php", $_SERVER['PHP_SELF'])
                ."?client_id=".$ilias->getClientId()
                ."&lang=".$lng->getLangKey()
                ."&key=".$pwassist_session["pwassist_id"];
                $contact_address=$ilias->getSetting("admin_email");
//echo "<br>-".htmlentities($pwassist_url)."-";
                $mm = new ilMimeMail();
                $mm->Subject($lng->txt("pwassist_mail_subject"));
                $mm->From($contact_address);
                $mm->To($userObj->getEmail());
                
                $mm->Body
                (
                        str_replace
                        (
                                array("\\n","\\t"),
                                array("\n","\t"),
                                sprintf
                                (
                                $lng->txt("pwassist_mail_body"),
                                $pwassist_url,
                                $server_url,
                                $_SERVER['REMOTE_ADDR'],
                                $userObj->getLogin(),
                                'mailto:'.$contact_address
                                )
                        )
                );
                
                $mm->Send();
        }
        
        
        function sendUsernameAssistanceMail($email, $logins)
        {
                global $lng, $ilias;
        
                include_once "classes/class.ilMailbox.php";
                include_once "classes/class.ilMimeMail.php";
                require_once "include/inc.pwassist_session_handler.php";
                $protocol = isset($_SERVER['HTTPS'])?"https://":"http://";

        
                // Compose the mail
                $server_url=$protocol.$_SERVER['HTTP_HOST'].
                        substr($_SERVER['PHP_SELF'],0,strrpos($_SERVER['PHP_SELF'],'/')).
                        '/';
                $login_url=$server_url."pwassist.php"
                                        ."?client_id=".$ilias->getClientId()
                                        ."&lang=".$lng->getLangKey();
//echo "-".htmlentities($login_url)."-";
                $contact_address=$ilias->getSetting("admin_email");
        
                $mm = new ilMimeMail();
                $mm->Subject($lng->txt("pwassist_mail_subject"));
                $mm->From($contact_address);
                $mm->To($email);
                
                $mm->Body
                (
                        str_replace
                        (
                                array("\\n","\\t"),
                                array("\n","\t"),
                                sprintf
                                (
                                                $lng->txt("pwassist_username_mail_body"),
                                                join ($logins,",\n"), 
                                                $server_url, 
                                                $_SERVER['REMOTE_ADDR'], 
                                                $email,
                                                'mailto:'.$contact_address,
                                                $login_url                                                              
                                )
                        )
                );
                
                $mm->Send();
        }
        
        /* Assign password form.
         * This form is used to assign a password to a username.
         *
         * To use this form, the following data must be provided as HTTP GET parameter,
         * or in argument pwassist_id:
         * key
         *
         * The key is used to retrieve the password assistance session.
         * If the key is missing, or if the password assistance session has expired, the
         * password assistance form will be shown instead of this form.
         *
         * @param message  A message to display on the form.
         * @param username The user name to be shown in the form.
         * @param password The password1 to be shown in the form.
         * @param password The password2 to be shown in the form.
         * @param pwassist_id The session key for the password assistance use case.
         *                  If this parameter is omitted, the key is retrieved from
         *                  the form data.
         */
        function showAssignPasswordForm($message="", $username="", $password1="", $password2="", $pwassist_id="")
        {
                global $tpl, $ilias, $lng, $rbacadmin, $rbacreview;
                
                require_once "include/inc.pwassist_session_handler.php";
                require_once "classes/class.ilLanguage.php";
                
                // Retrieve form data
                if ($pwassist_id == "") 
                {
                        $pwassist_id = $_GET["key"];
                }
        
                // Retrieve the session, and check if it is valid
                $pwassist_session = db_pwassist_session_read($pwassist_id);
                if (count($pwassist_session) == 0 || $pwassist_session["expires"] < time())
                {
                        $this->showAssistanceForm($lng->txt("pwassist_session_expired"));
                }
                else
                {
                        $tpl->addBlockFile("CONTENT", "content", "tpl.pwassist_assignpassword.html");
                        if ($message != "")
                        {
                                $tpl->setCurrentBlock("pw_message");
                                $tpl->setVariable("TXT_MESSAGE", str_replace("\\n","<br>",$message));
                                $tpl->parseCurrentBlock();
                        }

                        $tpl->setVariable("FORMACTION",
                                $this->ctrl->getFormAction($this));
                        $tpl->setVariable("TARGET","target=\"_parent\"");
                        $tpl->setVariable("IMG_AUTH",
                                ilUtil::getImagePath("icon_auth_b.gif"));
                        $tpl->setVariable("TXT_PAGEHEADLINE", $lng->txt("password_assistance"));
                        $tpl->setVariable("TXT_ENTER_USERNAME_AND_NEW_PASSWORD", $lng->txt("pwassist_enter_username_and_new_password"));
                        $tpl->setVariable("TXT_USERNAME", $lng->txt("username"));
                        $tpl->setVariable("TXT_PASSWORD1", $lng->txt("password"));
                        $tpl->setVariable("TXT_PASSWORD2", $lng->txt("retype_password"));
                        $tpl->setVariable("USERNAME", $username);
                        $tpl->setVariable("PASSWORD1", $password1);
                        $tpl->setVariable("PASSWORD2", $password2);
                        $tpl->setVariable("TXT_SUBMIT", $lng->txt("submit"));
                        $tpl->setVariable("KEY", $pwassist_id);
                        $tpl->setVariable("BACK", $lng->txt("back"));
                        $tpl->setVariable("CMD_BACK",
                                $this->ctrl->getLinkTargetByClass("ilstartupgui", "showLogin"));
                        $tpl->setVariable("LANG", $lng->getLangKey());
                
                        $tpl->show();
                }
        }
        
        function submitAssignPasswordForm() {
                global $tpl, $ilias, $lng, $rbacadmin, $rbacreview;
                
                require_once "include/inc.pwassist_session_handler.php";
                
                // Retrieve form data
                $pwassist_id = ilUtil::stripSlashes($_POST["key"]);
                $username = ilUtil::stripSlashes($_POST["username"]);
                $password1 = ilUtil::stripSlashes($_POST["password1"]);
                $password2 = ilUtil::stripSlashes($_POST["password2"]);
        
                // Retrieve the session
                $pwassist_session = db_pwassist_session_read($pwassist_id);
                
                if (count($pwassist_session) == 0 || $pwassist_session["expires"] < time())
                {
                        $this->showAssistanceForm($lng->txt("pwassist_session_expired"));
                }
                else
                {
                        $is_successful = true;
                        $message = "";
                        
                        $userObj = new ilObjUser($pwassist_session["user_id"]);
        
                        // Validate the entries of the user
                        // ----------------------------------
                        // check if the user still exists
                        if ($userObj == null)
                        {
                                $message = $lng->txt("user_does_not_exist");
                                $is_successful = false;
                        }
                        
                        // check if the username entered by the user matches the
                        // one of the user object.
                        if ($is_successful && strcasecmp($userObj->getLogin(), $username) != 0)
                        {
                                $message = $lng->txt("pwassist_login_not_match");
                                $is_successful = false;
                        }
                        
                        // check if the user entered the password correctly into the
                        // two entry fields.
                        if ($is_successful && $password1 != $password2)
                        {
                                $message = $lng->txt("passwd_not_match");
                                $is_successful = false;
                        }
        
                        // validate the password
                        if ($is_successful && !ilUtil::isPassword($password1))
                        {
                                $message = $lng->txt("passwd_invalid");
                                $is_successful = false;
                        }
                        
                        // End of validation
                        // If the validation was successful, we change the password of the
                        // user.
                        // ------------------
                        if ($is_successful)
                        {
                                $is_successful = $userObj->resetPassword($password1,$password2);
                                if (! $is_successful) 
                                {
                                        $message = $lng->txt("passwd_invalid");
                                }
                        }
        
                        // If we are successful so far, we update the user object.
                        // ------------------
                        if ($is_successful) 
                        {
                                $is_successfull = $userObj->update();
                                if (! $is_successful) 
                                {
                                        $message = $lng->txt("update_error");
                                }
                        }
                        
                        // If we are successful, we destroy the password assistance
                        // session and redirect to the login page.
                        // Else we display the form again along with an error message.
                        // ------------------
                        if ($is_successful)
                        {
                                db_pwassist_session_destroy($pwassist_id);
                                $this->showMessageForm
                                (
                                        null,
                                        sprintf
                                        (
                                                $lng->txt("pwassist_password_assigned"),
                                                $username
                                        )
                                );
                        }
                        else
                        {
                                $this->showAssignPasswordForm
                                (
                                        $message,
                                        $username,
                                        $password1,
                                        $password2,
                                        $pwassist_id
                                );
                        }       
                }
        }
        
        /* Message form.
         * This form is used to show a message to the user.
         */
        function showMessageForm($message="", $text="")
        {
                global $tpl, $ilias, $lng;
                
                if ($message != "")
                {
                        $tpl->setCurrentBlock("pw_message");
                        $tpl->setVariable("TXT_MESSAGE", str_replace("\\n","<br>",$message));
                        $tpl->parseCurrentBlock();
                }

                $tpl->addBlockFile("CONTENT", "content", "tpl.pwassist_message.html");
                $tpl->setVariable("TXT_PAGEHEADLINE", $lng->txt("password_assistance"));
                $tpl->setVariable("IMG_AUTH",
                        ilUtil::getImagePath("icon_auth_b.gif"));
                $tpl->setVariable("TXT_TEXT",str_replace("\\n","<br>",$text));
                $tpl->setVariable("BACK", $lng->txt("back"));
                $tpl->setVariable("LINK_BACK",
                        $this->ctrl->getLinkTargetByClass("ilstartupgui", "showLogin"));
                $tpl->setVariable("LANG", $lng->getLangKey());
        
                $tpl->show();
        }
}

?>