upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-02-20 00:12:30 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 14

Fix PHP 8.1 support for user_ldap application

Browse source 
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
This commit is contained in:
Côme Chilliet 2021-10-26 16:43:39 +02:00
parent 37f8f7a5a1
commit f3dcbfe146
No known key found for this signature in database
GPG key ID: A3E2F658B28C760A
18 changed files with 96 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
apps/user_ldap/lib/Access.php
View file

@ -260,7 +260,7 @@ class Access extends LDAPUtility {
/**
* Runs an read operation against LDAP
*
* @param resource $cr the LDAP connection
* @param resource|\LDAP\Connection $cr the LDAP connection
* @param string $dn
* @param string $attribute
* @param string $filter
@ -926,7 +926,7 @@ class Access extends LDAPUtility {
* @throws \Exception
*/
public function batchApplyUserAttributes(array $ldapRecords) {
$displayNameAttribute = strtolower($this->connection->ldapUserDisplayName);
$displayNameAttribute = strtolower((string)$this->connection->ldapUserDisplayName);
foreach ($ldapRecords as $userRecord) {
if (!isset($userRecord[$displayNameAttribute])) {
// displayName is obligatory
@ -1186,7 +1186,7 @@ class Access extends LDAPUtility {
/**
* processes an LDAP paged search operation
*
* @param resource $sr the array containing the LDAP search resources
* @param resource|\LDAP\Result|resource[]|\LDAP\Result[] $sr the array containing the LDAP search resources
* @param int $foundItems number of results in the single search operation
* @param int $limit maximum results to be counted
* @param bool $pagedSearchOK whether a paged search has been executed
@ -1303,7 +1303,7 @@ class Access extends LDAPUtility {
}
/**
* @param resource $sr
* @param resource|\LDAP\Result|resource[]|\LDAP\Result[] $sr
* @return int
* @throws ServerNotAvailableException
*/

9
apps/user_ldap/lib/Connection.php
View file

@ -74,6 +74,9 @@ use Psr\Log\LoggerInterface;
* @property string ldapMatchingRuleInChainState
*/
class Connection extends LDAPUtility {
/**
* @var resource|\LDAP\Connection|null
*/
private $ldapConnectionRes = null;
private $configPrefix;
private $configID;
@ -202,7 +205,7 @@ class Connection extends LDAPUtility {
}
/**
* Returns the LDAP handler
* @return resource|\LDAP\Connection The LDAP resource
*/
public function getConnectionResource() {
if (!$this->ldapConnectionRes) {
@ -408,7 +411,7 @@ class Connection extends LDAPUtility {
}
}
if ((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
if ((stripos((string)$this->configuration->ldapHost, 'ldaps://') === 0)
&& $this->configuration->ldapTLS) {
$this->configuration->ldapTLS = false;
$this->logger->info(
@ -487,7 +490,7 @@ class Connection extends LDAPUtility {
$configurationOK = false;
}
if (mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
if (mb_strpos((string)$this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
=== false) {
$this->logger->warning(
$errorStr.'login filter does not contain %uid place holder.',

6
apps/user_ldap/lib/Group_LDAP.php
View file

@ -83,7 +83,7 @@ class Group_LDAP extends BackendUtility implements GroupInterface, IGroupLDAP, I
$this->cachedNestedGroups = new CappedMemoryCache();
$this->groupPluginManager = $groupPluginManager;
$this->logger = OC::$server->get(LoggerInterface::class);
$this->ldapGroupMemberAssocAttr = strtolower($gAssoc);
$this->ldapGroupMemberAssocAttr = strtolower((string)$gAssoc);
}
/**
@ -202,7 +202,7 @@ class Group_LDAP extends BackendUtility implements GroupInterface, IGroupLDAP, I
* @throws ServerNotAvailableException
*/
public function getDynamicGroupMembers(string $dnGroup): array {
$dynamicGroupMemberURL = strtolower($this->access->connection->ldapDynamicGroupMemberURL);
$dynamicGroupMemberURL = strtolower((string)$this->access->connection->ldapDynamicGroupMemberURL);
if (empty($dynamicGroupMemberURL)) {
return [];
@ -1312,7 +1312,7 @@ class Group_LDAP extends BackendUtility implements GroupInterface, IGroupLDAP, I
* of the current access.
*
* @param string $gid
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection The LDAP connection
* @throws ServerNotAvailableException
*/
public function getNewLDAPConnection($gid) {

2
apps/user_ldap/lib/Group_Proxy.php
View file

@ -290,7 +290,7 @@ class Group_Proxy extends Proxy implements \OCP\GroupInterface, IGroupLDAP, IGet
* The connection needs to be closed manually.
*
* @param string $gid
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection The LDAP connection
*/
public function getNewLDAPConnection($gid) {
return $this->handleRequest($gid, 'getNewLDAPConnection', [$gid]);

2
apps/user_ldap/lib/IGroupLDAP.php
View file

@ -36,7 +36,7 @@ interface IGroupLDAP {
/**
* Return a new LDAP connection for the specified group.
* @param string $gid
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection The LDAP connection
*/
public function getNewLDAPConnection($gid);
}

60
apps/user_ldap/lib/ILDAPWrapper.php
View file

@ -35,7 +35,7 @@ interface ILDAPWrapper {
/**
* Bind to LDAP directory
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param string $dn an RDN to log in with
* @param string $password the password
* @return bool true on success, false otherwise
@ -54,7 +54,7 @@ interface ILDAPWrapper {
/**
* Send LDAP pagination control
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param int $pageSize number of results per page
* @param bool $isCritical Indicates whether the pagination is critical of not.
* @param string $cookie structure sent by LDAP server
@ -64,8 +64,8 @@ interface ILDAPWrapper {
/**
* Retrieve the LDAP pagination cookie
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param resource|\LDAP\Result $result LDAP result resource
* @param string $cookie structure sent by LDAP server
* @return bool true on success, false otherwise
*
@ -75,22 +75,22 @@ interface ILDAPWrapper {
/**
* Count the number of entries in a search
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param resource|\LDAP\Result $result LDAP result resource
* @return int|false number of results on success, false otherwise
*/
public function countEntries($link, $result);
/**
* Return the LDAP error number of the last LDAP command
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @return int error code
*/
public function errno($link);
/**
* Return the LDAP error message of the last LDAP command
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @return string error message
*/
public function error($link);
@ -106,69 +106,69 @@ interface ILDAPWrapper {
/**
* Return first result id
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @return Resource an LDAP search result resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param resource|\LDAP\Result $result LDAP result resource
* @return resource|\LDAP\ResultEntry an LDAP entry resource
* */
public function firstEntry($link, $result);
/**
* Get attributes from a search result entry
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param resource|\LDAP\ResultEntry $result LDAP result resource
* @return array containing the results, false on error
* */
public function getAttributes($link, $result);
/**
* Get the DN of a result entry
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param resource|\LDAP\ResultEntry $result LDAP result resource
* @return string containing the DN, false on error
*/
public function getDN($link, $result);
/**
* Get all result entries
* @param resource $link LDAP link resource
* @param resource $result LDAP result resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param resource|\LDAP\Result $result LDAP result resource
* @return array containing the results, false on error
*/
public function getEntries($link, $result);
/**
* Return next result id
* @param resource $link LDAP link resource
* @param resource $result LDAP entry result resource
* @return resource an LDAP search result resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param resource|\LDAP\ResultEntry $result LDAP result resource
* @return resource|\LDAP\ResultEntry an LDAP entry resource
* */
public function nextEntry($link, $result);
/**
* Read an entry
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param array $baseDN The DN of the entry to read from
* @param string $filter An LDAP filter
* @param array $attr array of the attributes to read
* @return resource an LDAP search result resource
* @return resource|\LDAP\Result an LDAP search result resource
*/
public function read($link, $baseDN, $filter, $attr);
/**
* Search LDAP tree
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param string $baseDN The DN of the entry to read from
* @param string $filter An LDAP filter
* @param array $attr array of the attributes to read
* @param int $attrsOnly optional, 1 if only attribute types shall be returned
* @param int $limit optional, limits the result entries
* @return resource|false an LDAP search result resource, false on error
* @return resource|\LDAP\Result|false an LDAP search result resource, false on error
*/
public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0);
/**
* Replace the value of a userPassword by $password
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param string $userDN the DN of the user whose password is to be replaced
* @param string $password the new value for the userPassword
* @return bool true on success, false otherwise
@ -177,7 +177,7 @@ interface ILDAPWrapper {
/**
* Sets the value of the specified option to be $value
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @param string $option a defined LDAP Server option
* @param int $value the new value for the option
* @return bool true on success, false otherwise
@ -186,14 +186,14 @@ interface ILDAPWrapper {
/**
* establish Start TLS
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @return bool true on success, false otherwise
*/
public function startTls($link);
/**
* Unbind from LDAP directory
* @param resource $link LDAP link resource
* @param resource|\LDAP\Connection $link LDAP link resource
* @return bool true on success, false otherwise
*/
public function unbind($link);
@ -208,8 +208,8 @@ interface ILDAPWrapper {
/**
* Checks whether the submitted parameter is a resource
* @param resource $resource the resource variable to check
* @return bool true if it is a resource, false otherwise
* @param mixed $resource the resource variable to check
* @return bool true if it is a resource or LDAP object, false otherwise
*/
public function isResource($resource);
}

2
apps/user_ldap/lib/IUserLDAP.php
View file

@ -37,7 +37,7 @@ interface IUserLDAP {
/**
* Return a new LDAP connection for the specified user.
* @param string $uid
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection of the LDAP connection
*/
public function getNewLDAPConnection($uid);

92
apps/user_ldap/lib/LDAP.php
View file

@ -51,19 +51,14 @@ class LDAP implements ILDAPWrapper {
}
/**
* @param resource $link
* @param string $dn
* @param string $password
* @return bool|mixed
* {@inheritDoc}
*/
public function bind($link, $dn, $password) {
return $this->invokeLDAPMethod('bind', $link, $dn, $password);
}
/**
* @param string $host
* @param string $port
* @return mixed
* {@inheritDoc}
*/
public function connect($host, $port) {
if (strpos($host, '://') === false) {
@ -76,6 +71,9 @@ class LDAP implements ILDAPWrapper {
return $this->invokeLDAPMethod('connect', $host);
}
/**
* {@inheritDoc}
*/
public function controlPagedResultResponse($link, $result, &$cookie): bool {
$this->preFunctionCall(
$this->pagedResultsAdapter->getResponseCallFunc(),
@ -93,10 +91,7 @@ class LDAP implements ILDAPWrapper {
}
/**
* @param LDAP $link
* @param int $pageSize
* @param bool $isCritical
* @return mixed|true
* {@inheritDoc}
*/
public function controlPagedResult($link, $pageSize, $isCritical) {
$fn = $this->pagedResultsAdapter->getRequestCallFunc();
@ -116,25 +111,21 @@ class LDAP implements ILDAPWrapper {
}
/**
* @param LDAP $link
* @param LDAP $result
* @return mixed
* {@inheritDoc}
*/
public function countEntries($link, $result) {
return $this->invokeLDAPMethod('count_entries', $link, $result);
}
/**
* @param LDAP $link
* @return integer
* {@inheritDoc}
*/
public function errno($link) {
return $this->invokeLDAPMethod('errno', $link);
}
/**
* @param LDAP $link
* @return string
* {@inheritDoc}
*/
public function error($link) {
return $this->invokeLDAPMethod('error', $link);
@ -152,56 +143,42 @@ class LDAP implements ILDAPWrapper {
}
/**
* @param LDAP $link
* @param LDAP $result
* @return mixed
* {@inheritDoc}
*/
public function firstEntry($link, $result) {
return $this->invokeLDAPMethod('first_entry', $link, $result);
}
/**
* @param LDAP $link
* @param LDAP $result
* @return array|mixed
* {@inheritDoc}
*/
public function getAttributes($link, $result) {
return $this->invokeLDAPMethod('get_attributes', $link, $result);
}
/**
* @param LDAP $link
* @param LDAP $result
* @return mixed|string
* {@inheritDoc}
*/
public function getDN($link, $result) {
return $this->invokeLDAPMethod('get_dn', $link, $result);
}
/**
* @param LDAP $link
* @param LDAP $result
* @return array|mixed
* {@inheritDoc}
*/
public function getEntries($link, $result) {
return $this->invokeLDAPMethod('get_entries', $link, $result);
}
/**
* @param LDAP $link
* @param resource $result
* @return mixed
* {@inheritDoc}
*/
public function nextEntry($link, $result) {
return $this->invokeLDAPMethod('next_entry', $link, $result);
}
/**
* @param LDAP $link
* @param string $baseDN
* @param string $filter
* @param array $attr
* @return mixed
* {@inheritDoc}
*/
public function read($link, $baseDN, $filter, $attr) {
$this->pagedResultsAdapter->setReadArgs($link, $baseDN, $filter, $attr);
@ -209,14 +186,7 @@ class LDAP implements ILDAPWrapper {
}
/**
* @param LDAP $link
* @param string[] $baseDN
* @param string $filter
* @param array $attr
* @param int $attrsOnly
* @param int $limit
* @return mixed
* @throws \Exception
* {@inheritDoc}
*/
public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0) {
$oldHandler = set_error_handler(function ($no, $message, $file, $line) use (&$oldHandler) {
@ -239,47 +209,35 @@ class LDAP implements ILDAPWrapper {
}
/**
* @param LDAP $link
* @param string $userDN
* @param string $password
* @return bool
* {@inheritDoc}
*/
public function modReplace($link, $userDN, $password) {
return $this->invokeLDAPMethod('mod_replace', $link, $userDN, ['userPassword' => $password]);
}
/**
* @param LDAP $link
* @param string $userDN
* @param string $oldPassword
* @param string $password
* @return bool
* {@inheritDoc}
*/
public function exopPasswd($link, $userDN, $oldPassword, $password) {
return $this->invokeLDAPMethod('exop_passwd', $link, $userDN, $oldPassword, $password);
}
/**
* @param LDAP $link
* @param string $option
* @param int $value
* @return bool|mixed
* {@inheritDoc}
*/
public function setOption($link, $option, $value) {
return $this->invokeLDAPMethod('set_option', $link, $option, $value);
}
/**
* @param LDAP $link
* @return mixed|true
* {@inheritDoc}
*/
public function startTls($link) {
return $this->invokeLDAPMethod('start_tls', $link);
}
/**
* @param resource $link
* @return bool|mixed
* {@inheritDoc}
*/
public function unbind($link) {
return $this->invokeLDAPMethod('unbind', $link);
@ -294,12 +252,10 @@ class LDAP implements ILDAPWrapper {
}
/**
* Checks whether the submitted parameter is a resource
* @param Resource $resource the resource variable to check
* @return bool true if it is a resource, false otherwise
* {@inheritDoc}
*/
public function isResource($resource) {
return is_resource($resource);
return is_resource($resource) || is_object($resource);
}
/**
@ -368,7 +324,7 @@ class LDAP implements ILDAPWrapper {
/**
* Analyzes the returned LDAP error and acts accordingly if not 0
*
* @param resource $resource the LDAP Connection resource
* @param resource|\LDAP\Connection $resource the LDAP Connection resource
* @throws ConstraintViolationException
* @throws ServerNotAvailableException
* @throws \Exception

4
apps/user_ldap/lib/LDAPProvider.php
View file

@ -149,7 +149,7 @@ class LDAPProvider implements ILDAPProvider, IDeletionFlagSupport {
* Return a new LDAP connection resource for the specified user.
* The connection must be closed manually.
* @param string $uid user id
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection The LDAP connection
* @throws \Exception if user id was not found in LDAP
*/
public function getLDAPConnection($uid) {
@ -163,7 +163,7 @@ class LDAPProvider implements ILDAPProvider, IDeletionFlagSupport {
* Return a new LDAP connection resource for the specified user.
* The connection must be closed manually.
* @param string $gid group id
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection The LDAP connection
* @throws \Exception if group id was not found in LDAP
*/
public function getGroupLDAPConnection($gid) {

4
apps/user_ldap/lib/PagedResults/IAdapter.php
View file

@ -82,7 +82,7 @@ interface IAdapter {
/**
* the adapter should do it's LDAP function call and return success state
*
* @param resource $link LDAP resource
* @param resource|\LDAP\Connection $link LDAP resource
* @return bool
*/
public function responseCall($link): bool;
@ -123,7 +123,7 @@ interface IAdapter {
/**
* Returns the current paged results cookie
*
* @param resource $link LDAP resource
* @param resource|\LDAP\Connection $link LDAP resource
* @return string
*/
public function getCookie($link): string;

12
apps/user_ldap/lib/PagedResults/TLinkId.php
View file

@ -28,10 +28,16 @@ namespace OCA\User_LDAP\PagedResults;
trait TLinkId {
public function getLinkId($link) {
if (is_resource($link)) {
if (is_object($link)) {
return spl_object_id($link);
} elseif (is_resource($link)) {
return (int)$link;
} elseif (is_array($link) && isset($link[0]) && is_resource($link[0])) {
return (int)$link[0];
} elseif (is_array($link) && isset($link[0])) {
if (is_object($link[0])) {
return spl_object_id($link[0]);
} elseif (is_resource($link[0])) {
return (int)$link[0];
}
}
throw new \RuntimeException('No resource provided');
}

2
apps/user_ldap/lib/User/Manager.php
View file

@ -177,7 +177,7 @@ class Manager {
$this->access->getConnection()->ldapExtStorageHomeAttribute,
];
$homeRule = $this->access->getConnection()->homeFolderNamingRule;
$homeRule = (string)$this->access->getConnection()->homeFolderNamingRule;
if (strpos($homeRule, 'attr:') === 0) {
$attributes[] = substr($homeRule, strlen('attr:'));
}

8
apps/user_ldap/lib/User/User.php
View file

@ -464,9 +464,9 @@ class User {
* bytes), '1234 MB' (quota in MB - check the \OC_Helper::computerFileSize method for more info)
*
* fetches the quota from LDAP and stores it as Nextcloud user value
* @param string $valueFromLDAP the quota attribute's value can be passed,
* @param ?string $valueFromLDAP the quota attribute's value can be passed,
* to save the readAttribute request
* @return null
* @return void
*/
public function updateQuota($valueFromLDAP = null) {
if ($this->wasRefreshed('quota')) {
@ -487,7 +487,7 @@ class User {
} elseif (is_array($aQuota) && isset($aQuota[0])) {
$this->logger->debug('no suitable LDAP quota found for user ' . $this->uid . ': [' . $aQuota[0] . ']', ['app' => 'user_ldap']);
}
} elseif ($this->verifyQuotaValue($valueFromLDAP)) {
} elseif (!is_null($valueFromLDAP) && $this->verifyQuotaValue($valueFromLDAP)) {
$quota = $valueFromLDAP;
} else {
$this->logger->debug('no suitable LDAP quota found for user ' . $this->uid . ': [' . $valueFromLDAP . ']', ['app' => 'user_ldap']);
@ -509,7 +509,7 @@ class User {
}
}
private function verifyQuotaValue($quotaValue) {
private function verifyQuotaValue(string $quotaValue) {
return $quotaValue === 'none' || $quotaValue === 'default' || \OC_Helper::computerFileSize($quotaValue) !== false;
}

2
apps/user_ldap/lib/User_LDAP.php
View file

@ -617,7 +617,7 @@ class User_LDAP extends BackendUtility implements \OCP\IUserBackend, \OCP\UserIn
* The cloned connection needs to be closed manually.
* of the current access.
* @param string $uid
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection The LDAP connection
*/
public function getNewLDAPConnection($uid) {
$connection = clone $this->access->getConnection();

2
apps/user_ldap/lib/User_Proxy.php
View file

@ -368,7 +368,7 @@ class User_Proxy extends Proxy implements \OCP\IUserBackend, \OCP\UserInterface,
* The connection needs to be closed manually.
*
* @param string $uid
* @return resource of the LDAP connection
* @return resource|\LDAP\Connection The LDAP connection
*/
public function getNewLDAPConnection($uid) {
return $this->handleRequest($uid, 'getNewLDAPConnection', [$uid]);

6
apps/user_ldap/lib/Wizard.php
View file

@ -820,7 +820,7 @@ class Wizard extends LDAPUtility {
return false;
}
$er = $this->ldap->firstEntry($cr, $rr);
while (is_resource($er)) {
while ($this->ldap->isResource($er)) {
$this->ldap->getDN($cr, $er);
$attrs = $this->ldap->getAttributes($cr, $er);
$result = [];
@ -1066,7 +1066,7 @@ class Wizard extends LDAPUtility {
['app' => 'user_ldap']
);
$cr = $this->ldap->connect($host, $port);
if (!is_resource($cr)) {
if (!$this->ldap->isResource($cr)) {
throw new \Exception(self::$l->t('Invalid Host'));
}
@ -1276,7 +1276,7 @@ class Wizard extends LDAPUtility {
/**
* appends a list of values fr
* @param resource $result the return value from ldap_get_attributes
* @param array $result the return value from ldap_get_attributes
* @param string $attribute the attribute values to look for
* @param array &$known new values will be appended here
* @return int, state on of the class constants LRESULT_PROCESSED_OK,

2
apps/user_ldap/tests/AccessTest.php
View file

@ -559,7 +559,7 @@ class AccessTest extends TestCase {
->expects($this->any())
->method('isResource')
->willReturnCallback(function ($resource) {
return is_resource($resource);
return is_resource($resource) || is_object($resource);
});
$this->ldap
->expects($this->any())

4
apps/user_ldap/tests/Integration/ExceptionOnLostConnection.php
View file

@ -146,7 +146,7 @@ class ExceptionOnLostConnection {
* tests whether a curl operation ran successfully. If not, an exception
* is thrown
*
* @param resource $ch
* @param resource|\CurlHandle $ch
* @param mixed $result
* @throws \Exception
*/
@ -182,7 +182,7 @@ class ExceptionOnLostConnection {
/**
* initializes a curl handler towards the toxiproxy LDAP proxy service
* @return resource
* @return resource|\CurlHandle
*/
private function getCurl() {
$ch = curl_init();