mirror of
https://github.com/LDAPAccountManager/lam.git
synced 2025-10-03 01:39:33 +02:00
516 lines
12 KiB
PHP
516 lines
12 KiB
PHP
<?php
|
|
|
|
namespace LAM\TYPES;
|
|
/*
|
|
|
|
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
|
Copyright (C) 2005 - 2025 Roland Gruber
|
|
|
|
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
|
|
|
|
*/
|
|
|
|
use baseModule;
|
|
use baseType;
|
|
use LAMConfig;
|
|
|
|
/**
|
|
* This file is the interface to the different account types.
|
|
*
|
|
* @package types
|
|
* @author Roland Gruber
|
|
*/
|
|
|
|
/** parent class of account types */
|
|
include_once(__DIR__ . "/baseType.inc");
|
|
/** parent class of list views */
|
|
include_once(__DIR__ . "/lists.inc");
|
|
/** Used to check if this is a LAM Pro release. */
|
|
include_once(__DIR__ . "/selfService.inc");
|
|
|
|
|
|
/**
|
|
* This includes all type definitions.
|
|
*/
|
|
$typesINC_dirname = substr(__FILE__, 0, strlen(__FILE__) - 10) . "/types";
|
|
$typesINC_dir = dir($typesINC_dirname);
|
|
// get module names.
|
|
while ($entry = $typesINC_dir->read()) {
|
|
if ((str_ends_with($entry, '.inc')) && is_file($typesINC_dirname . '/' . $entry)) {
|
|
include_once($typesINC_dirname . '/' . $entry);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns a list of available account types.
|
|
*
|
|
* @return string[] list of types
|
|
*/
|
|
function getTypes(): array {
|
|
$dirname = substr(__FILE__, 0, strlen(__FILE__) - 10) . "/types";
|
|
$dir = dir($dirname);
|
|
$return = [];
|
|
// get type names.
|
|
while ($entry = $dir->read()) {
|
|
if ((str_ends_with($entry, '.inc')) && is_file($dirname . '/' . $entry)) {
|
|
$entry = substr($entry, 0, strpos($entry, '.'));
|
|
$return[] = $entry;
|
|
}
|
|
}
|
|
$dir->close();
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Returns the account type for a given type id.
|
|
*
|
|
* @param string $typeId type id (e.g. user_1)
|
|
* @return string scope (e.g. user)
|
|
*/
|
|
function getScopeFromTypeId(string $typeId): string {
|
|
$parts = explode('_', $typeId);
|
|
return $parts[0];
|
|
}
|
|
|
|
/**
|
|
* Represents a configured account type variant.
|
|
*
|
|
* @package types
|
|
* @author Roland Gruber
|
|
*/
|
|
class ConfiguredType {
|
|
|
|
private string $scope;
|
|
|
|
private string $id;
|
|
|
|
private $suffix;
|
|
|
|
private $attributes;
|
|
|
|
private $alias;
|
|
|
|
private $additionalLdapFilter;
|
|
|
|
private $hidden;
|
|
|
|
private $baseType;
|
|
|
|
private ?TypeManager $typeManager;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param TypeManager|null $typeManager type manager
|
|
* @param string $scope account type
|
|
* @param string $id unique ID for this configuration
|
|
*/
|
|
public function __construct(?TypeManager $typeManager, string $scope, string $id) {
|
|
$this->typeManager = &$typeManager;
|
|
$this->scope = $scope;
|
|
$this->id = $id;
|
|
}
|
|
|
|
/**
|
|
* Returns the owning type manager.
|
|
*
|
|
* @return TypeManager type manager
|
|
*/
|
|
public function getTypeManager(): TypeManager {
|
|
return $this->typeManager;
|
|
}
|
|
|
|
/**
|
|
* Returns the account type (e.g. 'user').
|
|
*
|
|
* @return string account type
|
|
*/
|
|
public function getScope(): string {
|
|
return $this->scope;
|
|
}
|
|
|
|
/**
|
|
* Returns a unique id for this configuration.
|
|
*
|
|
* @return string unique id
|
|
*/
|
|
public function getId(): string {
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Returns the LDAP suffix.
|
|
*
|
|
* @return string LDAP suffix
|
|
*/
|
|
public function getSuffix(): string {
|
|
if ($this->suffix !== null) {
|
|
return $this->suffix;
|
|
}
|
|
$this->suffix = $this->typeManager->getConfig()->get_Suffix($this->id);
|
|
return $this->suffix;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of configured attributes.
|
|
*
|
|
* @return ListAttribute[] list of ListAttribute
|
|
*/
|
|
public function getAttributes(): array {
|
|
if ($this->attributes !== null) {
|
|
return $this->attributes;
|
|
}
|
|
$attributeString = $this->typeManager->getConfig()->get_listAttributes($this->id);
|
|
$attributeSpecs = explode(';', $attributeString);
|
|
$attributes = [];
|
|
foreach ($attributeSpecs as $attributeSpec) {
|
|
$attributes[] = new ListAttribute($attributeSpec);
|
|
}
|
|
$this->attributes = $attributes;
|
|
return $this->attributes;
|
|
}
|
|
|
|
/**
|
|
* Returns the alias name.
|
|
*
|
|
* @return string alias name
|
|
*/
|
|
public function getAlias(): string {
|
|
if ($this->alias !== null) {
|
|
return $this->alias;
|
|
}
|
|
$typeSettings = $this->typeManager->getConfig()->get_typeSettings();
|
|
if (!empty($typeSettings['customLabel_' . $this->id])) {
|
|
$this->alias = $typeSettings['customLabel_' . $this->id];
|
|
}
|
|
else {
|
|
$this->alias = $this->getBaseType()->getAlias();
|
|
}
|
|
return $this->alias;
|
|
}
|
|
|
|
/**
|
|
* Returns the additional LDAP filter.
|
|
*
|
|
* @return string LDAP filter
|
|
*/
|
|
public function getAdditionalLdapFilter(): string {
|
|
if ($this->additionalLdapFilter !== null) {
|
|
return $this->additionalLdapFilter;
|
|
}
|
|
$typeSettings = $this->typeManager->getConfig()->get_typeSettings();
|
|
$this->additionalLdapFilter = $typeSettings['filter_' . $this->id] ?? '';
|
|
return $this->additionalLdapFilter;
|
|
}
|
|
|
|
/**
|
|
* Returns if this configuration is hidden.
|
|
*
|
|
* @return bool hidden
|
|
*/
|
|
public function isHidden(): bool {
|
|
if ($this->hidden !== null) {
|
|
return $this->hidden;
|
|
}
|
|
$this->hidden = isAccountTypeHidden($this->id);
|
|
return $this->hidden;
|
|
}
|
|
|
|
/**
|
|
* Returns the base type of this configured type.
|
|
*
|
|
* @return baseType base type
|
|
*/
|
|
public function getBaseType(): baseType {
|
|
if ($this->baseType != null) {
|
|
return $this->baseType;
|
|
}
|
|
$scope = $this->scope;
|
|
$this->baseType = new $scope($this);
|
|
return $this->baseType;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of LDAP suffixes for this type.
|
|
*
|
|
* @return array sorted list of possible suffixes for this type.
|
|
*/
|
|
public function getSuffixList(): array {
|
|
$ret = [];
|
|
$filter = $this->getBaseType()->getSuffixFilter();
|
|
$attrs = ['dn', 'objectClass'];
|
|
$units = searchLDAP($this->getSuffix(), $filter, $attrs);
|
|
foreach ($units as $unit) {
|
|
// Active Directory fix, hide system containers
|
|
$isSystemContainer = in_array('container', $unit['objectclass'])
|
|
&& (preg_match('/.*cn=system,dc=.+/i', $unit['dn']) || preg_match('/.*CN=program data,dc=.+/i', $unit['dn']));
|
|
$isDnsContainer = preg_match('/.*CN=MicrosoftDNS,CN=System,dc=.+/i', $unit['dn']);
|
|
if ($isSystemContainer || $isDnsContainer) {
|
|
continue;
|
|
}
|
|
$ret[] = $unit['dn'];
|
|
}
|
|
// add root suffix if needed
|
|
$found = false;
|
|
for ($i = 0; $i < count($ret); $i++) { // search suffix case-insensitive
|
|
if (strtolower($this->getSuffix()) === strtolower($ret[$i])) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!$found) {
|
|
$ret[] = $this->getSuffix();
|
|
}
|
|
usort($ret, 'compareDN');
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Returns the names of the active modules for this type.
|
|
*
|
|
* @return class-string<baseModule>[] module names
|
|
*/
|
|
public function getModules(): array {
|
|
$typeSettings = $this->typeManager->getConfig()->get_typeSettings();
|
|
if (empty($typeSettings['modules_' . $this->getId()])) {
|
|
return [];
|
|
}
|
|
$modules = $typeSettings['modules_' . $this->getId()];
|
|
return explode(',', $modules);
|
|
}
|
|
|
|
/**
|
|
* Returns the file name of the type icon.
|
|
* It is 16x16px and located in graphics folder.
|
|
*
|
|
* @return string file name
|
|
*/
|
|
public function getIcon(): string {
|
|
$baseType = $this->getBaseType();
|
|
return $baseType->getIcon();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* An attribute definition for the account list.
|
|
*
|
|
* @package types
|
|
* @author Roland Gruber
|
|
*/
|
|
class ListAttribute {
|
|
|
|
private $attributeSpec;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param string $attributeSpec spec of attribute (e.g. '#uid' or 'uid:User')
|
|
*/
|
|
public function __construct(string $attributeSpec) {
|
|
$this->attributeSpec = $attributeSpec;
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the LDAP attribute.
|
|
*
|
|
* @return string $attributeName name
|
|
*/
|
|
public function getAttributeName(): string {
|
|
if ($this->isPredefined()) {
|
|
return substr($this->attributeSpec, 1);
|
|
}
|
|
$parts = explode(':', $this->attributeSpec);
|
|
return $parts[0];
|
|
}
|
|
|
|
/**
|
|
* Returns the display value.
|
|
*
|
|
* @param array $predefinedDescriptions predefined descriptions (lower attribute name => label)
|
|
* @return string display value
|
|
*/
|
|
public function getAlias(array $predefinedDescriptions): string {
|
|
if ($this->isPredefined()) {
|
|
$name = strtolower(substr($this->attributeSpec, 1));
|
|
return $predefinedDescriptions[$name] ?? $name;
|
|
}
|
|
$parts = explode(':', $this->attributeSpec);
|
|
return $parts[1];
|
|
}
|
|
|
|
/**
|
|
* Returns if this is a predefined attribute name.
|
|
*
|
|
* @return bool is predefined
|
|
*/
|
|
private function isPredefined(): bool {
|
|
return str_starts_with($this->attributeSpec, '#');
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Provides utility functions to get e.g. configured types.
|
|
*
|
|
* @package types
|
|
* @author Roland Gruber
|
|
*/
|
|
class TypeManager {
|
|
|
|
private $config;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param LAMConfig|null $config configuration (uses $_SESSION['config'] by default)
|
|
*/
|
|
public function __construct(?LAMConfig $config = null) {
|
|
if ($config === null) {
|
|
$config = &$_SESSION['config'];
|
|
}
|
|
$this->config = &$config;
|
|
}
|
|
|
|
/**
|
|
* Checks if the given type id is valid.
|
|
*
|
|
* @param string $typeId type id
|
|
* @return bool is valid
|
|
*/
|
|
public static function isValidTypeId(string $typeId): bool {
|
|
return preg_match("/^[a-z0-9_-]+$/i", $typeId);
|
|
}
|
|
|
|
/**
|
|
* Returns the configured type with the given id or null.
|
|
*
|
|
* @param string $typeId type id
|
|
* @return ConfiguredType|null type
|
|
*/
|
|
public function getConfiguredType(string $typeId): ?ConfiguredType {
|
|
if ($this->config == null) {
|
|
return null;
|
|
}
|
|
$activeTypes = $this->config->get_ActiveTypes();
|
|
if (in_array($typeId, $activeTypes)) {
|
|
return $this->buildConfiguredType($typeId);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of configured account types.
|
|
*
|
|
* @return ConfiguredType[] list of ConfiguredType
|
|
*/
|
|
public function getConfiguredTypes(): array {
|
|
$configuredTypes = [];
|
|
$activeTypes = $this->config->get_ActiveTypes();
|
|
foreach ($activeTypes as $typeId) {
|
|
$type = $this->buildConfiguredType($typeId);
|
|
if ($type === null) {
|
|
continue;
|
|
}
|
|
$configuredTypes[] = $type;
|
|
}
|
|
return $configuredTypes;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of configured types for this scope.
|
|
*
|
|
* @param string $scope scope (e.g. user)
|
|
* @return ConfiguredType[] list of ConfiguredType
|
|
*/
|
|
public function getConfiguredTypesForScope(string $scope): array {
|
|
$allTypes = $this->getConfiguredTypes();
|
|
$scopedTypes = [];
|
|
foreach ($allTypes as $type) {
|
|
if ($type->getScope() == $scope) {
|
|
$scopedTypes[] = $type;
|
|
}
|
|
}
|
|
return $scopedTypes;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of configured types for these scopes.
|
|
*
|
|
* @param array $scopes scopes (e.g. user)
|
|
* @return ConfiguredType[] list of ConfiguredType
|
|
*/
|
|
public function getConfiguredTypesForScopes(array $scopes): array {
|
|
$allTypes = $this->getConfiguredTypes();
|
|
$scopedTypes = [];
|
|
foreach ($allTypes as $type) {
|
|
if (in_array($type->getScope(), $scopes)) {
|
|
$scopedTypes[] = $type;
|
|
}
|
|
}
|
|
return $scopedTypes;
|
|
}
|
|
|
|
/**
|
|
* Builds a configured account type.
|
|
*
|
|
* @param string $typeId type id
|
|
* @return ConfiguredType|null type
|
|
*/
|
|
private function buildConfiguredType(string $typeId): ?ConfiguredType {
|
|
$scope = getScopeFromTypeId($typeId);
|
|
if (!class_exists($scope)) {
|
|
return null;
|
|
}
|
|
return new ConfiguredType($this, $scope, $typeId);
|
|
}
|
|
|
|
/**
|
|
* Generates a new unique type id for the given scope.
|
|
*
|
|
* @param string $scope account type (e.g. user)
|
|
*/
|
|
public function generateNewTypeId(string $scope): string {
|
|
$activeTypes = $this->config->get_ActiveTypes();
|
|
if (!in_array($scope, $activeTypes)) {
|
|
return $scope;
|
|
}
|
|
$counter = 1;
|
|
while (in_array($scope . '_' . $counter, $activeTypes)) {
|
|
$counter++;
|
|
}
|
|
return $scope . '_' . $counter;
|
|
}
|
|
|
|
/**
|
|
* Returns the associated config object.
|
|
*
|
|
* @return LAMConfig|null config
|
|
*/
|
|
public function getConfig(): ?LAMConfig {
|
|
return $this->config;
|
|
}
|
|
|
|
/**
|
|
* Returns if configuration is loaded.
|
|
*
|
|
* @return boolean configured
|
|
*/
|
|
public function hasConfig(): bool {
|
|
return !empty($this->config);
|
|
}
|
|
|
|
}
|