From 1817f929c2e1a24bb12250ef9795250aa41150d4 Mon Sep 17 00:00:00 2001
From: vrana <jakubv@fb.com>
Date: Fri, 22 Jun 2012 23:08:25 -0700
Subject: [PATCH] Introduce `arc inlines`

Summary: This displays all inline comments attached to a revision in a format consumable by editors.

Test Plan: Ran it, opened the file on the line.

Reviewers: epriestley

Reviewed By: epriestley

CC: vii, aran, Korvin

Differential Revision: https://secure.phabricator.com/D2845
---
 src/__phutil_library_map__.php           |   2 +
 src/workflow/ArcanistInlinesWorkflow.php | 112 +++++++++++++++++++++++
 2 files changed, 114 insertions(+)
 create mode 100644 src/workflow/ArcanistInlinesWorkflow.php

diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index 00688167..1250ef8d 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -59,6 +59,7 @@ phutil_register_library_map(array(
     'ArcanistHgProxyServer' => 'hgdaemon/ArcanistHgProxyServer.php',
     'ArcanistHgServerChannel' => 'hgdaemon/ArcanistHgServerChannel.php',
     'ArcanistHookAPI' => 'repository/hookapi/ArcanistHookAPI.php',
+    'ArcanistInlinesWorkflow' => 'workflow/ArcanistInlinesWorkflow.php',
     'ArcanistInstallCertificateWorkflow' => 'workflow/ArcanistInstallCertificateWorkflow.php',
     'ArcanistJSHintLinter' => 'lint/linter/ArcanistJSHintLinter.php',
     'ArcanistLandWorkflow' => 'workflow/ArcanistLandWorkflow.php',
@@ -174,6 +175,7 @@ phutil_register_library_map(array(
     'ArcanistHelpWorkflow' => 'ArcanistBaseWorkflow',
     'ArcanistHgClientChannel' => 'PhutilProtocolChannel',
     'ArcanistHgServerChannel' => 'PhutilProtocolChannel',
+    'ArcanistInlinesWorkflow' => 'ArcanistBaseWorkflow',
     'ArcanistInstallCertificateWorkflow' => 'ArcanistBaseWorkflow',
     'ArcanistJSHintLinter' => 'ArcanistLinter',
     'ArcanistLandWorkflow' => 'ArcanistBaseWorkflow',
diff --git a/src/workflow/ArcanistInlinesWorkflow.php b/src/workflow/ArcanistInlinesWorkflow.php
new file mode 100644
index 00000000..771d778e
--- /dev/null
+++ b/src/workflow/ArcanistInlinesWorkflow.php
@@ -0,0 +1,112 @@
+<?php
+
+/*
+ * Copyright 2012 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @group workflow
+ */
+final class ArcanistInlinesWorkflow extends ArcanistBaseWorkflow {
+
+  public function getCommandSynopses() {
+    return phutil_console_format(<<<EOTEXT
+      **inlines** [--revision __revision_id__]
+EOTEXT
+      );
+  }
+
+  public function getCommandHelp() {
+    return phutil_console_format(<<<EOTEXT
+          Display inline comments related to a particular revision.
+EOTEXT
+      );
+  }
+
+  public function getArguments() {
+    return array(
+      'revision' => array(
+        'param' => 'revision_id',
+        'help' =>
+          "Display inline comments for a specific revision. If you do not ".
+          "specify a revision, arc will look in the commit message at HEAD.",
+      ),
+    );
+  }
+
+  public function requiresConduit() {
+    return true;
+  }
+
+  public function requiresAuthentication() {
+    return true;
+  }
+
+  public function requiresRepositoryAPI() {
+    return true;
+  }
+
+  public function run() {
+    if ($this->getArgument('revision')) {
+      $revision_id = $this->normalizeRevisionID($this->getArgument('revision'));
+    } else {
+      $revisions = $this->getRepositoryAPI()
+        ->loadWorkingCopyDifferentialRevisions($this->getConduit(), array());
+      $revision_id = head(ipull($revisions, 'id'));
+    }
+
+    if (!$revision_id) {
+      throw new ArcanistUsageException("No revisions found.");
+    }
+
+    $comments = array_mergev(
+      $this->getConduit()->callMethodSynchronous(
+        'differential.getrevisioncomments',
+        array(
+          'ids' => array($revision_id),
+          'inlines' => true,
+        )));
+
+    $authors = array();
+    if ($comments) {
+      $authors = $this->getConduit()->callMethodSynchronous(
+        'user.query',
+        array(
+          'phids' => array_unique(ipull($comments, 'authorPHID')),
+        ));
+      $authors = ipull($authors, 'userName', 'phid');
+    }
+
+    $inlines = array();
+    foreach ($comments as $comment) {
+      $author = idx($authors, $comment['authorPHID']);
+      foreach ($comment['inlines'] as $inline) {
+        $file = $inline['filePath'];
+        $line = $inline['lineNumber'];
+        $inlines[$file][$line][] = "({$author}) {$inline['content']}";
+      }
+    }
+
+    ksort($inlines);
+    foreach ($inlines as $file => $file_inlines) {
+      ksort($file_inlines);
+      foreach ($file_inlines as $line => $line_inlines) {
+        foreach ($line_inlines as $content) {
+          echo "{$file}:{$line}:{$content}\n";
+        }
+      }
+    }
+  }
+}