xref: /template/strap/action/registration.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php
/**
 * Action Component
 * Add a button in the edit toolbar
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Nicolas GERARD
 */

use ComboStrap\Bootstrap;
use ComboStrap\Identity;
use ComboStrap\IdentityFormsHelper;
use ComboStrap\LogUtility;
use ComboStrap\Snippet;
use dokuwiki\Form\Form;
use dokuwiki\Menu\Item\Register;

if (!defined('DOKU_INC')) die();
require_once(__DIR__ . '/../ComboStrap/PluginUtility.php');

/**
 *
 * Register forms depend on the following configuration
 * https://www.dokuwiki.org/config:autopasswd
 * If true, there is no password field
 */
class action_plugin_combo_registration extends DokuWiki_Action_Plugin
{

    const CANONICAL = Identity::CANONICAL;
    const TAG = "register";
    const FORM_REGISTER_CLASS = "form-" . self::TAG;
    const CONF_ENABLE_REGISTER_FORM = "enableRegistrationForm";




    function register(Doku_Event_Handler $controller)
    {
        /**
         * To modify the register form and add class
         *
         * Deprecated object passed by the event but still in use
         * https://www.dokuwiki.org/devel:event:html_registerform_output
         */
        $controller->register_hook('HTML_REGISTERFORM_OUTPUT', 'BEFORE', $this, 'handle_register_page', array());
        /**
         * New Event using the new object
         * https://www.dokuwiki.org/devel:event:form_register_output
         */
        $controller->register_hook('FORM_REGISTER_OUTPUT', 'BEFORE', $this, 'handle_register_page', array());


    }

    function handle_register_page(&$event, $param)
    {

        $form = &$event->data;
        $class = get_class($form);
        switch ($class) {
            case Doku_Form::class:
                /**
                 * Old one
                 * @var Doku_Form $form
                 */
                self::updateDokuFormRegistration($form);
                return;
            case dokuwiki\Form\Form::class;
                /**
                 * New One
                 * @var Form $form
                 */
                self::updateNewFormRegistration($form);
                return;
        }


    }

    /**
     * Return the register text and link paragraph
     * @return string
     */
    public static function getRegisterLinkAndParagraph(): string
    {


        $registerHtml = "";
        if (actionOK('register')) {

            /**
             * The register class does not allow
             * registration if your are logged in (What ?)
             * and send an exception
             */
            if (!Identity::isLoggedIn()) {
                $registerLink = (new Register())->asHtmlLink('', false);
                global $lang;
                $tag = self::TAG;
                $registerText = $lang['reghere'];
                $registerHtml = <<<EOF
<p class="$tag">$registerText : $registerLink</p>
EOF;
            }
        }
        return $registerHtml;
    }


    private static function updateNewFormRegistration(Form &$form)
    {
        /**
         * The Login page is an admin page created via buffer
         * We print before the forms
         * to avoid a FOUC
         */
        print IdentityFormsHelper::getHtmlStyleTag(self::TAG);


        $form->addClass(Identity::FORM_IDENTITY_CLASS . " " . self::FORM_REGISTER_CLASS);
        /**
         * Heading
         */
        $headerHTML = IdentityFormsHelper::getHeaderHTML($form, self::FORM_REGISTER_CLASS);
        if ($headerHTML != "") {
            $form->addHTML($headerHTML, 1);
        }

        IdentityFormsHelper::deleteFieldSetAndBrFromForm($form);
        IdentityFormsHelper::toBoostrapInputElements($form, self::FORM_REGISTER_CLASS);
        IdentityFormsHelper::toBootStrapSubmitButton($form);
    }

    private static function updateDokuFormRegistration(Doku_Form &$form)
    {
        /**
         * The register page is created via buffer
         * We print before the forms
         * to avoid a FOUC
         */
        print IdentityFormsHelper::getHtmlStyleTag(self::TAG);


        /**
         * @var Doku_Form $form
         */
        $class = &$form->params["class"];
        IdentityFormsHelper::addIdentityClass($class, self::FORM_REGISTER_CLASS);
        $newFormContent = [];

        /**
         * Header (Logo / Title)
         */
        $newFormContent[] = IdentityFormsHelper::getHeaderHTML($form, self::FORM_REGISTER_CLASS);


        /**
         * Form Attributes
         * https://getbootstrap.com/docs/5.0/forms/layout/#horizontal-form
         */
        $rowClass = "row";
        if (Bootstrap::getBootStrapMajorVersion() == Bootstrap::BootStrapFourMajorVersion) {
            $rowClass .= " form-group";
        }
        $firstColWeight = 5;
        $secondColWeight = 12 - $firstColWeight;


        /**
         * Replace the field
         *
         * The password text localized by lang is shared
         * between the password and the password check field
         */
        $passwordText = "Password";
        foreach ($form->_content as $pos => $field) {
            if (!is_array($field)) {
                continue;
            }
            $fieldName = $field["name"];
            if ($fieldName == null) {
                // this is not an input field
                if ($field["type"] == "submit") {
                    /**
                     * This is important to keep the submit element intact
                     * for forms integration such as captcha
                     * The search the submit button to insert before it
                     */
                    $classes = "btn btn-primary";
                    if (isset($field["class"])) {
                        $field["class"] = $field["class"] . " " . $classes;
                    } else {
                        $field["class"] = $classes;
                    }
                    $field["tabindex"] = "6";
                    $newFormContent[] = $field;
                }
                continue;
            }
            switch ($fieldName) {
                case "login":
                    $loginText = $field["_text"];
                    $loginValue = $field["value"];
                    $loginHTML = <<<EOF
<div class="$rowClass">
    <label for="inputUserName" class="col-sm-$firstColWeight col-form-label">$loginText</label>
    <div class="col-sm-$secondColWeight">
      <input type="text" class="form-control" id="inputUserName" placeholder="Username" tabindex="1" name="login" value="$loginValue" required="required">
    </div>
</div>
EOF;
                    $newFormContent[] = $loginHTML;
                    break;
                case "pass":
                    $passwordText = $field["_text"];
                    $passwordHtml = <<<EOF
<div class="$rowClass">
    <label for="inputPassword" class="col-sm-$firstColWeight col-form-label">$passwordText</label>
    <div class="col-sm-$secondColWeight">
      <input type="password" class="form-control" id="inputPassword" placeholder="$passwordText" tabindex="2" name="pass" required="required">
    </div>
</div>
EOF;
                    $newFormContent[] = $passwordHtml;
                    break;
                case "passchk":
                    $passwordCheckText = $field["_text"];
                    $passwordCheckHtml = <<<EOF
<div class="$rowClass">
    <label for="inputPasswordCheck" class="col-sm-$firstColWeight col-form-label">$passwordCheckText</label>
    <div class="col-sm-$secondColWeight">
      <input type="password" class="form-control" id="inputPasswordCheck" placeholder="$passwordText" tabindex="3" name="passchk" required="required">
    </div>
</div>
EOF;
                    $newFormContent[] = $passwordCheckHtml;
                    break;
                case "fullname":
                    $fullNameText = $field["_text"];
                    $fullNameValue = $field["value"];
                    $fullNameHtml = <<<EOF
<div class="$rowClass">
    <label for="inputRealName" class="col-sm-$firstColWeight col-form-label">$fullNameText</label>
    <div class="col-sm-$secondColWeight">
      <input type="text" class="form-control" id="inputRealName" placeholder="$fullNameText" tabindex="4" name="fullname" value="$fullNameValue" required="required">
    </div>
</div>
EOF;
                    $newFormContent[] = $fullNameHtml;
                    break;
                case "email":
                    $emailText = $field["_text"];
                    $emailValue = $field["value"];
                    $emailHTML = <<<EOF
<div class="$rowClass">
    <label for="inputEmail" class="col-sm-$firstColWeight col-form-label">$emailText</label>
    <div class="col-sm-$secondColWeight">
      <input type="email" class="form-control" id="inputEmail" placeholder="name@example.com" tabindex="5" name="email" value="$emailValue" required="required">
    </div>
</div>
EOF;
                    $newFormContent[] = $emailHTML;
                    break;
                default:
                    $tag = self::TAG;
                    LogUtility::msg("The $tag field name ($fieldName) is unknown", LogUtility::LVL_MSG_ERROR, self::CANONICAL);

            }
        }


        /**
         * Link in the form footer to login and resend
         */
        $loginLinkToHtmlForm = action_plugin_combo_login::getLoginParagraphWithLinkToFormPage();
        if (!empty($loginHTML)) {
            $newFormContent[] = $loginLinkToHtmlForm;
        }
        $resendHtml = action_plugin_combo_resend::getResendPasswordParagraphWithLinkToFormPage();
        if (!empty($resendHtml)) {
            $newFormContent[] = $resendHtml;
        }

        /**
         * Update
         */
        $form->_content = $newFormContent;

    }


}