yetangitu/lam
1
0
Fork 0
mirror of https://github.com/LDAPAccountManager/lam.git synced 2025-10-03 17:59:21 +02:00
Code Issues Releases Wiki Activity

refactoring

Browse source
This commit is contained in:
Roland Gruber 2025-07-21 21:17:50 +02:00
parent b430377214
commit 2eab6b3b1c
4 changed files with 31 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lam/lib/baseModule.inc
View file

@ -554,10 +554,10 @@ abstract class baseModule {
* (e.g. posixAccount_homeDirectory) to avoid naming conflicts. * (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
* *
* @param string $typeId type id (user, group, host, ...) * @param string $typeId type id (user, group, host, ...)
* @return htmlElement meta HTML object * @return htmlResponsiveRow|null meta HTML object
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
* @see htmlElement * @see htmlResponsiveRow
*/ */
public function get_profileOptions($typeId) { public function get_profileOptions($typeId) {
return $this->meta['profile_options'] ?? null; return $this->meta['profile_options'] ?? null;

14
lam/lib/modules.inc
View file

@ -853,16 +853,12 @@ class accountContainer {
/** /**
* Returns the account module with the given class name * Returns the account module with the given class name
* *
* @param string $name class name (e.g. posixAccount) * @template T of baseModule
* @return baseModule account module * @param class-string<T> $name class name (e.g. posixAccount)
* @return T|null account module
*/ */
public function getAccountModule($name) { public function getAccountModule(string $name): ?baseModule {
if (isset($this->module[$name])) { return $this->module[$name] ?? null;
return $this->module[$name];
}
else {
return null;
}
} }
/** /**

50
lam/lib/modules/windowsUser.inc
View file

@ -3751,21 +3751,7 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
} }
/** /**
* Checks if all input values are correct and returns the LDAP attributes which should be changed. * {@inheritDoc}
* <br>Return values:
* <br>messages: array of parameters to create status messages
* <br>add: array of attributes to add
* <br>del: array of attributes to remove
* <br>mod: array of attributes to modify
* <br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)
*
* Calling this method does not require the existence of an enclosing {@link accountContainer}.
*
* @param string $fields input fields
* @param array $attributes LDAP attributes
* @param boolean $passwordChangeOnly indicates that the user is only allowed to change his password and no LDAP content is readable
* @param array $readOnlyFields list of read-only fields
* @return array messages and attributes (array('messages' => [], 'add' => array('mail' => array('test@test.com')), 'del' => [], 'mod' => [], 'info' => []))
*/ */
function checkSelfServiceOptions($fields, $attributes, $passwordChangeOnly, $readOnlyFields) { function checkSelfServiceOptions($fields, $attributes, $passwordChangeOnly, $readOnlyFields) {
$return = ['messages' => [], 'add' => [], 'del' => [], 'mod' => [], 'info' => []]; $return = ['messages' => [], 'add' => [], 'del' => [], 'mod' => [], 'info' => []];
@ -3936,14 +3922,14 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
* Returns if the account is currently deactivated. * Returns if the account is currently deactivated.
* *
* @param array $attrs LDAP attributes * @param array $attrs LDAP attributes
* @return boolean is deactivated * @return bool is deactivated
*/ */
public static function isDeactivated($attrs) { public static function isDeactivated($attrs): bool {
$myAttrs = array_change_key_case($attrs); $myAttrs = array_change_key_case($attrs);
if (!isset($myAttrs['useraccountcontrol'][0])) { if (!isset($myAttrs['useraccountcontrol'][0])) {
return false; return false;
} }
return intval($myAttrs['useraccountcontrol'][0]) & self::AC_ACCOUNT_DISABLED; return (intval($myAttrs['useraccountcontrol'][0]) & self::AC_ACCOUNT_DISABLED) === self::AC_ACCOUNT_DISABLED;
} }
/** /**
@ -4007,9 +3993,9 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
/** /**
* Unlocks the user password. This resets 'lockoutTime' to 0. * Unlocks the user password. This resets 'lockoutTime' to 0.
* *
* @param array|null $attributes LDAP attributes * @param array<string, array<string>|string>|null $attributes LDAP attributes
*/ */
public function unlockPassword(?array &$attributes = null) { public function unlockPassword(?array &$attributes = null): void {
if ($attributes === null) { if ($attributes === null) {
$attributes = &$this->attributes; $attributes = &$this->attributes;
} }
@ -4022,7 +4008,7 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
* Sets if the account is currently deactivated. * Sets if the account is currently deactivated.
* *
* @param boolean $deactivated is deactivated * @param boolean $deactivated is deactivated
* @param array $attrs LDAP attributes to modify (default $this->attributes) * @param array<string, array<string>|string>|null $attrs LDAP attributes to modify (default $this->attributes)
*/ */
public function setIsDeactivated($deactivated, &$attrs = null) { public function setIsDeactivated($deactivated, &$attrs = null) {
if ($attrs == null) { if ($attrs == null) {
@ -4044,13 +4030,13 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
* Returns if the account requires a smartcard to login. * Returns if the account requires a smartcard to login.
* *
* @param array $attrs LDAP attributes * @param array $attrs LDAP attributes
* @return boolean requires a smartcard * @return bool requires a smartcard
*/ */
public static function isSmartCardRequired($attrs) { public static function isSmartCardRequired($attrs): bool {
if (!isset($attrs['useraccountcontrol'][0])) { if (!isset($attrs['useraccountcontrol'][0])) {
return false; return false;
} }
return intval($attrs['useraccountcontrol'][0]) & self::AC_SMARTCARD_REQUIRED; return (intval($attrs['useraccountcontrol'][0]) & self::AC_SMARTCARD_REQUIRED) === self::AC_SMARTCARD_REQUIRED;
} }
/** /**
@ -4076,13 +4062,13 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
* Returns if the account never expires. * Returns if the account never expires.
* *
* @param array $attrs LDAP attributes * @param array $attrs LDAP attributes
* @return boolean never expires * @return bool never expires
*/ */
public static function isNeverExpiring($attrs) { public static function isNeverExpiring($attrs): bool {
if (!isset($attrs['useraccountcontrol'][0])) { if (!isset($attrs['useraccountcontrol'][0])) {
return false; return false;
} }
return intval($attrs['useraccountcontrol'][0]) & self::AC_PWD_NEVER_EXPIRES; return (intval($attrs['useraccountcontrol'][0]) & self::AC_PWD_NEVER_EXPIRES) === self::AC_PWD_NEVER_EXPIRES;
} }
/** /**
@ -4286,9 +4272,9 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
* Returns a value in file time (100 ns since 1601-01-01). * Returns a value in file time (100 ns since 1601-01-01).
* *
* @param integer $value time value as int * @param integer $value time value as int
* @return DateTime time value * @return DateTime|null time value
*/ */
public static function getFileTime($value) { public static function getFileTime($value): ?DateTime {
if (empty($value) || !get_preg($value, 'digit')) { if (empty($value) || !get_preg($value, 'digit')) {
return null; return null;
} }
@ -4806,7 +4792,7 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
*/ */
public function getListRenderFunction(string $attributeName): ?callable { public function getListRenderFunction(string $attributeName): ?callable {
if ($attributeName === 'mail') { if ($attributeName === 'mail') {
return function(array $entry, string $attribute): ?htmlElement { return function(array $entry, string $attribute): htmlElement {
$group = new htmlGroup(); $group = new htmlGroup();
if (isset($entry[$attribute][0]) && ($entry[$attribute][0] != '')) { if (isset($entry[$attribute][0]) && ($entry[$attribute][0] != '')) {
for ($i = 0; $i < count($entry[$attribute]); $i++) { for ($i = 0; $i < count($entry[$attribute]); $i++) {
@ -4848,10 +4834,10 @@ class windowsUser extends baseModule implements passwordService, AccountStatusPr
}; };
} }
elseif ($attributeName === 'accountexpires') { elseif ($attributeName === 'accountexpires') {
return fn(array $entry, string $attribute): ?htmlElement => new htmlOutputText($this->formatAccountExpires($entry)); return fn(array $entry, string $attribute): htmlElement => new htmlOutputText($this->formatAccountExpires($entry));
} }
elseif (($attributeName === 'whencreated') || ($attributeName === 'whenchanged')) { elseif (($attributeName === 'whencreated') || ($attributeName === 'whenchanged')) {
return function(array $entry, string $attribute): ?htmlElement { return function(array $entry, string $attribute): htmlElement {
$value = ' - '; $value = ' - ';
if (!empty($entry[$attribute][0])) { if (!empty($entry[$attribute][0])) {
$value = formatLDAPTimestamp($entry[$attribute][0]); $value = formatLDAPTimestamp($entry[$attribute][0]);

9
lam/lib/status.inc
View file

@ -38,12 +38,12 @@
* <br> It may be formatted with special color/link/bold tags. * <br> It may be formatted with special color/link/bold tags.
* @param string $MessageText The text of the status message. * @param string $MessageText The text of the status message.
* <br> It may be formatted with special color/link/bold tags. This parameter is optional. * <br> It may be formatted with special color/link/bold tags. This parameter is optional.
* @param array|string $MessageVariables The variables that are used to replace the spacers (%s) in the * @param array|string|null $MessageVariables The variables that are used to replace the spacers (%s) in the
* submitted text. This parameter is optional. * submitted text. This parameter is optional.
* @param bool $returnOutput if set to true this function will return the generated HTML code instead of printing it directly (default: false) * @param bool $returnOutput if set to true this function will return the generated HTML code instead of printing it directly (default: false)
* @return string HTML code if $returnOutput is set to true, otherwise null * @return string HTML code if $returnOutput is set to true, otherwise null
*/ */
function StatusMessage($MessageTyp, $MessageHeadline, $MessageText = '', array|string $MessageVariables = [], bool $returnOutput = false): string { function StatusMessage($MessageTyp, $MessageHeadline, $MessageText = '', array|string|null $MessageVariables = [], bool $returnOutput = false): string {
/* Setting CSS-StyleSheet class depending on the $MessageTyp and rewriting $MessageTyp with a readable string. */ /* Setting CSS-StyleSheet class depending on the $MessageTyp and rewriting $MessageTyp with a readable string. */
if ($MessageTyp == "INFO") { if ($MessageTyp == "INFO") {
$class = "class=\"statusInfo lam-status-message\""; $class = "class=\"statusInfo lam-status-message\"";
@ -75,9 +75,12 @@ function StatusMessage($MessageTyp, $MessageHeadline, $MessageText = '', array|s
$output = $format; $output = $format;
} }
} }
else { elseif ($MessageVariables !== null) {
$output = sprintf($format, $MessageVariables); $output = sprintf($format, $MessageVariables);
} }
else {
$output = $format;
}
if ($returnOutput) { if ($returnOutput) {
return $output; return $output;
} }