PhabricatorSearchApplicationSearchEngine.php
No OneTemporary
Actions

Size

9 KB

Referenced Files

None

Subscribers

None

PhabricatorSearchApplicationSearchEngine.php
View Options

	<?php

	final class PhabricatorSearchApplicationSearchEngine
	extends PhabricatorApplicationSearchEngine {

	private $resultSet;

	public function getResultTypeDescription() {
	return pht('Fulltext Search Results');
	}

	public function getApplicationClassName() {
	return PhabricatorSearchApplication::class;
	}

	public function buildSavedQueryFromRequest(AphrontRequest $request) {
	$saved = new PhabricatorSavedQuery();

	$saved->setParameter('query', $request->getStr('query'));
	$saved->setParameter(
	'statuses',
	$this->readListFromRequest($request, 'statuses'));
	$saved->setParameter(
	'types',
	$this->readListFromRequest($request, 'types'));

	$saved->setParameter(
	'authorPHIDs',
	$this->readUsersFromRequest($request, 'authorPHIDs'));

	$saved->setParameter(
	'ownerPHIDs',
	$this->readUsersFromRequest($request, 'ownerPHIDs'));

	$saved->setParameter(
	'subscriberPHIDs',
	$this->readSubscribersFromRequest($request, 'subscriberPHIDs'));

	$saved->setParameter(
	'projectPHIDs',
	$this->readPHIDsFromRequest($request, 'projectPHIDs'));

	return $saved;
	}

	public function buildQueryFromSavedQuery(PhabricatorSavedQuery $saved) {
	$query = new PhabricatorSearchDocumentQuery();

	// Convert the saved query into a resolved form (without typeahead
	// functions) which the fulltext search engines can execute.
	$config = clone $saved;
	$viewer = $this->requireViewer();

	$datasource = id(new PhabricatorPeopleOwnerDatasource())
	->setViewer($viewer);
	$owner_phids = $this->readOwnerPHIDs($config);
	$owner_phids = $datasource->evaluateTokens($owner_phids);
	foreach ($owner_phids as $key => $phid) {
	if ($phid == PhabricatorPeopleNoOwnerDatasource::FUNCTION_TOKEN) {
	$config->setParameter('withUnowned', true);
	unset($owner_phids[$key]);
	}
	if ($phid == PhabricatorPeopleAnyOwnerDatasource::FUNCTION_TOKEN) {
	$config->setParameter('withAnyOwner', true);
	unset($owner_phids[$key]);
	}
	}
	$config->setParameter('ownerPHIDs', $owner_phids);


	$datasource = id(new PhabricatorPeopleUserFunctionDatasource())
	->setViewer($viewer);
	$author_phids = $config->getParameter('authorPHIDs', array());
	$author_phids = $datasource->evaluateTokens($author_phids);
	$config->setParameter('authorPHIDs', $author_phids);


	$datasource = id(new PhabricatorMetaMTAMailableFunctionDatasource())
	->setViewer($viewer);
	$subscriber_phids = $config->getParameter('subscriberPHIDs', array());
	$subscriber_phids = $datasource->evaluateTokens($subscriber_phids);
	$config->setParameter('subscriberPHIDs', $subscriber_phids);


	$query->withSavedQuery($config);

	return $query;
	}

	public function buildSearchForm(
	AphrontFormView $form,
	PhabricatorSavedQuery $saved) {

	$options = array();
	$author_value = null;
	$owner_value = null;
	$subscribers_value = null;
	$project_value = null;

	$author_phids = $saved->getParameter('authorPHIDs', array());
	$owner_phids = $this->readOwnerPHIDs($saved);
	$subscriber_phids = $saved->getParameter('subscriberPHIDs', array());
	$project_phids = $saved->getParameter('projectPHIDs', array());

	$status_values = $saved->getParameter('statuses', array());
	$status_values = array_fuse($status_values);

	$statuses = array(
	PhabricatorSearchRelationship::RELATIONSHIP_OPEN => pht('Open'),
	PhabricatorSearchRelationship::RELATIONSHIP_CLOSED => pht('Closed'),
	);
	$status_control = id(new AphrontFormCheckboxControl())
	->setLabel(pht('Document Status'));
	foreach ($statuses as $status => $name) {
	$status_control->addCheckbox(
	'statuses[]',
	$status,
	$name,
	isset($status_values[$status]));
	}

	$type_values = $saved->getParameter('types', array());
	$type_values = array_fuse($type_values);

	$types_control = id(new AphrontFormTokenizerControl())
	->setLabel(pht('Document Types'))
	->setName('types')
	->setDatasource(new PhabricatorSearchDocumentTypeDatasource())
	->setValue($type_values);

	$form
	->appendChild(
	phutil_tag(
	'input',
	array(
	'type' => 'hidden',
	'name' => 'jump',
	'value' => 'no',
	)))
	->appendChild(
	id(new AphrontFormTextControl())
	->setLabel(pht('Query'))
	->setName('query')
	->setValue($saved->getParameter('query')))
	->appendChild($status_control)
	->appendControl($types_control)
	->appendControl(
	id(new AphrontFormTokenizerControl())
	->setName('authorPHIDs')
	->setLabel(pht('Authors'))
	->setDatasource(new PhabricatorPeopleUserFunctionDatasource())
	->setValue($author_phids))
	->appendControl(
	id(new AphrontFormTokenizerControl())
	->setName('ownerPHIDs')
	->setLabel(pht('Owners'))
	->setDatasource(new PhabricatorPeopleOwnerDatasource())
	->setValue($owner_phids))
	->appendControl(
	id(new AphrontFormTokenizerControl())
	->setName('subscriberPHIDs')
	->setLabel(pht('Subscribers'))
	->setDatasource(new PhabricatorMetaMTAMailableFunctionDatasource())
	->setValue($subscriber_phids))
	->appendControl(
	id(new AphrontFormTokenizerControl())
	->setName('projectPHIDs')
	->setLabel(pht('Tags'))
	->setDatasource(new PhabricatorProjectDatasource())
	->setValue($project_phids));
	}

	protected function getURI($path) {
	return '/search/'.$path;
	}

	protected function getBuiltinQueryNames() {
	return array(
	'all' => pht('All Documents'),
	'open' => pht('Open Documents'),
	'open-tasks' => pht('Open Tasks'),
	);
	}

	public function buildSavedQueryFromBuiltin($query_key) {
	$query = $this->newSavedQuery();
	$query->setQueryKey($query_key);

	switch ($query_key) {
	case 'all':
	return $query;
	case 'open':
	return $query->setParameter('statuses', array('open'));
	case 'open-tasks':
	return $query
	->setParameter('statuses', array('open'))
	->setParameter('types', array(ManiphestTaskPHIDType::TYPECONST));
	}

	return parent::buildSavedQueryFromBuiltin($query_key);
	}

	public static function getIndexableDocumentTypes(
	?PhabricatorUser $viewer = null) {

	// TODO: This is inelegant and not very efficient, but gets us reasonable
	// results. It would be nice to do this more elegantly.

	$objects = id(new PhutilClassMapQuery())
	->setAncestorClass('PhabricatorFulltextInterface')
	->execute();

	$type_map = array();
	foreach ($objects as $object) {
	$phid_type = phid_get_type($object->generatePHID());
	$type_map[$phid_type] = $object;
	}

	if ($viewer) {
	$types = PhabricatorPHIDType::getAllInstalledTypes($viewer);
	} else {
	$types = PhabricatorPHIDType::getAllTypes();
	}

	$results = array();
	foreach ($types as $type) {
	$typeconst = $type->getTypeConstant();
	$object = idx($type_map, $typeconst);
	if ($object) {
	$results[$typeconst] = $type->getTypeName();
	}
	}

	asort($results);

	return $results;
	}

	public function shouldUseOffsetPaging() {
	return true;
	}

	protected function renderResultList(
	array $results,
	PhabricatorSavedQuery $query,
	array $handles) {

	$result_set = $this->resultSet;
	$fulltext_tokens = $result_set->getFulltextTokens();

	$viewer = $this->requireViewer();
	$list = new PHUIObjectItemListView();
	$list->setNoDataString(pht('No results found.'));

	if ($results) {
	$objects = id(new PhabricatorObjectQuery())
	->setViewer($viewer)
	->withPHIDs(mpull($results, 'getPHID'))
	->execute();

	foreach ($results as $phid => $handle) {
	$view = id(new PhabricatorSearchResultView())
	->setHandle($handle)
	->setTokens($fulltext_tokens)
	->setObject(idx($objects, $phid))
	->render();
	$list->addItem($view);
	}
	}

	$fulltext_view = null;
	if ($fulltext_tokens) {
	require_celerity_resource('phabricator-search-results-css');

	$fulltext_view = array();
	foreach ($fulltext_tokens as $token) {
	$fulltext_view[] = $token->newTag();
	}
	$fulltext_view = phutil_tag(
	'div',
	array(
	'class' => 'phui-fulltext-tokens',
	),
	array(
	pht('Searched For:'),
	' ',
	$fulltext_view,
	));
	}

	$result = new PhabricatorApplicationSearchResultView();
	$result->setContent($fulltext_view);
	$result->setObjectList($list);

	return $result;
	}

	private function readOwnerPHIDs(PhabricatorSavedQuery $saved) {
	$owner_phids = $saved->getParameter('ownerPHIDs', array());

	// This was an old checkbox from before typeahead functions.
	if ($saved->getParameter('withUnowned')) {
	$owner_phids[] = PhabricatorPeopleNoOwnerDatasource::FUNCTION_TOKEN;
	}

	return $owner_phids;
	}

	protected function didExecuteQuery(PhabricatorPolicyAwareQuery $query) {
	$this->resultSet = $query->getFulltextResultSet();
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Tue, May 13, 1:05 PM (2 d)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 124259
Default Alt Text: PhabricatorSearchApplicationSearchEngine.php (9 KB)

PhabricatorSearchApplicationSearchEngine.phpNo OneTemporaryActions

PhabricatorSearchApplicationSearchEngine.phpView Options

File Metadata

Event Timeline

PhabricatorSearchApplicationSearchEngine.php
No OneTemporary
Actions

PhabricatorSearchApplicationSearchEngine.php
View Options