App/Forms/LdapConfigForm.php - master - mikopbx/ModuleLdapSync

App/Forms/LdapConfigForm.php
188 строк7 KB
Nikolai Beketov
feat: LDAPS/StartTLS, custom CA, test-bind button, PHP 8.4, sync fixes
23 апр 2026, 08:23
23 апр 2026, 08:23e025d61
<?php

/*
 * MikoPBX - free phone system for small business
 * Copyright © 2017-2023 Alexey Portnov and Nikolay Beketov
 *
 * 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 3 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, see <https://www.gnu.org/licenses/>.
 */

namespace Modules\ModuleLdapSync\App\Forms;

use MikoPBX\AdminCabinet\Forms\BaseForm;
use Modules\ModuleLdapSync\Lib\Constants;
use Phalcon\Forms\Element\Check;
use Phalcon\Forms\Element\Hidden;
use Phalcon\Forms\Element\Password;
use Phalcon\Forms\Element\Select;
use Phalcon\Forms\Element\Text;
use Phalcon\Forms\Element\TextArea;

class LdapConfigForm extends BaseForm
{
    public function initialize($entity = null, $options = null): void
    {
        // ID
        $this->add(new Hidden('id'));

        // Autosync checkbox
        $this->addCheckBox('autosync', intval($entity->disabled) === 0);

        // ServerHost
        $this->add(new Text('serverName', [
            'placeholder' => 'dc1.domain.com'
        ]));

        // ServerPort
        $this->add(new Text('serverPort', [
            'placeholder' => '389',
            'value' => $entity->serverPort ?? '389'
        ]));

        // TLS transport mode: 'none' | 'starttls' | 'ldaps'.
        // Rendered as a Fomantic dropdown label attached to the server name field.
        $tlsModeElement = new Hidden('tlsMode');
        $tlsModeElement->setDefault($entity->tlsMode ?? 'none');
        $this->add($tlsModeElement);

        // Certificate validation toggle.
        $this->addCheckBox('verifyCert', ($entity->verifyCert ?? '0') === '1');

        // Custom CA bundle (PEM) — optional; only used when verifyCert is enabled.
        $caCertificate = new TextArea('caCertificate', [
            'placeholder' => "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
            'value'       => $entity->caCertificate ?? '',
            'rows'        => 18,
            'spellcheck'  => 'false',
            'autocomplete' => 'off',
        ]);
        $this->add($caCertificate);

        // AdministrativeLogin
        $this->add(new Text('administrativeLogin', ['placeholder' => 'cn=admin, dc=example, dc=com']));

        // AdministrativePassword
        $this->add(new Password('administrativePasswordHidden', [
            'autocomplete' => 'off',
            'placeholder' => 'Domain admin password',
            'value' => Constants::HIDDEN_PASSWORD
        ]));

        // BaseDN
        $this->add(new Text('baseDN', [
            'placeholder' => 'dc=domain, dc=com',
            'value' => $entity->baseDN ?? 'dc=domain, dc=com'
        ]));

        // UserFilter
        $this->addTextArea('userFilter', $entity->userFilter ?? '(&(objectClass=user)(objectCategory=PERSON))', 90, [
            'placeholder' => '(&(objectClass=user)(objectCategory=PERSON))',
            'skipEscaping' => true,
        ]);

        // Select server type
        $types = [
            'ActiveDirectory' => 'ActiveDirectory',
            'OpenLDAP' => 'OpenLDAP',
//            'DirectoryServer' => 'DirectoryServer',
//            'FreeIPA' => 'FreeIPA',
        ];
        $ldapType = new Select(
            'ldapType',
            $types,
            [
                'using' => [
                    'id',
                    'name',
                ],
                'emptyValue' => 'ActiveDirectory',
                'useEmpty' => false,
                'class' => "ui selection dropdown select-ldap-field",
            ]
        );
        $this->add($ldapType);


        $attributes = json_decode($entity->attributes ?? '', true);


        // UserNameAttribute
        $this->add(new Text(Constants::USER_NAME_ATTR, [
            'placeholder' => 'cn or displayName',
            'value' => $attributes[Constants::USER_NAME_ATTR] ?? 'displayName'
        ]));

        // UserExtensionAttribute
        $this->add(new Text(Constants::USER_EXTENSION_ATTR, [
            'placeholder' => 'telephoneNumber',
            'value' => $attributes[Constants::USER_EXTENSION_ATTR] ?? 'telephoneNumber'
        ]));

        // UserMobileAttribute
        $this->add(new Text(Constants::USER_MOBILE_ATTR, [
            'placeholder' => 'mobile',
            'value' => $attributes[Constants::USER_MOBILE_ATTR] ?? 'mobile'
        ]));

        // UserEmailAttribute
        $this->add(new Text(Constants::USER_EMAIL_ATTR, [
            'placeholder' => 'mail',
            'value' => $attributes[Constants::USER_EMAIL_ATTR] ?? 'mail'
        ]));

        // UserAvatarAttribute
        $this->add(new Text(Constants::USER_AVATAR_ATTR, [
            'placeholder' => 'jpegPhoto',
            'value' => $attributes[Constants::USER_AVATAR_ATTR] ?? 'jpegPhoto'
        ]));

        // UserAccountControlAttribute
        $this->add(new Text(Constants::USER_ACCOUNT_CONTROL_ATTR, [
            'placeholder' => 'userAccountControl',
            'value' => $attributes[Constants::USER_ACCOUNT_CONTROL_ATTR] ?? 'userAccountControl'
        ]));

        //  UserPasswordAttribute
        $this->add(new Text(Constants::USER_PASSWORD_ATTR, [
            'placeholder' => 'sipPassword',
            'value' => $attributes[Constants::USER_PASSWORD_ATTR]
        ]));

        // OrganizationUnit
        $this->add(new Text('organizationalUnit', [
            'placeholder' => 'ou=users, dc=domain, dc=com'
        ]));

        // UpdateAttributes checkbox
        $this->addCheckBox('updateAttributes', intval($entity->updateAttributes) === 1);
    }

    /**
     * Adds a checkbox to the form field with the given name.
     * Can be deleted if the module depends on MikoPBX later than 2024.3.0
     *
     * @param string $fieldName The name of the form field.
     * @param bool $checked Indicates whether the checkbox is checked by default.
     * @param string $checkedValue The value assigned to the checkbox when it is checked.
     * @return void
     */
    public function addCheckBox(string $fieldName, bool $checked, string $checkedValue = 'on'): void
    {
        $checkAr = ['value' => null];
        if ($checked) {
            $checkAr = ['checked' => $checkedValue,'value' => $checkedValue];
        }
        $this->add(new Check($fieldName, $checkAr));
    }
}