nextcloud-server/apps/comments/lib/Collaboration/CommentersSorter.php

<?php
/**
 * @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
 *
 * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\Comments\Collaboration;

use OCP\Collaboration\AutoComplete\ISorter;
use OCP\Comments\ICommentsManager;

class CommentersSorter implements ISorter {
	public function __construct(
		private ICommentsManager $commentsManager,
	) {
	}

	public function getId(): string {
		return 'commenters';
	}

	/**
	 * Sorts people who commented on the given item atop (descelating) of the
	 * others
	 *
	 * @param array &$sortArray
	 * @param array $context
	 */
	public function sort(array &$sortArray, array $context): void {
		$commenters = $this->retrieveCommentsInformation($context['itemType'], $context['itemId']);
		if (count($commenters) === 0) {
			return;
		}

		foreach ($sortArray as $type => &$byType) {
			if (!isset($commenters[$type])) {
				continue;
			}

			// at least on PHP 5.6 usort turned out to be not stable. So we add
			// the current index to the value and compare it on a draw
			$i = 0;
			$workArray = array_map(function ($element) use (&$i) {
				return [$i++, $element];
			}, $byType);

			usort($workArray, function ($a, $b) use ($commenters, $type) {
				$r = $this->compare($a[1], $b[1], $commenters[$type]);
				if ($r === 0) {
					$r = $a[0] - $b[0];
				}
				return $r;
			});

			// and remove the index values again
			$byType = array_column($workArray, 1);
		}
	}

	/**
	 * @return array<string, array<string, int>>
	 */
	protected function retrieveCommentsInformation(string $type, string $id): array {
		$comments = $this->commentsManager->getForObject($type, $id);
		if (count($comments) === 0) {
			return [];
		}

		$actors = [];
		foreach ($comments as $comment) {
			if (!isset($actors[$comment->getActorType()])) {
				$actors[$comment->getActorType()] = [];
			}
			if (!isset($actors[$comment->getActorType()][$comment->getActorId()])) {
				$actors[$comment->getActorType()][$comment->getActorId()] = 1;
			} else {
				$actors[$comment->getActorType()][$comment->getActorId()]++;
			}
		}
		return $actors;
	}

	protected function compare(array $a, array $b, array $commenters): int {
		$a = $a['value']['shareWith'];
		$b = $b['value']['shareWith'];

		$valueA = $commenters[$a] ?? 0;
		$valueB = $commenters[$b] ?? 0;

		return $valueB - $valueA;
	}
}