silverstripe / silverstripe-ldap

src/Control/LDAPDebugController.php

<?php

namespace SilverStripe\LDAP\Control;

use SilverStripe\CMS\Controllers\ContentController;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Config\Config;
use SilverStripe\LDAP\Model\LDAPGateway;
use SilverStripe\LDAP\Model\LDAPGroupMapping;
use SilverStripe\LDAP\Services\LDAPService;
use SilverStripe\ORM\ArrayList;
use SilverStripe\Security\Group;
use SilverStripe\Security\Permission;
use SilverStripe\Security\Security;
use SilverStripe\View\ArrayData;

/**
 * Class LDAPDebugController
 *
 * This controller is used to debug the LDAP connection.
 */
class LDAPDebugController extends ContentController
{
    /**
     * @var array
     */
    private static $allowed_actions = [

The private property $allowed_actions is not used, and could be removed.

        'index',
    ];

    /**
     * @var array
     */
    private static $dependencies = [

The private property $dependencies is not used, and could be removed.

        'ldapService' => '%$' . LDAPService::class
    ];

    /**
     * @var LDAPService
     */
    public $ldapService;

    protected function init()
    {
        parent::init();
        ini_set('memory_limit', '-1'); // Increase memory limit to max possible

        if (!Permission::check('ADMIN')) {
            Security::permissionFailure();
        }
    }

    /**
     * @param HTTPRequest $request
     *
     * @return string
     */
    public function index(HTTPRequest $request)

The parameter $request is not used and could be removed.

    {
        return $this->renderWith([self::class]);
    }

    public function Options()
    {
        $list = new ArrayList();
        foreach (Config::inst()->get(LDAPGateway::class, 'options') as $field => $value) {
            if ($field === 'password') {
                $value = '***';
            }

            $list->push(new ArrayData([
                'Name' => $field,
                'Value' => $value
            ]));
        }
        return $list;
    }

    public function UsersSearchLocations()
    {
        $locations = Config::inst()->get(LDAPService::class, 'users_search_locations');
        $list = new ArrayList();
        if ($locations) {
            foreach ($locations as $location) {
                $list->push(new ArrayData([
                    'Value' => $location
                ]));
            }
        } else {
            $list->push($this->Options()->find('Name', 'baseDn'));
        }

        return $list;
    }

    public function GroupsSearchLocations()
    {
        $locations = Config::inst()->get(LDAPService::class, 'groups_search_locations');
        $list = new ArrayList();
        if ($locations) {
            foreach ($locations as $location) {
                $list->push(new ArrayData([
                    'Value' => $location
                ]));
            }
        } else {
            $list->push($this->Options()->find('Name', 'baseDn'));
        }

        return $list;
    }

    public function DefaultGroup()
    {
        $code = Config::inst()->get(LDAPService::class, 'default_group');
        if ($code) {
            $group = Group::get()->filter('Code', $code)->limit(1)->first();
            if (!($group && $group->exists())) {
                return sprintf(
                    'WARNING: LDAPService.default_group configured with \'%s\''
                        . 'but there is no Group with that Code in the database!',
                    $code
                );
            } else {
                return sprintf('%s (Code: %s)', $group->Title, $group->Code);
            }
        }

        return null;
    }

    public function MappedGroups()
    {
        return LDAPGroupMapping::get();
    }

    public function Nodes()
    {
        $groups = $this->ldapService->getNodes(false);
        $list = new ArrayList();
        foreach ($groups as $record) {
            $list->push(new ArrayData([
                'DN' => $record['dn']
            ]));
        }
        return $list;
    }

    public function Groups()
    {
        $groups = $this->ldapService->getGroups(false);
        $list = new ArrayList();
        foreach ($groups as $record) {
            $list->push(new ArrayData([
                'DN' => $record['dn']
            ]));
        }
        return $list;
    }

    public function Users()
    {
        return count($this->ldapService->getUsers(['objectguid', 'dn'])); // Only get two attrs to prevent memory errors
    }
}