2012-06-08 15:31:30 +02:00
|
|
|
<?php
|
|
|
|
|
2012-06-28 22:59:50 +02:00
|
|
|
/**
|
|
|
|
* @task config Configuring the Query
|
|
|
|
* @task exec Query Execution
|
|
|
|
*/
|
2012-10-23 21:01:59 +02:00
|
|
|
final class PhabricatorNotificationQuery
|
|
|
|
extends PhabricatorCursorPagedPolicyAwareQuery {
|
2012-06-08 15:31:30 +02:00
|
|
|
|
2014-08-16 20:14:32 +02:00
|
|
|
private $userPHIDs;
|
2012-06-18 23:08:10 +02:00
|
|
|
private $keys;
|
2012-06-28 22:59:50 +02:00
|
|
|
private $unread;
|
|
|
|
|
|
|
|
|
|
|
|
/* -( Configuring the Query )---------------------------------------------- */
|
|
|
|
|
2012-06-08 15:31:30 +02:00
|
|
|
|
2014-08-16 20:14:32 +02:00
|
|
|
public function withUserPHIDs(array $user_phids) {
|
|
|
|
$this->userPHIDs = $user_phids;
|
2012-06-08 15:31:30 +02:00
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2012-06-18 23:08:10 +02:00
|
|
|
public function withKeys(array $keys) {
|
|
|
|
$this->keys = $keys;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2012-06-28 22:59:50 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Filter results by read/unread status. Note that `true` means to return
|
|
|
|
* only unread notifications, while `false` means to return only //read//
|
|
|
|
* notifications. The default is `null`, which returns both.
|
|
|
|
*
|
|
|
|
* @param mixed True or false to filter results by read status. Null to remove
|
|
|
|
* the filter.
|
|
|
|
* @return this
|
|
|
|
* @task config
|
|
|
|
*/
|
|
|
|
public function withUnread($unread) {
|
|
|
|
$this->unread = $unread;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/* -( Query Execution )---------------------------------------------------- */
|
|
|
|
|
|
|
|
|
2013-03-01 20:28:02 +01:00
|
|
|
protected function loadPage() {
|
2012-06-08 15:31:30 +02:00
|
|
|
$story_table = new PhabricatorFeedStoryData();
|
|
|
|
$notification_table = new PhabricatorFeedStoryNotification();
|
|
|
|
|
|
|
|
$conn = $story_table->establishConnection('r');
|
|
|
|
|
|
|
|
$data = queryfx_all(
|
|
|
|
$conn,
|
2014-06-09 20:36:49 +02:00
|
|
|
'SELECT story.*, notif.hasViewed FROM %T notif
|
2012-06-08 15:31:30 +02:00
|
|
|
JOIN %T story ON notif.chronologicalKey = story.chronologicalKey
|
2012-06-18 23:08:10 +02:00
|
|
|
%Q
|
2012-06-18 23:07:38 +02:00
|
|
|
ORDER BY notif.chronologicalKey DESC
|
2014-06-09 20:36:49 +02:00
|
|
|
%Q',
|
2012-06-08 15:31:30 +02:00
|
|
|
$notification_table->getTableName(),
|
|
|
|
$story_table->getTableName(),
|
2012-06-18 23:08:10 +02:00
|
|
|
$this->buildWhereClause($conn),
|
2012-06-18 23:07:38 +02:00
|
|
|
$this->buildLimitClause($conn));
|
2012-06-08 15:31:30 +02:00
|
|
|
|
|
|
|
$viewed_map = ipull($data, 'hasViewed', 'chronologicalKey');
|
2012-06-18 23:08:10 +02:00
|
|
|
|
2012-10-23 21:01:59 +02:00
|
|
|
$stories = PhabricatorFeedStory::loadAllFromRows(
|
|
|
|
$data,
|
|
|
|
$this->getViewer());
|
|
|
|
|
2012-07-02 19:37:22 +02:00
|
|
|
foreach ($stories as $key => $story) {
|
|
|
|
$story->setHasViewed($viewed_map[$key]);
|
2012-06-08 15:31:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return $stories;
|
|
|
|
}
|
2012-06-18 23:08:10 +02:00
|
|
|
|
Make buildWhereClause() a method of AphrontCursorPagedPolicyAwareQuery
Summary:
Ref T4100. Ref T5595.
To support a unified "Projects:" query across all applications, a future diff is going to add a set of "Edge Logic" capabilities to `PolicyAwareQuery` which write the required SELECT, JOIN, WHERE, HAVING and GROUP clauses for you.
With the addition of "Edge Logic", we'll have three systems which may need to build components of query claues: ordering/paging, customfields/applicationsearch, and edge logic.
For most clauses, queries don't currently call into the parent explicitly to get default components. I want to move more query construction logic up the class tree so it can be shared.
For most methods, this isn't a problem, but many subclasses define a `buildWhereClause()`. Make all such definitions protected and consistent.
This causes no behavioral changes.
Test Plan: Ran `arc unit --everything`, which does a pretty through job of verifying this statically.
Reviewers: btrahan
Reviewed By: btrahan
Subscribers: yelirekim, hach-que, epriestley
Maniphest Tasks: T4100, T5595
Differential Revision: https://secure.phabricator.com/D12453
2015-04-18 16:08:30 +02:00
|
|
|
protected function buildWhereClause(AphrontDatabaseConnection $conn_r) {
|
2012-06-18 23:08:10 +02:00
|
|
|
$where = array();
|
|
|
|
|
2014-08-16 20:14:32 +02:00
|
|
|
if ($this->userPHIDs !== null) {
|
2012-06-18 23:08:10 +02:00
|
|
|
$where[] = qsprintf(
|
|
|
|
$conn_r,
|
2014-08-16 20:14:32 +02:00
|
|
|
'notif.userPHID IN (%Ls)',
|
|
|
|
$this->userPHIDs);
|
2012-06-18 23:08:10 +02:00
|
|
|
}
|
|
|
|
|
2012-06-28 22:59:50 +02:00
|
|
|
if ($this->unread !== null) {
|
|
|
|
$where[] = qsprintf(
|
|
|
|
$conn_r,
|
|
|
|
'notif.hasViewed = %d',
|
|
|
|
(int)!$this->unread);
|
|
|
|
}
|
|
|
|
|
2012-06-18 23:08:10 +02:00
|
|
|
if ($this->keys) {
|
|
|
|
$where[] = qsprintf(
|
|
|
|
$conn_r,
|
|
|
|
'notif.chronologicalKey IN (%Ls)',
|
|
|
|
$this->keys);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->formatWhereClause($where);
|
|
|
|
}
|
|
|
|
|
2015-04-13 01:44:15 +02:00
|
|
|
protected function getResultCursor($item) {
|
2013-10-05 04:57:15 +02:00
|
|
|
return $item->getChronologicalKey();
|
|
|
|
}
|
|
|
|
|
Lock policy queries to their applications
Summary:
While we mostly have reasonable effective object accessibility when you lock a user out of an application, it's primarily enforced at the controller level. Users can still, e.g., load the handles of objects they can't actually see. Instead, lock the queries to the applications so that you can, e.g., never load a revision if you don't have access to Differential.
This has several parts:
- For PolicyAware queries, provide an application class name method.
- If the query specifies a class name and the user doesn't have permission to use it, fail the entire query unconditionally.
- For handles, simplify query construction and count all the PHIDs as "restricted" so we get a UI full of "restricted" instead of "unknown" handles.
Test Plan:
- Added a unit test to verify I got all the class names right.
- Browsed around, logged in/out as a normal user with public policies on and off.
- Browsed around, logged in/out as a restricted user with public policies on and off. With restrictions, saw all traces of restricted apps removed or restricted.
Reviewers: btrahan
Reviewed By: btrahan
CC: aran
Differential Revision: https://secure.phabricator.com/D7367
2013-10-22 02:20:27 +02:00
|
|
|
public function getQueryApplicationClass() {
|
2014-07-23 02:03:09 +02:00
|
|
|
return 'PhabricatorNotificationsApplication';
|
Lock policy queries to their applications
Summary:
While we mostly have reasonable effective object accessibility when you lock a user out of an application, it's primarily enforced at the controller level. Users can still, e.g., load the handles of objects they can't actually see. Instead, lock the queries to the applications so that you can, e.g., never load a revision if you don't have access to Differential.
This has several parts:
- For PolicyAware queries, provide an application class name method.
- If the query specifies a class name and the user doesn't have permission to use it, fail the entire query unconditionally.
- For handles, simplify query construction and count all the PHIDs as "restricted" so we get a UI full of "restricted" instead of "unknown" handles.
Test Plan:
- Added a unit test to verify I got all the class names right.
- Browsed around, logged in/out as a normal user with public policies on and off.
- Browsed around, logged in/out as a restricted user with public policies on and off. With restrictions, saw all traces of restricted apps removed or restricted.
Reviewers: btrahan
Reviewed By: btrahan
CC: aran
Differential Revision: https://secure.phabricator.com/D7367
2013-10-22 02:20:27 +02:00
|
|
|
}
|
|
|
|
|
2012-06-08 15:31:30 +02:00
|
|
|
}
|