Add inline comments to Diffusion/Audit

Summary:
  - Add inline comments to Audits, like Differential.
  - Creates new storage for the comments in the Audits database.
  - Creates a new PhabricatorAuditInlineComment class, similar to DifferentialInlineComment.
  - Defines an Interface which Differential and Audit comments conform to.
  - Makes consumers of DifferentialInlineComments consume objects which implement that interface instead.
  - Adds save

NOTE: Some features are still missing! Wanted to cut this off before it got crazy:

  - Inline comments aren't shown in the main comment list.
  - Inline comments aren't shown in the emails.
  - Inline comments aren't previewed.

I'll followup with those but this was getting pretty big.

@vrana, does the SQL change look correct?

Test Plan:
  - Created, edited, deleted, replied to, reloaded and saved inline comments in Diffusion, on the left and right side of diffs.
  - Created, edited, deleted, replied to, reloaded and saved inline comments in Differentila, on the left and right side of primary and diff-versus-diff diffs.

Reviewers: btrahan, vrana

Reviewed By: btrahan

CC: aran, epriestley

Maniphest Tasks: T904

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

src/infrastructure/diff/controller/PhabricatorInlineCommentController.php

@@ -0,0 +1,257 @@
+<?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.
+ */
+
+abstract class PhabricatorInlineCommentController
+  extends PhabricatorController {
+
+  abstract protected function createComment();
+  abstract protected function loadComment($id);
+  abstract protected function loadCommentForEdit($id);
+
+  private $changesetID;
+  private $isNewFile;
+  private $isOnRight;
+  private $lineNumber;
+  private $lineLength;
+  private $commentText;
+  private $operation;
+  private $commentID;
+
+  public function getCommentID() {
+    return $this->commentID;
+  }
+
+  public function getOperation() {
+    return $this->operation;
+  }
+
+  public function getCommentText() {
+    return $this->commentText;
+  }
+
+  public function getLineLength() {
+    return $this->lineLength;
+  }
+
+  public function getLineNumber() {
+    return $this->lineNumber;
+  }
+
+  public function getIsOnRight() {
+    return $this->isOnRight;
+  }
+
+  public function getChangesetID() {
+    return $this->changesetID;
+  }
+
+  public function getIsNewFile() {
+    return $this->isNewFile;
+  }
+
+
+  public function processRequest() {
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    $this->readRequestParameters();
+
+    switch ($this->getOperation()) {
+      case 'delete':
+        $inline = $this->loadCommentForEdit($this->getCommentID());
+
+        if ($request->isFormPost()) {
+          $inline->delete();
+          return $this->buildEmptyResponse();
+        }
+
+        $dialog = new AphrontDialogView();
+        $dialog->setUser($user);
+        $dialog->setSubmitURI($request->getRequestURI());
+
+        $dialog->setTitle('Really delete this comment?');
+        $dialog->addHiddenInput('id', $this->getCommentID());
+        $dialog->addHiddenInput('op', 'delete');
+        $dialog->appendChild('<p>Delete this inline comment?</p>');
+
+        $dialog->addCancelButton('#');
+        $dialog->addSubmitButton('Delete');
+
+        return id(new AphrontDialogResponse())->setDialog($dialog);
+      case 'edit':
+        $inline = $this->loadCommentForEdit($this->getCommentID());
+
+        $text = $this->getCommentText();
+
+        if ($request->isFormPost()) {
+          if (strlen($text)) {
+            $inline->setContent($text);
+            $inline->save();
+            return $this->buildRenderedCommentResponse(
+              $inline,
+              $this->getIsOnRight());
+          } else {
+            $inline->delete();
+            return $this->buildEmptyResponse();
+          }
+        }
+
+        $edit_dialog = $this->buildEditDialog();
+        $edit_dialog->setTitle('Edit Inline Comment');
+
+        $edit_dialog->addHiddenInput('id', $this->getCommentID());
+        $edit_dialog->addHiddenInput('op', 'edit');
+
+        $edit_dialog->appendChild(
+          $this->renderTextArea(
+            nonempty($text, $inline->getContent())));
+
+        return id(new AphrontAjaxResponse())
+          ->setContent($edit_dialog->render());
+      case 'create':
+
+        $text = $this->getCommentText();
+
+        if (!$request->isFormPost() || !strlen($text)) {
+          return $this->buildEmptyResponse();
+        }
+
+        $inline = $this->createComment()
+          ->setChangesetID($this->getChangesetID())
+          ->setAuthorPHID($user->getPHID())
+          ->setLineNumber($this->getLineNumber())
+          ->setLineLength($this->getLineLength())
+          ->setIsNewFile($this->getIsNewFile())
+          ->setContent($text)
+          ->save();
+
+        return $this->buildRenderedCommentResponse(
+          $inline,
+          $this->getIsOnRight());
+      case 'reply':
+      default:
+        $edit_dialog = $this->buildEditDialog();
+
+        if ($this->getOperation() == 'reply') {
+          $inline = $this->loadComment($this->getCommentID());
+
+          $edit_dialog->setTitle('Reply to Inline Comment');
+          $changeset = $inline->getChangesetID();
+          $is_new = $inline->getIsNewFile();
+          $number = $inline->getLineNumber();
+          $length = $inline->getLineLength();
+        } else {
+          $edit_dialog->setTitle('New Inline Comment');
+          $changeset = $this->getChangesetID();
+          $is_new = $this->getIsNewFile();
+          $number = $this->getLineNumber();
+          $length = $this->getLineLength();
+        }
+
+        $edit_dialog->addHiddenInput('op', 'create');
+        $edit_dialog->addHiddenInput('changeset', $changeset);
+        $edit_dialog->addHiddenInput('is_new', $is_new);
+        $edit_dialog->addHiddenInput('number', $number);
+        $edit_dialog->addHiddenInput('length', $length);
+
+        $text_area = $this->renderTextArea($this->getCommentText());
+        $edit_dialog->appendChild($text_area);
+
+        return id(new AphrontAjaxResponse())
+          ->setContent($edit_dialog->render());
+    }
+  }
+
+  private function readRequestParameters() {
+    $request = $this->getRequest();
+
+    // NOTE: This isn't necessarily a DifferentialChangeset ID, just an
+    // application identifier for the changeset. In Diffusion, it's a Path ID.
+    $this->changesetID    = $request->getInt('changeset');
+
+    $this->isNewFile      = $request->getBool('is_new');
+    $this->isOnRight      = $request->getBool('on_right');
+    $this->lineNumber     = $request->getInt('number');
+    $this->lineLength     = $request->getInt('length');
+    $this->commentText    = $request->getStr('text');
+    $this->commentID      = $request->getInt('id');
+    $this->operation      = $request->getStr('op');
+  }
+
+  private function buildEditDialog() {
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    $edit_dialog = new DifferentialInlineCommentEditView();
+    $edit_dialog->setUser($user);
+    $edit_dialog->setSubmitURI($request->getRequestURI());
+    $edit_dialog->setOnRight($this->getIsOnRight());
+
+    return $edit_dialog;
+  }
+
+  private function buildEmptyResponse() {
+    return id(new AphrontAjaxResponse())
+      ->setContent(
+        array(
+          'markup'          => '',
+        ));
+  }
+
+  private function buildRenderedCommentResponse(
+    PhabricatorInlineCommentInterface $inline,
+    $on_right) {
+
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    $engine = PhabricatorMarkupEngine::newDifferentialMarkupEngine();
+
+    $phids = array($user->getPHID());
+
+    $handles = id(new PhabricatorObjectHandleData($phids))
+      ->loadHandles();
+
+    $view = new DifferentialInlineCommentView();
+    $view->setInlineComment($inline);
+    $view->setOnRight($on_right);
+    $view->setBuildScaffolding(true);
+    $view->setMarkupEngine($engine);
+    $view->setHandles($handles);
+    $view->setEditable(true);
+
+    return id(new AphrontAjaxResponse())
+      ->setContent(
+        array(
+          'inlineCommentID' => $inline->getID(),
+          'markup'          => $view->render(),
+        ));
+  }
+
+  private function renderTextArea($text) {
+    return javelin_render_tag(
+      'textarea',
+      array(
+        'class' => 'differential-inline-comment-edit-textarea',
+        'sigil' => 'differential-inline-comment-edit-textarea',
+        'name' => 'text',
+      ),
+      phutil_escape_html($text));
+  }
+
+}

src/infrastructure/diff/controller/__init__.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * This file is automatically generated. Lint this module to rebuild it.
+ * @generated
+ */
+
+
+
+phutil_require_module('phabricator', 'aphront/response/ajax');
+phutil_require_module('phabricator', 'aphront/response/dialog');
+phutil_require_module('phabricator', 'applications/base/controller/base');
+phutil_require_module('phabricator', 'applications/differential/view/inlinecomment');
+phutil_require_module('phabricator', 'applications/differential/view/inlinecommentedit');
+phutil_require_module('phabricator', 'applications/markup/engine');
+phutil_require_module('phabricator', 'applications/phid/handle/data');
+phutil_require_module('phabricator', 'infrastructure/javelin/markup');
+phutil_require_module('phabricator', 'view/dialog');
+
+phutil_require_module('phutil', 'markup');
+phutil_require_module('phutil', 'utils');
+
+
+phutil_require_source('PhabricatorInlineCommentController.php');

src/infrastructure/diff/interface/inline/PhabricatorInlineCommentInterface.php

@@ -0,0 +1,54 @@
+<?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.
+ */
+
+/**
+ * Shared interface used by Differential and Diffusion inline comments.
+ */
+interface PhabricatorInlineCommentInterface {
+
+  public function setChangesetID($id);
+  public function getChangesetID();
+
+  public function setIsNewFile($is_new);
+  public function getIsNewFile();
+
+  public function setLineNumber($number);
+  public function getLineNumber();
+
+  public function setLineLength($length);
+  public function getLineLength();
+
+  public function setContent($content);
+  public function getContent();
+
+  public function setCache($cache);
+  public function getCache();
+
+  public function setAuthorPHID($phid);
+  public function getAuthorPHID();
+
+  public function setSyntheticAuthor($synthetic_author);
+  public function getSyntheticAuthor();
+
+  public function isCompatible(PhabricatorInlineCommentInterface $inline);
+  public function isDraft();
+
+  public function save();
+  public function delete();
+
+}

src/infrastructure/diff/interface/inline/__init__.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * This file is automatically generated. Lint this module to rebuild it.
+ * @generated
+ */
+
+
+
+
+phutil_require_source('PhabricatorInlineCommentInterface.php');