@ -44,12 +44,13 @@ declare(strict_types=1);
*/
*/
namespace OCA\Files_Sharing\Controller;
namespace OCA\Files_Sharing\Controller;
use Exception;
use OC\Files\FileInfo;
use OC\Files\FileInfo;
use OC\Files\Storage\Wrapper\Wrapper;
use OC\Files\Storage\Wrapper\Wrapper;
use OCA\Files\Helper;
use OCA\Files_Sharing\Exceptions\SharingRightsException;
use OCA\Files_Sharing\Exceptions\SharingRightsException;
use OCA\Files_Sharing\External\Storage;
use OCA\Files_Sharing\External\Storage;
use OCA\Files_Sharing\SharedStorage;
use OCA\Files_Sharing\SharedStorage;
use OCA\Files\Helper;
use OCP\App\IAppManager;
use OCP\App\IAppManager;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSBadRequestException;
use OCP\AppFramework\OCS\OCSBadRequestException;
@ -59,9 +60,9 @@ use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\AppFramework\OCSController;
use OCP\AppFramework\OCSController;
use OCP\AppFramework\QueryException;
use OCP\AppFramework\QueryException;
use OCP\Constants;
use OCP\Constants;
use OCP\Files\Folder;
use OCP\Files\InvalidPathException;
use OCP\Files\InvalidPathException;
use OCP\Files\IRootFolder;
use OCP\Files\IRootFolder;
use OCP\Files\Folder;
use OCP\Files\Node;
use OCP\Files\Node;
use OCP\Files\NotFoundException;
use OCP\Files\NotFoundException;
use OCP\IConfig;
use OCP\IConfig;
@ -74,12 +75,14 @@ use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\IUserManager;
use OCP\Lock\ILockingProvider;
use OCP\Lock\ILockingProvider;
use OCP\Lock\LockedException;
use OCP\Lock\LockedException;
use OCP\Share ;
use OCP\Server ;
use OCP\Share\Exceptions\GenericShareException;
use OCP\Share\Exceptions\GenericShareException;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\IManager;
use OCP\Share\IManager;
use OCP\Share\IShare;
use OCP\Share\IShare;
use OCP\UserStatus\IManager as IUserStatusManager;
use OCP\UserStatus\IManager as IUserStatusManager;
use Psr\Container\ContainerExceptionInterface;
use Psr\Log\LoggerInterface;
/**
/**
* Class Share20OCS
* Class Share20OCS
@ -274,7 +277,11 @@ class ShareAPIController extends OCSController {
$result['token'] = $share->getToken();
$result['token'] = $share->getToken();
$result['url'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $share->getToken()]);
$result['url'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $share->getToken()]);
} elseif ($share->getShareType() === IShare::TYPE_REMOTE || $share->getShareType() === IShare::TYPE_REMOTE_GROUP) {
} elseif ($share->getShareType() === IShare::TYPE_REMOTE) {
$result['share_with'] = $share->getSharedWith();
$result['share_with_displayname'] = $this->getCachedFederatedDisplayName($share->getSharedWith());
$result['token'] = $share->getToken();
} elseif ($share->getShareType() === IShare::TYPE_REMOTE_GROUP) {
$result['share_with'] = $share->getSharedWith();
$result['share_with'] = $share->getSharedWith();
$result['share_with_displayname'] = $this->getDisplayNameFromAddressBook($share->getSharedWith(), 'CLOUD');
$result['share_with_displayname'] = $this->getDisplayNameFromAddressBook($share->getSharedWith(), 'CLOUD');
$result['token'] = $share->getToken();
$result['token'] = $share->getToken();
@ -344,7 +351,7 @@ class ShareAPIController extends OCSController {
/**
/**
* Check if one of the users address books knows the exact property, if
* Check if one of the users address books knows the exact property, if
* yes we return the full name.
* not we return the full name.
*
*
* @param string $query
* @param string $query
* @param string $property
* @param string $property
@ -352,11 +359,20 @@ class ShareAPIController extends OCSController {
*/
*/
private function getDisplayNameFromAddressBook(string $query, string $property): string {
private function getDisplayNameFromAddressBook(string $query, string $property): string {
// FIXME: If we inject the contacts manager it gets initialized before any address books are registered
// FIXME: If we inject the contacts manager it gets initialized before any address books are registered
$result = \OC::$server->getContactsManager()->search($query, [$property], [
try {
'limit' => 1,
$result = \OC::$server->getContactsManager()->search($query, [$property], [
'enumeration' => false,
'limit' => 1,
'strict_search' => true,
'enumeration' => false,
]);
'strict_search' => true,
]);
} catch (Exception $e) {
Server::get(LoggerInterface::class)->error(
$e->getMessage(),
['exception' => $e]
);
return $query;
}
foreach ($result as $r) {
foreach ($result as $r) {
foreach ($r[$property] as $value) {
foreach ($r[$property] as $value) {
if ($value === $query & & $r['FN']) {
if ($value === $query & & $r['FN']) {
@ -368,6 +384,102 @@ class ShareAPIController extends OCSController {
return $query;
return $query;
}
}
/**
* @param array $shares
* @param array|null $updatedDisplayName
*
* @return array
*/
private function fixMissingDisplayName(array $shares, ?array $updatedDisplayName = null): array {
$userIds = $updated = [];
foreach ($shares as $share) {
// share is federated and share have no display name yet
if ($share['share_type'] === IShare::TYPE_REMOTE
& & ($share['share_with'] ?? '') !== ''
& & ($share['share_with_displayname'] ?? '') === '') {
$userIds[] = $userId = $share['share_with'];
if ($updatedDisplayName !== null & & array_key_exists($userId, $updatedDisplayName)) {
$share['share_with_displayname'] = $updatedDisplayName[$userId];
}
}
// prepping userIds with displayName to be updated
$updated[] = $share;
}
// if $updatedDisplayName is not null, it means we should have already fixed displayNames of the shares
if ($updatedDisplayName !== null) {
return $updated;
}
// get displayName for the generated list of userId with no displayName
$displayNames = $this->retrieveFederatedDisplayName($userIds);
// if no displayName are updated, we exit
if (empty($displayNames)) {
return $updated;
}
// let's fix missing display name and returns all shares
return $this->fixMissingDisplayName($shares, $displayNames);
}
/**
* get displayName of a list of userIds from the lookup-server; through the globalsiteselector app.
* returns an array with userIds as keys and displayName as values.
*
* @param array $userIds
* @param bool $cacheOnly - do not reach LUS, get data from cache.
*
* @return array
* @throws ContainerExceptionInterface
*/
private function retrieveFederatedDisplayName(array $userIds, bool $cacheOnly = false): array {
// check if gss is enabled and available
if (count($userIds) === 0
|| !$this->appManager->isInstalled('globalsiteselector')
|| !class_exists('\OCA\GlobalSiteSelector\Service\SlaveService')) {
return [];
}
try {
$slaveService = Server::get(\OCA\GlobalSiteSelector\Service\SlaveService::class);
} catch (\Throwable $e) {
Server::get(LoggerInterface::class)->error(
$e->getMessage(),
['exception' => $e]
);
return [];
}
return $slaveService->getUsersDisplayName($userIds, $cacheOnly);
}
/**
* retrieve displayName from cache if available (should be used on federated shares)
* if not available in cache/lus, try for get from address-book, else returns empty string.
*
* @param string $userId
* @param bool $cacheOnly if true will not reach the lus but will only get data from cache
*
* @return string
*/
private function getCachedFederatedDisplayName(string $userId, bool $cacheOnly = true): string {
$details = $this->retrieveFederatedDisplayName([$userId], $cacheOnly);
if (array_key_exists($userId, $details)) {
return $details[$userId];
}
$displayName = $this->getDisplayNameFromAddressBook($userId, 'CLOUD');
return ($displayName === $userId) ? '' : $displayName;
}
/**
/**
* Get a specific share by id
* Get a specific share by id
*
*
@ -646,6 +758,8 @@ class ShareAPIController extends OCSController {
throw new OCSNotFoundException($this->l->t('Invalid date, date format must be YYYY-MM-DD'));
throw new OCSNotFoundException($this->l->t('Invalid date, date format must be YYYY-MM-DD'));
}
}
}
}
$share->setSharedWithDisplayName($this->getCachedFederatedDisplayName($shareWith, false));
} elseif ($shareType === IShare::TYPE_REMOTE_GROUP) {
} elseif ($shareType === IShare::TYPE_REMOTE_GROUP) {
if (!$this->shareManager->outgoingServer2ServerGroupSharesAllowed()) {
if (!$this->shareManager->outgoingServer2ServerGroupSharesAllowed()) {
throw new OCSForbiddenException($this->l->t('Sharing %1$s failed because the back end does not allow shares from type %2$s', [$node->getPath(), $shareType]));
throw new OCSForbiddenException($this->l->t('Sharing %1$s failed because the back end does not allow shares from type %2$s', [$node->getPath(), $shareType]));
@ -793,7 +907,6 @@ class ShareAPIController extends OCSController {
// filter out duplicate shares
// filter out duplicate shares
$known = [];
$known = [];
$formatted = $miniFormatted = [];
$formatted = $miniFormatted = [];
$resharingRight = false;
$resharingRight = false;
$known = [];
$known = [];
@ -957,6 +1070,9 @@ class ShareAPIController extends OCSController {
$formatted = $miniFormatted;
$formatted = $miniFormatted;
}
}
// fix eventual missing display name from federated shares
$formatted = $this->fixMissingDisplayName($formatted);
if ($includeTags) {
if ($includeTags) {
$formatted =
$formatted =
Helper::populateTags($formatted, 'file_source', \OC::$server->getTagManager());
Helper::populateTags($formatted, 'file_source', \OC::$server->getTagManager());
Maxence Lange
11 months ago