123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407 |
- <?php
- declare(strict_types=1);
- namespace OCA\Files_Sharing\Controller;
- use Generator;
- use OC\Collaboration\Collaborators\SearchResult;
- use OC\Share\Share;
- use OCA\Files_Sharing\ResponseDefinitions;
- use OCP\AppFramework\Http;
- use OCP\AppFramework\Http\Attribute\NoAdminRequired;
- use OCP\AppFramework\Http\DataResponse;
- use OCP\AppFramework\OCS\OCSBadRequestException;
- use OCP\AppFramework\OCSController;
- use OCP\Collaboration\Collaborators\ISearch;
- use OCP\Collaboration\Collaborators\ISearchResult;
- use OCP\Collaboration\Collaborators\SearchResultType;
- use OCP\Constants;
- use OCP\IConfig;
- use OCP\IRequest;
- use OCP\IURLGenerator;
- use OCP\Share\IManager;
- use OCP\Share\IShare;
- use function array_slice;
- use function array_values;
- use function usort;
- class ShareesAPIController extends OCSController {
-
- protected $offset = 0;
-
- protected $limit = 10;
-
- protected $result = [
- 'exact' => [
- 'users' => [],
- 'groups' => [],
- 'remotes' => [],
- 'remote_groups' => [],
- 'emails' => [],
- 'circles' => [],
- 'rooms' => [],
- ],
- 'users' => [],
- 'groups' => [],
- 'remotes' => [],
- 'remote_groups' => [],
- 'emails' => [],
- 'lookup' => [],
- 'circles' => [],
- 'rooms' => [],
- 'lookupEnabled' => false,
- ];
- protected $reachedEndFor = [];
-
- public function __construct(
- string $appName,
- IRequest $request,
- protected string $userId,
- protected IConfig $config,
- protected IURLGenerator $urlGenerator,
- protected IManager $shareManager,
- protected ISearch $collaboratorSearch,
- ) {
- parent::__construct($appName, $request);
- }
-
-
- public function search(string $search = '', ?string $itemType = null, int $page = 1, int $perPage = 200, $shareType = null, bool $lookup = false): DataResponse {
-
- $threshold = $this->config->getSystemValueInt('sharing.minSearchStringLength', 0);
- if (strlen($search) < $threshold) {
- return new DataResponse($this->result);
- }
- if ($this->shareManager->sharingDisabledForUser($this->userId)) {
- return new DataResponse($this->result);
- }
-
- $maxResults = $this->config->getSystemValueInt('sharing.maxAutocompleteResults', Constants::SHARING_MAX_AUTOCOMPLETE_RESULTS_DEFAULT);
- if ($maxResults > 0) {
- $perPage = min($perPage, $maxResults);
- }
- if ($perPage <= 0) {
- throw new OCSBadRequestException('Invalid perPage argument');
- }
- if ($page <= 0) {
- throw new OCSBadRequestException('Invalid page');
- }
- $shareTypes = [
- IShare::TYPE_USER,
- ];
- if ($itemType === null) {
- throw new OCSBadRequestException('Missing itemType');
- } elseif ($itemType === 'file' || $itemType === 'folder') {
- if ($this->shareManager->allowGroupSharing()) {
- $shareTypes[] = IShare::TYPE_GROUP;
- }
- if ($this->isRemoteSharingAllowed($itemType)) {
- $shareTypes[] = IShare::TYPE_REMOTE;
- }
- if ($this->isRemoteGroupSharingAllowed($itemType)) {
- $shareTypes[] = IShare::TYPE_REMOTE_GROUP;
- }
- if ($this->shareManager->shareProviderExists(IShare::TYPE_EMAIL)) {
- $shareTypes[] = IShare::TYPE_EMAIL;
- }
- if ($this->shareManager->shareProviderExists(IShare::TYPE_ROOM)) {
- $shareTypes[] = IShare::TYPE_ROOM;
- }
- if ($this->shareManager->shareProviderExists(IShare::TYPE_SCIENCEMESH)) {
- $shareTypes[] = IShare::TYPE_SCIENCEMESH;
- }
- } else {
- if ($this->shareManager->allowGroupSharing()) {
- $shareTypes[] = IShare::TYPE_GROUP;
- }
- $shareTypes[] = IShare::TYPE_EMAIL;
- }
-
- if (\OC::$server->getAppManager()->isEnabledForUser('circles') && class_exists('\OCA\Circles\ShareByCircleProvider')) {
- $shareTypes[] = IShare::TYPE_CIRCLE;
- }
- if ($this->shareManager->shareProviderExists(IShare::TYPE_SCIENCEMESH)) {
- $shareTypes[] = IShare::TYPE_SCIENCEMESH;
- }
- if ($shareType !== null && is_array($shareType)) {
- $shareTypes = array_intersect($shareTypes, $shareType);
- } elseif (is_numeric($shareType)) {
- $shareTypes = array_intersect($shareTypes, [(int)$shareType]);
- }
- sort($shareTypes);
- $this->limit = $perPage;
- $this->offset = $perPage * ($page - 1);
-
- if ($this->config->getSystemValueBool('gs.enabled', false)) {
- $lookup = true;
- $this->result['lookupEnabled'] = true;
- } else {
- $this->result['lookupEnabled'] = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'yes') === 'yes';
- }
- [$result, $hasMoreResults] = $this->collaboratorSearch->search($search, $shareTypes, $lookup, $this->limit, $this->offset);
-
- if (isset($result['exact'])) {
- $result['exact'] = array_merge($this->result['exact'], $result['exact']);
- }
- $this->result = array_merge($this->result, $result);
- $response = new DataResponse($this->result);
- if ($hasMoreResults) {
- $response->setHeaders(['Link' => $this->getPaginationLink($page, [
- 'search' => $search,
- 'itemType' => $itemType,
- 'shareType' => $shareTypes,
- 'perPage' => $perPage,
- ])]);
- }
- return $response;
- }
-
- private function getAllShareesByType(string $user, int $shareType): Generator {
- $offset = 0;
- $pageSize = 50;
- while (count($page = $this->shareManager->getSharesBy(
- $user,
- $shareType,
- null,
- false,
- $pageSize,
- $offset
- ))) {
- foreach ($page as $share) {
- yield [$share->getSharedWith(), $share->getSharedWithDisplayName() ?? $share->getSharedWith()];
- }
- $offset += $pageSize;
- }
- }
- private function sortShareesByFrequency(array $sharees): array {
- usort($sharees, function (array $s1, array $s2): int {
- return $s2['count'] - $s1['count'];
- });
- return $sharees;
- }
- private $searchResultTypeMap = [
- IShare::TYPE_USER => 'users',
- IShare::TYPE_GROUP => 'groups',
- IShare::TYPE_REMOTE => 'remotes',
- IShare::TYPE_REMOTE_GROUP => 'remote_groups',
- IShare::TYPE_EMAIL => 'emails',
- ];
- private function getAllSharees(string $user, array $shareTypes): ISearchResult {
- $result = [];
- foreach ($shareTypes as $shareType) {
- $sharees = $this->getAllShareesByType($user, $shareType);
- $shareTypeResults = [];
- foreach ($sharees as [$sharee, $displayname]) {
- if (!isset($this->searchResultTypeMap[$shareType]) || trim($sharee) === '') {
- continue;
- }
- if (!isset($shareTypeResults[$sharee])) {
- $shareTypeResults[$sharee] = [
- 'count' => 1,
- 'label' => $displayname,
- 'value' => [
- 'shareType' => $shareType,
- 'shareWith' => $sharee,
- ],
- ];
- } else {
- $shareTypeResults[$sharee]['count']++;
- }
- }
- $result = array_merge($result, array_values($shareTypeResults));
- }
- $top5 = array_slice(
- $this->sortShareesByFrequency($result),
- 0,
- 5
- );
- $searchResult = new SearchResult();
- foreach ($this->searchResultTypeMap as $int => $str) {
- $searchResult->addResultSet(new SearchResultType($str), [], []);
- foreach ($top5 as $x) {
- if ($x['value']['shareType'] === $int) {
- $searchResult->addResultSet(new SearchResultType($str), [], [$x]);
- }
- }
- }
- return $searchResult;
- }
-
-
- public function findRecommended(string $itemType, $shareType = null): DataResponse {
- $shareTypes = [
- IShare::TYPE_USER,
- ];
- if ($itemType === 'file' || $itemType === 'folder') {
- if ($this->shareManager->allowGroupSharing()) {
- $shareTypes[] = IShare::TYPE_GROUP;
- }
- if ($this->isRemoteSharingAllowed($itemType)) {
- $shareTypes[] = IShare::TYPE_REMOTE;
- }
- if ($this->isRemoteGroupSharingAllowed($itemType)) {
- $shareTypes[] = IShare::TYPE_REMOTE_GROUP;
- }
- if ($this->shareManager->shareProviderExists(IShare::TYPE_EMAIL)) {
- $shareTypes[] = IShare::TYPE_EMAIL;
- }
- if ($this->shareManager->shareProviderExists(IShare::TYPE_ROOM)) {
- $shareTypes[] = IShare::TYPE_ROOM;
- }
- } else {
- $shareTypes[] = IShare::TYPE_GROUP;
- $shareTypes[] = IShare::TYPE_EMAIL;
- }
-
- if (\OC::$server->getAppManager()->isEnabledForUser('circles') && class_exists('\OCA\Circles\ShareByCircleProvider')) {
- $shareTypes[] = IShare::TYPE_CIRCLE;
- }
- if (isset($_GET['shareType']) && is_array($_GET['shareType'])) {
- $shareTypes = array_intersect($shareTypes, $_GET['shareType']);
- sort($shareTypes);
- } elseif (is_numeric($shareType)) {
- $shareTypes = array_intersect($shareTypes, [(int)$shareType]);
- sort($shareTypes);
- }
- return new DataResponse(
- $this->getAllSharees($this->userId, $shareTypes)->asArray()
- );
- }
-
- protected function isRemoteSharingAllowed(string $itemType): bool {
- try {
-
- $backend = Share::getBackend($itemType);
- return $backend->isShareTypeAllowed(IShare::TYPE_REMOTE);
- } catch (\Exception $e) {
- return false;
- }
- }
- protected function isRemoteGroupSharingAllowed(string $itemType): bool {
- try {
-
- $backend = Share::getBackend($itemType);
- return $backend->isShareTypeAllowed(IShare::TYPE_REMOTE_GROUP);
- } catch (\Exception $e) {
- return false;
- }
- }
-
- protected function getPaginationLink(int $page, array $params): string {
- if ($this->isV2()) {
- $url = $this->urlGenerator->getAbsoluteURL('/ocs/v2.php/apps/files_sharing/api/v1/sharees') . '?';
- } else {
- $url = $this->urlGenerator->getAbsoluteURL('/ocs/v1.php/apps/files_sharing/api/v1/sharees') . '?';
- }
- $params['page'] = $page + 1;
- return '<' . $url . http_build_query($params) . '>; rel="next"';
- }
-
- protected function isV2(): bool {
- return $this->request->getScriptName() === '/ocs/v2.php';
- }
- }
|