Replace "loadDraftAndPublishedComments()" with a Query

Summary: Ref T13513. Continue marching toward coherent query pathways for all access to inline comments.

Test Plan:
  - Viewed a commit and a path within that commit, as a user with unpublished inlines and a different user.
  - Saw appropriate inlines in all cases (published inlines, plus undeleted unpublished inlines authored by the current viewer).
  - Grepped for "loadDraftAndPublishedComments()".

Maniphest Tasks: T13513

Differential Revision: https://secure.phabricator.com/D21228

Author: epriestley

src/applications/audit/storage/PhabricatorAuditInlineComment.php

@@ -89,29 +89,6 @@ public static function loadPublishedComments(
     return self::buildProxies($inlines);
   }
 
-  public static function loadDraftAndPublishedComments(
-    PhabricatorUser $viewer,
-    $commit_phid,
-    $path_id = null) {
-
-    if ($path_id === null) {
-      $inlines = id(new PhabricatorAuditTransactionComment())->loadAllWhere(
-        'commitPHID = %s AND (transactionPHID IS NOT NULL OR authorPHID = %s)
-          AND pathID IS NOT NULL',
-        $commit_phid,
-        $viewer->getPHID());
-    } else {
-      $inlines = id(new PhabricatorAuditTransactionComment())->loadAllWhere(
-        'commitPHID = %s AND pathID = %d AND
-          ((authorPHID = %s AND isDeleted = 0) OR transactionPHID IS NOT NULL)',
-        $commit_phid,
-        $path_id,
-        $viewer->getPHID());
-    }
-
-    return self::buildProxies($inlines);
-  }
-
   private static function buildProxies(array $inlines) {
     $results = array();
     foreach ($inlines as $key => $inline) {

src/applications/diffusion/controller/DiffusionCommitController.php

@@ -414,9 +414,14 @@ public function handleRequest(AphrontRequest $request) {
         $visible_changesets = $changesets;
       } else {
         $visible_changesets = array();
-        $inlines = PhabricatorAuditInlineComment::loadDraftAndPublishedComments(
-          $viewer,
-          $commit->getPHID());
+
+        $inlines = id(new DiffusionDiffInlineCommentQuery())
+          ->setViewer($viewer)
+          ->withCommitPHIDs(array($commit->getPHID()))
+          ->withVisibleComments(true)
+          ->execute();
+        $inlines = mpull($inlines, 'newInlineCommentObject');
+
         $path_ids = mpull($inlines, null, 'getPathID');
         foreach ($changesets as $key => $changeset) {
           if (array_key_exists($changeset->getID(), $path_ids)) {

src/applications/diffusion/controller/DiffusionDiffController.php

@@ -99,10 +99,13 @@ public function handleRequest(AphrontRequest $request) {
       ($viewer->getPHID() == $commit->getAuthorPHID()));
     $parser->setObjectOwnerPHID($commit->getAuthorPHID());
 
-    $inlines = PhabricatorAuditInlineComment::loadDraftAndPublishedComments(
-      $viewer,
-      $commit->getPHID(),
-      $path_id);
+    $inlines = id(new DiffusionDiffInlineCommentQuery())
+      ->setViewer($viewer)
+      ->withCommitPHIDs(array($commit->getPHID()))
+      ->withPathIDs(array($path_id))
+      ->withVisibleComments(true)
+      ->execute();
+    $inlines = mpull($inlines, 'newInlineCommentObject');
 
     if ($inlines) {
       foreach ($inlines as $inline) {

src/infrastructure/diff/query/PhabricatorDiffInlineCommentQuery.php

@@ -5,6 +5,8 @@ abstract class PhabricatorDiffInlineCommentQuery
 
   private $fixedStates;
   private $needReplyToComments;
+  private $visibleComments;
+  private $publishableComments;
 
   abstract protected function buildInlineCommentWhereClauseParts(
     AphrontDatabaseConnection $conn);
@@ -20,6 +22,16 @@ public function needReplyToComments($need_reply_to) {
     return $this;
   }
 
+  public function withVisibleComments($with_visible) {
+    $this->visibleComments = $with_visible;
+    return $this;
+  }
+
+  public function withPublishableComments($with_publishable) {
+    $this->publishableComments = $with_publishable;
+    return $this;
+  }
+
   protected function buildWhereClauseParts(AphrontDatabaseConnection $conn) {
     $where = parent::buildWhereClauseParts($conn);
     $alias = $this->getPrimaryTableAlias();
@@ -36,6 +48,72 @@ protected function buildWhereClauseParts(AphrontDatabaseConnection $conn) {
         $this->fixedStates);
     }
 
+    $show_published = false;
+    $show_publishable = false;
+
+    if ($this->visibleComments !== null) {
+      if (!$this->visibleComments) {
+        throw new Exception(
+          pht(
+            'Querying for comments that are not visible is '.
+            'not supported.'));
+      }
+      $show_published = true;
+      $show_publishable = true;
+    }
+
+    if ($this->publishableComments !== null) {
+      if (!$this->publishableComments) {
+        throw new Exception(
+          pht(
+            'Querying for comments that are not publishable is '.
+            'not supported.'));
+      }
+      $show_publishable = true;
+    }
+
+    if ($show_publishable || $show_published) {
+      $clauses = array();
+
+      if ($show_published) {
+        // Published comments are always visible.
+        $clauses[] = qsprintf(
+          $conn,
+          '%T.transactionPHID IS NOT NULL',
+          $alias);
+      }
+
+      if ($show_publishable) {
+        $viewer = $this->getViewer();
+        $viewer_phid = $viewer->getPHID();
+
+        // If the viewer has a PHID, unpublished comments they authored and
+        // have not deleted are visible.
+        if ($viewer_phid) {
+          $clauses[] = qsprintf(
+            $conn,
+            '%T.authorPHID = %s
+              AND %T.isDeleted = 0
+              AND %T.transactionPHID IS NULL ',
+            $alias,
+            $viewer_phid,
+            $alias,
+            $alias);
+        }
+      }
+
+      // We can end up with a known-empty query if we (for example) query for
+      // publishable comments and the viewer is logged-out.
+      if (!$clauses) {
+        throw new PhabricatorEmptyQueryException();
+      }
+
+      $where[] = qsprintf(
+        $conn,
+        '%LO',
+        $clauses);
+    }
+
     return $where;
   }