8efdc4aabf
Summary: Ref T7803. Prior to this change sequence, Query classes conflated paging values (the actual thing that goes in a "x > 3" clause) with cursor values (arbitrary identifiers which track where the user is in a result list). Although the two can sometimes be the same, the vast majority of implementations are simpler and better when object IDs are used as cursors and paging values are derived from them. The new stuff handles this in a consistent way, so we're free to separate getPagingValue() from paging. The new method is essentially getResultCursor(). This also implements getPageCursors(), which allows queries to return directional cursors. The inability to do this was a practical limitation blocking the implementation of T7803. Test Plan: - Browsed a bunch of results and paged through queries. - Grepped for removed methods. Reviewers: btrahan Reviewed By: btrahan Subscribers: epriestley Maniphest Tasks: T7803 Differential Revision: https://secure.phabricator.com/D12383
127 lines
3.3 KiB
PHP
127 lines
3.3 KiB
PHP
<?php
|
|
|
|
final class PhabricatorFeedQuery
|
|
extends PhabricatorCursorPagedPolicyAwareQuery {
|
|
|
|
private $filterPHIDs;
|
|
private $chronologicalKeys;
|
|
|
|
public function setFilterPHIDs(array $phids) {
|
|
$this->filterPHIDs = $phids;
|
|
return $this;
|
|
}
|
|
|
|
public function withChronologicalKeys(array $keys) {
|
|
$this->chronologicalKeys = $keys;
|
|
return $this;
|
|
}
|
|
|
|
protected function loadPage() {
|
|
$story_table = new PhabricatorFeedStoryData();
|
|
$conn = $story_table->establishConnection('r');
|
|
|
|
$data = queryfx_all(
|
|
$conn,
|
|
'SELECT story.* FROM %T story %Q %Q %Q %Q %Q',
|
|
$story_table->getTableName(),
|
|
$this->buildJoinClause($conn),
|
|
$this->buildWhereClause($conn),
|
|
$this->buildGroupClause($conn),
|
|
$this->buildOrderClause($conn),
|
|
$this->buildLimitClause($conn));
|
|
|
|
return $data;
|
|
}
|
|
|
|
protected function willFilterPage(array $data) {
|
|
return PhabricatorFeedStory::loadAllFromRows($data, $this->getViewer());
|
|
}
|
|
|
|
private function buildJoinClause(AphrontDatabaseConnection $conn_r) {
|
|
// NOTE: We perform this join unconditionally (even if we have no filter
|
|
// PHIDs) to omit rows which have no story references. These story data
|
|
// rows are notifications or realtime alerts.
|
|
|
|
$ref_table = new PhabricatorFeedStoryReference();
|
|
return qsprintf(
|
|
$conn_r,
|
|
'JOIN %T ref ON ref.chronologicalKey = story.chronologicalKey',
|
|
$ref_table->getTableName());
|
|
}
|
|
|
|
private function buildWhereClause(AphrontDatabaseConnection $conn_r) {
|
|
$where = array();
|
|
|
|
if ($this->filterPHIDs) {
|
|
$where[] = qsprintf(
|
|
$conn_r,
|
|
'ref.objectPHID IN (%Ls)',
|
|
$this->filterPHIDs);
|
|
}
|
|
|
|
if ($this->chronologicalKeys) {
|
|
// NOTE: We want to use integers in the query so we can take advantage
|
|
// of keys, but can't use %d on 32-bit systems. Make sure all the keys
|
|
// are integers and then format them raw.
|
|
|
|
$keys = $this->chronologicalKeys;
|
|
foreach ($keys as $key) {
|
|
if (!ctype_digit($key)) {
|
|
throw new Exception("Key '{$key}' is not a valid chronological key!");
|
|
}
|
|
}
|
|
|
|
$where[] = qsprintf(
|
|
$conn_r,
|
|
'ref.chronologicalKey IN (%Q)',
|
|
implode(', ', $keys));
|
|
}
|
|
|
|
$where[] = $this->buildPagingClause($conn_r);
|
|
|
|
return $this->formatWhereClause($where);
|
|
}
|
|
|
|
private function buildGroupClause(AphrontDatabaseConnection $conn_r) {
|
|
if ($this->filterPHIDs) {
|
|
return qsprintf($conn_r, 'GROUP BY ref.chronologicalKey');
|
|
} else {
|
|
return qsprintf($conn_r, 'GROUP BY story.chronologicalKey');
|
|
}
|
|
}
|
|
|
|
protected function getDefaultOrderVector() {
|
|
return array('key');
|
|
}
|
|
|
|
public function getOrderableColumns() {
|
|
$table = ($this->filterPHIDs ? 'ref' : 'story');
|
|
return array(
|
|
'key' => array(
|
|
'table' => $table,
|
|
'column' => 'chronologicalKey',
|
|
'type' => 'int',
|
|
'unique' => true,
|
|
),
|
|
);
|
|
}
|
|
|
|
protected function getPagingValueMap($cursor, array $keys) {
|
|
return array(
|
|
'key' => $cursor,
|
|
);
|
|
}
|
|
|
|
protected function getResultCursor($item) {
|
|
if ($item instanceof PhabricatorFeedStory) {
|
|
return $item->getChronologicalKey();
|
|
}
|
|
return $item['chronologicalKey'];
|
|
}
|
|
|
|
public function getQueryApplicationClass() {
|
|
return 'PhabricatorFeedApplication';
|
|
}
|
|
|
|
}
|