owncloud / music

lib/Search/Provider.php

<?php declare(strict_types=1);

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Leizh <leizh@free.fr>
 * @author Pauli Järvinen <pauli.jarvinen@gmail.com>
 * @copyright Morris Jobke 2013, 2014
 * @copyright Leizh 2014
 * @copyright Pauli Järvinen 2018 - 2025
 */

namespace OCA\Music\Search;

use OCA\Music\AppFramework\Core\Logger;
use OCA\Music\AppInfo\Application;
use OCA\Music\Db\AlbumMapper;
use OCA\Music\Db\ArtistMapper;
use OCA\Music\Db\Entity;
use OCA\Music\Db\MatchMode;
use OCA\Music\Db\TrackMapper;

use OCP\IL10N;
use OCP\IURLGenerator;

class Provider extends \OCP\Search\Provider {

The class OCP\Search\Provider has been deprecated: 20.0.0

	/* Limit the maximum number of matches because the Provider API is limited and does
	 * not support pagination. The core paginates the results to 30 item pages, but it
	 * obtains all the items from the Providers again on creation of each page.
	 * If there were thousands of matches, we would end up doing lot of unnecessary work.
	 */
	const MAX_RESULTS_PER_TYPE = 100;

	private ArtistMapper $artistMapper;
	private AlbumMapper $albumMapper;
	private TrackMapper $trackMapper;
	private IURLGenerator $urlGenerator;
	private string $userId;
	private IL10N $l10n;
	private array $resultTypeNames;
	private array $resultTypePaths;
	private Logger $logger;

	public function __construct() {
		$app = \OC::$server->query(Application::class);
		$c = $app->getContainer();

		$this->artistMapper = $c->query(ArtistMapper::class);
		$this->albumMapper = $c->query(AlbumMapper::class);
		$this->trackMapper = $c->query(TrackMapper::class);
		$this->urlGenerator = $c->query(IURLGenerator::class);
		$this->userId = $c->query('userId');
		$this->l10n = $c->query(IL10N::class);
		$this->logger = $c->query(Logger::class);

		$this->resultTypeNames = [
			'music_artist' => $this->l10n->t('Artist'),
			'music_album' => $this->l10n->t('Album'),
			'music_track' => $this->l10n->t('Track')
		];

		$basePath = $this->urlGenerator->linkToRoute('music.page.index');
		$this->resultTypePaths = [
			'music_artist' => $basePath . "#/artist/",
			'music_album' => $basePath . "#/album/",
			'music_track' => $basePath . "#/track/"
		];
	}

	private function createResult(Entity $entity, string $type) : Result {
		$link = $this->resultTypePaths[$type] . $entity->id;
		$titlePrefix = $this->l10n->t('Music') . ' - ' . $this->resultTypeNames[$type] . ': ';
		$title = $entity->getNameString($this->l10n);
		return new Result($entity->id, $titlePrefix . $title, $link, $type);
	}

	public function search($query) {
		$results = [];

		$artists = $this->artistMapper->findAllByName($query, $this->userId, MatchMode::Substring, self::MAX_RESULTS_PER_TYPE);
		foreach ($artists as $artist) {
			$results[] = $this->createResult($artist, 'music_artist');
		}

		$albums = $this->albumMapper->findAllByName($query, $this->userId, MatchMode::Substring, self::MAX_RESULTS_PER_TYPE);
		foreach ($albums as $album) {
			$results[] = $this->createResult($album, 'music_album');
		}

		$tracks = $this->trackMapper->findAllByName($query, $this->userId, MatchMode::Substring, self::MAX_RESULTS_PER_TYPE);
		foreach ($tracks as $track) {
			$results[] = $this->createResult($track, 'music_track');
		}

		return $results;
	}
}