DifferentialRevisionViewController.php
No OneTemporary
Actions

Size

19 KB

Referenced Files

None

Subscribers

None

DifferentialRevisionViewController.php
View Options

	<?php

	/*
	* Copyright 2011 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.
	*/

	class DifferentialRevisionViewController extends DifferentialController {

	private $revisionID;

	public function willProcessRequest(array $data) {
	$this->revisionID = $data['id'];
	}

	public function processRequest() {

	$request = $this->getRequest();
	$user = $request->getUser();

	$revision = id(new DifferentialRevision())->load($this->revisionID);
	if (!$revision) {
	return new Aphront404Response();
	}

	$revision->loadRelationships();

	$diffs = $revision->loadDiffs();

	if (!$diffs) {
	throw new Exception(
	"This revision has no diffs. Something has gone quite wrong.");
	}

	$diff_vs = $request->getInt('vs');

	$target = end($diffs);
	$target_id = $request->getInt('id');
	if ($target_id) {
	if (isset($diffs[$target_id])) {
	$target = $diffs[$target_id];
	}
	}

	$diffs = mpull($diffs, null, 'getID');
	if (empty($diffs[$diff_vs])) {
	$diff_vs = null;
	}

	list($changesets, $vs_map) =
	$this->loadChangesetsAndVsMap($diffs, $diff_vs, $target);

	$comments = $revision->loadComments();
	$comments = array_merge(
	$this->getImplicitComments($revision),
	$comments);

	$all_changesets = $changesets;
	$inlines = $this->loadInlineComments($comments, $all_changesets);

	$object_phids = array_merge(
	$revision->getReviewers(),
	$revision->getCCPHIDs(),
	$revision->loadCommitPHIDs(),
	array(
	$revision->getAuthorPHID(),
	$user->getPHID(),
	),
	mpull($comments, 'getAuthorPHID'));
	foreach ($revision->getAttached() as $type => $phids) {
	foreach ($phids as $phid => $info) {
	$object_phids[] = $phid;
	}
	}
	$object_phids = array_unique($object_phids);

	$handles = id(new PhabricatorObjectHandleData($object_phids))
	->loadHandles();

	$request_uri = $request->getRequestURI();

	$limit = 100;
	$large = $request->getStr('large');
	if (count($changesets) > $limit && !$large) {
	$count = number_format(count($changesets));
	$warning = new AphrontErrorView();
	$warning->setTitle('Very Large Diff');
	$warning->setSeverity(AphrontErrorView::SEVERITY_WARNING);
	$warning->setWidth(AphrontErrorView::WIDTH_WIDE);
	$warning->appendChild(
	"<p>This diff is very large and affects {$count} files. Use ".
	"Table of Contents to open files in a standalone view. ".
	"<strong>".
	phutil_render_tag(
	'a',
	array(
	'href' => $request_uri->alter('large', 'true'),
	),
	'Show All Files Inline').
	"</strong>");
	$warning = $warning->render();

	$visible_changesets = array();
	} else {
	$warning = null;
	$visible_changesets = $changesets;
	}

	$diff_properties = id(new DifferentialDiffProperty())->loadAllWhere(
	'diffID = %d AND name IN (%Ls)',
	$target->getID(),
	array(
	'arc:lint',
	'arc:unit',
	));
	$diff_properties = mpull($diff_properties, 'getData', 'getName');

	$revision_detail = new DifferentialRevisionDetailView();
	$revision_detail->setRevision($revision);

	$custom_renderer_class = PhabricatorEnv::getEnvConfig(
	'differential.revision-custom-detail-renderer');
	if ($custom_renderer_class) {
	PhutilSymbolLoader::loadClass($custom_renderer_class);
	$custom_renderer =
	newv($custom_renderer_class, array());
	} else {
	$custom_renderer = null;
	}

	$properties = $this->getRevisionProperties(
	$revision,
	$target,
	$handles,
	$diff_properties);
	if ($custom_renderer) {
	$properties = array_merge(
	$properties,
	$custom_renderer->generateProperties($revision, $target));
	}

	$revision_detail->setProperties($properties);

	$actions = $this->getRevisionActions($revision);
	if ($custom_renderer) {
	$actions = array_merge(
	$actions,
	$custom_renderer->generateActionLinks($revision, $target));
	}

	$whitespace = $request->getStr(
	'whitespace',
	DifferentialChangesetParser::WHITESPACE_IGNORE_ALL
	);

	$revision_detail->setActions($actions);

	$revision_detail->setUser($user);

	$comment_view = new DifferentialRevisionCommentListView();
	$comment_view->setComments($comments);
	$comment_view->setHandles($handles);
	$comment_view->setInlineComments($inlines);
	$comment_view->setChangesets($all_changesets);
	$comment_view->setUser($user);
	$comment_view->setTargetDiff($target);

	$changeset_view = new DifferentialChangesetListView();
	$changeset_view->setChangesets($visible_changesets);
	$changeset_view->setEditable(true);
	$changeset_view->setStandaloneViews(true);
	$changeset_view->setRevision($revision);
	$changeset_view->setVsMap($vs_map);
	$changeset_view->setWhitespace($whitespace);

	$diff_history = new DifferentialRevisionUpdateHistoryView();
	$diff_history->setDiffs($diffs);
	$diff_history->setSelectedVersusDiffID($diff_vs);
	$diff_history->setSelectedDiffID($target->getID());
	$diff_history->setSelectedWhitespace($whitespace);

	$toc_view = new DifferentialDiffTableOfContentsView();
	$toc_view->setChangesets($changesets);
	$toc_view->setStandaloneViewLink(empty($visible_changesets));
	$toc_view->setVsMap($vs_map);
	$toc_view->setRevisionID($revision->getID());
	$toc_view->setWhitespace($whitespace);


	$draft = id(new PhabricatorDraft())->loadOneWhere(
	'authorPHID = %s AND draftKey = %s',
	$user->getPHID(),
	'differential-comment-'.$revision->getID());
	if ($draft) {
	$draft = $draft->getDraft();
	} else {
	$draft = null;
	}

	$comment_form = new DifferentialAddCommentView();
	$comment_form->setRevision($revision);
	$comment_form->setActions($this->getRevisionCommentActions($revision));
	$comment_form->setActionURI('/differential/comment/save/');
	$comment_form->setUser($user);
	$comment_form->setDraft($draft);

	$this->updateViewTime($user->getPHID(), $revision->getPHID());

	return $this->buildStandardPageResponse(
	'<div class="differential-primary-pane">'.
	$revision_detail->render().
	$comment_view->render().
	$diff_history->render().
	$warning.
	$toc_view->render().
	$changeset_view->render().
	$comment_form->render().
	'</div>',
	array(
	'title' => $revision->getTitle(),
	));
	}

	private function getImplicitComments(DifferentialRevision $revision) {

	$template = new DifferentialComment();
	$template->setAuthorPHID($revision->getAuthorPHID());
	$template->setRevisionID($revision->getID());
	$template->setDateCreated($revision->getDateCreated());

	$comments = array();

	if (strlen($revision->getSummary())) {
	$summary_comment = clone $template;
	$summary_comment->setContent($revision->getSummary());
	$summary_comment->setAction(DifferentialAction::ACTION_SUMMARIZE);
	$comments[] = $summary_comment;
	}

	if (strlen($revision->getTestPlan())) {
	$testplan_comment = clone $template;
	$testplan_comment->setContent($revision->getTestPlan());
	$testplan_comment->setAction(DifferentialAction::ACTION_TESTPLAN);
	$comments[] = $testplan_comment;
	}

	return $comments;
	}

	private function getRevisionProperties(
	DifferentialRevision $revision,
	DifferentialDiff $diff,
	array $handles,
	array $diff_properties) {

	$properties = array();

	$status = $revision->getStatus();
	$next_step = null;
	if ($status == DifferentialRevisionStatus::ACCEPTED) {
	switch ($diff->getSourceControlSystem()) {
	case PhabricatorRepositoryType::REPOSITORY_TYPE_GIT:
	$next_step = 'arc amend --revision '.$revision->getID();
	break;
	case PhabricatorRepositoryType::REPOSITORY_TYPE_SVN:
	$next_step = 'arc commit --revision '.$revision->getID();
	break;
	}
	if ($next_step) {
	$next_step =
	' · '.
	'Next step: <tt>'.phutil_escape_html($next_step).'</tt>';
	}
	}
	$status = DifferentialRevisionStatus::getNameForRevisionStatus($status);
	$properties['Revision Status'] = '<strong>'.$status.'</strong>'.$next_step;

	$author = $handles[$revision->getAuthorPHID()];
	$properties['Author'] = $author->renderLink();

	$properties['Reviewers'] = $this->renderHandleLinkList(
	array_select_keys(
	$handles,
	$revision->getReviewers()));

	$properties['CCs'] = $this->renderHandleLinkList(
	array_select_keys(
	$handles,
	$revision->getCCPHIDs()));

	$host = $diff->getSourceMachine();
	if ($host) {
	$properties['Host'] = phutil_escape_html($host);
	}

	$path = $diff->getSourcePath();
	if ($path) {
	$branch = $diff->getBranch() ? ' ('.$diff->getBranch().')' : '';
	$properties['Path'] = phutil_escape_html("{$path} {$branch}");
	}

	$lstar = DifferentialRevisionUpdateHistoryView::renderDiffLintStar($diff);
	$lmsg = DifferentialRevisionUpdateHistoryView::getDiffLintMessage($diff);
	$ldata = idx($diff_properties, 'arc:lint');
	$ltail = null;
	if ($ldata) {
	$ldata = igroup($ldata, 'path');
	$lint_messages = array();
	foreach ($ldata as $path => $messages) {
	$message_markup = array();
	foreach ($messages as $message) {
	$path = idx($message, 'path');
	$line = idx($message, 'line');

	$code = idx($message, 'code');
	$severity = idx($message, 'severity');

	$name = idx($message, 'name');
	$description = idx($message, 'description');

	$message_markup[] =
	'<li>'.
	'<span class="lint-severity-'.phutil_escape_html($severity).'">'.
	phutil_escape_html(ucwords($severity)).
	'</span>'.
	' '.
	'('.phutil_escape_html($code).') '.
	phutil_escape_html($name).
	' at line '.phutil_escape_html($line).
	'<p>'.phutil_escape_html($description).'</p>'.
	'</li>';
	}
	$lint_messages[] =
	'<li class="lint-file-block">'.
	'Lint for <strong>'.phutil_escape_html($path).'</strong>'.
	'<ul>'.implode("\n", $message_markup).'</ul>'.
	'</li>';
	}
	$ltail =
	'<div class="differential-lint-block">'.
	'<ul>'.
	implode("\n", $lint_messages).
	'</ul>'.
	'</div>';
	}

	$properties['Lint'] = $lstar.' '.$lmsg.$ltail;

	$ustar = DifferentialRevisionUpdateHistoryView::renderDiffUnitStar($diff);
	$umsg = DifferentialRevisionUpdateHistoryView::getDiffUnitMessage($diff);

	$udata = idx($diff_properties, 'arc:unit');
	$utail = null;
	if ($udata) {
	$unit_messages = array();
	foreach ($udata as $test) {
	$name = phutil_escape_html(idx($test, 'name'));
	$result = phutil_escape_html(idx($test, 'result'));
	$userdata = phutil_escape_html(idx($test, 'userdata'));
	if (strlen($userdata) > 256) {
	$userdata = substr($userdata, 0, 256).'...';
	}
	$userdata = str_replace("\n", '<br />', $userdata);
	$unit_messages[] =
	'<tr>'.
	'<th>'.$name.'</th>'.
	'<th class="unit-test-result">'.
	'<div class="result-'.$result.'">'.
	strtoupper($result).
	'</div>'.
	'</th>'.
	'<td>'.$userdata.'</td>'.
	'</tr>';
	}

	$utail =
	'<div class="differential-unit-block">'.
	'<table class="differential-unit-table">'.
	implode("\n", $unit_messages).
	'</table>'.
	'</div>';
	}

	$properties['Unit'] = $ustar.' '.$umsg.$utail;

	if (PhabricatorEnv::getEnvConfig('maniphest.enabled')) {
	$tasks = $revision->getAttachedPHIDs(
	PhabricatorPHIDConstants::PHID_TYPE_TASK);
	if ($tasks) {
	$links = array();
	foreach ($tasks as $task_phid) {
	$links[] = $handles[$task_phid]->renderLink();
	}
	$properties['Maniphest Tasks'] = implode('<br />', $links);
	}
	}

	$commit_phids = $revision->getCommitPHIDs();
	if ($commit_phids) {
	$links = array();
	foreach ($commit_phids as $commit_phid) {
	$links[] = $handles[$commit_phid]->renderLink();
	}
	$properties['Commits'] = implode('<br />', $links);
	}

	$properties['Apply Patch'] =
	'<tt>arc patch D'.$revision->getID().'</tt>';
	$properties['Export Patch'] =
	'<tt>arc export --revision '.$revision->getID().'</tt>';

	return $properties;
	}

	private function getRevisionActions(DifferentialRevision $revision) {
	$viewer_phid = $this->getRequest()->getUser()->getPHID();
	$viewer_is_owner = ($revision->getAuthorPHID() == $viewer_phid);
	$viewer_is_reviewer = in_array($viewer_phid, $revision->getReviewers());
	$viewer_is_cc = in_array($viewer_phid, $revision->getCCPHIDs());
	$status = $revision->getStatus();
	$revision_id = $revision->getID();
	$revision_phid = $revision->getPHID();

	$links = array();

	if ($viewer_is_owner) {
	$links[] = array(
	'class' => 'revision-edit',
	'href' => "/differential/revision/edit/{$revision_id}/",
	'name' => 'Edit Revision',
	);
	}

	if (!$viewer_is_owner && !$viewer_is_reviewer) {
	$action = $viewer_is_cc ? 'rem' : 'add';
	$links[] = array(
	'class' => $viewer_is_cc ? 'subscribe-rem' : 'subscribe-add',
	'href' => "/differential/subscribe/{$action}/{$revision_id}/",
	'name' => $viewer_is_cc ? 'Unsubscribe' : 'Subscribe',
	'instant' => true,
	);
	} else {
	$links[] = array(
	'class' => 'subscribe-rem unavailable',
	'name' => 'Automatically Subscribed',
	);
	}

	require_celerity_resource('phabricator-object-selector-css');
	require_celerity_resource('javelin-behavior-phabricator-object-selector');

	if (PhabricatorEnv::getEnvConfig('maniphest.enabled')) {
	$links[] = array(
	'class' => 'attach-maniphest',
	'name' => 'Edit Maniphest Tasks',
	'href' => "/differential/attach/{$revision_id}/TASK/",
	'sigil' => 'workflow',
	);
	}

	$links[] = array(
	'class' => 'transcripts-metamta',
	'name' => 'MetaMTA Transcripts',
	'href' => "/mail/?phid={$revision_phid}",
	);

	$links[] = array(
	'class' => 'transcripts-herald',
	'name' => 'Herald Transcripts',
	'href' => "/herald/transcript/?phid={$revision_phid}",
	);

	return $links;
	}


	private function renderHandleLinkList(array $list) {
	if (empty($list)) {
	return '<em>None</em>';
	}
	return implode(', ', mpull($list, 'renderLink'));
	}

	private function getRevisionCommentActions(DifferentialRevision $revision) {

	$actions = array(
	DifferentialAction::ACTION_COMMENT => true,
	);

	$viewer_phid = $this->getRequest()->getUser()->getPHID();
	$viewer_is_owner = ($viewer_phid == $revision->getAuthorPHID());
	$viewer_is_reviewer = in_array($viewer_phid, $revision->getReviewers());

	if ($viewer_is_owner) {
	switch ($revision->getStatus()) {
	case DifferentialRevisionStatus::NEEDS_REVIEW:
	$actions[DifferentialAction::ACTION_ABANDON] = true;
	$actions[DifferentialAction::ACTION_RETHINK] = true;
	break;
	case DifferentialRevisionStatus::NEEDS_REVISION:
	$actions[DifferentialAction::ACTION_ABANDON] = true;
	$actions[DifferentialAction::ACTION_REQUEST] = true;
	break;
	case DifferentialRevisionStatus::ACCEPTED:
	$actions[DifferentialAction::ACTION_ABANDON] = true;
	$actions[DifferentialAction::ACTION_REQUEST] = true;
	$actions[DifferentialAction::ACTION_RETHINK] = true;
	break;
	case DifferentialRevisionStatus::COMMITTED:
	break;
	case DifferentialRevisionStatus::ABANDONED:
	$actions[DifferentialAction::ACTION_RECLAIM] = true;
	break;
	}
	} else {
	switch ($revision->getStatus()) {
	case DifferentialRevisionStatus::NEEDS_REVIEW:
	$actions[DifferentialAction::ACTION_ACCEPT] = true;
	$actions[DifferentialAction::ACTION_REJECT] = true;
	$actions[DifferentialAction::ACTION_RESIGN] = $viewer_is_reviewer;
	break;
	case DifferentialRevisionStatus::NEEDS_REVISION:
	$actions[DifferentialAction::ACTION_ACCEPT] = true;
	$actions[DifferentialAction::ACTION_RESIGN] = $viewer_is_reviewer;
	break;
	case DifferentialRevisionStatus::ACCEPTED:
	$actions[DifferentialAction::ACTION_REJECT] = true;
	break;
	case DifferentialRevisionStatus::COMMITTED:
	case DifferentialRevisionStatus::ABANDONED:
	break;
	}
	}

	$actions[DifferentialAction::ACTION_ADDREVIEWERS] = true;

	return array_keys(array_filter($actions));
	}

	private function loadInlineComments(array $comments, array &$changesets) {

	$inline_comments = array();

	$comment_ids = array_filter(mpull($comments, 'getID'));
	if (!$comment_ids) {
	return $inline_comments;
	}

	$inline_comments = id(new DifferentialInlineComment())
	->loadAllWhere(
	'commentID in (%Ld)',
	$comment_ids);

	$load_changesets = array();
	foreach ($inline_comments as $inline) {
	$changeset_id = $inline->getChangesetID();
	if (isset($changesets[$changeset_id])) {
	continue;
	}
	$load_changesets[$changeset_id] = true;
	}

	$more_changesets = array();
	if ($load_changesets) {
	$changeset_ids = array_keys($load_changesets);
	$more_changesets += id(new DifferentialChangeset())
	->loadAllWhere(
	'id IN (%Ld)',
	$changeset_ids);
	}

	if ($more_changesets) {
	$changesets += $more_changesets;
	$changesets = msort($changesets, 'getSortKey');
	}

	return $inline_comments;
	}

	private function loadChangesetsAndVsMap(array $diffs, $diff_vs, $target) {
	$load_ids = array();
	if ($diff_vs) {
	$load_ids[] = $diff_vs;
	}
	$load_ids[] = $target->getID();

	$raw_changesets = id(new DifferentialChangeset())
	->loadAllWhere(
	'diffID IN (%Ld)',
	$load_ids);
	$changeset_groups = mgroup($raw_changesets, 'getDiffID');

	$changesets = idx($changeset_groups, $target->getID(), array());
	$changesets = mpull($changesets, null, 'getID');

	$vs_map = array();
	if ($diff_vs) {
	$vs_changesets = idx($changeset_groups, $diff_vs, array());
	$vs_changesets = mpull($vs_changesets, null, 'getFilename');
	foreach ($changesets as $key => $changeset) {
	$file = $changeset->getFilename();
	if (isset($vs_changesets[$file])) {
	$vs_map[$changeset->getID()] = $vs_changesets[$file]->getID();
	unset($vs_changesets[$file]);
	}
	}
	foreach ($vs_changesets as $changeset) {
	$changesets[$changeset->getID()] = $changeset;
	$vs_map[$changeset->getID()] = -1;
	}
	}

	$changesets = msort($changesets, 'getSortKey');

	return array($changesets, $vs_map);
	}

	private function updateViewTime($user_phid, $revision_phid) {
	$view_time =
	id(new DifferentialViewTime())
	->setViewerPHID($user_phid)
	->setObjectPHID($revision_phid)
	->setViewTime(time())
	->replace();
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Jan 19 2025, 19:10 (5 w, 8 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1127790
Default Alt Text: DifferentialRevisionViewController.php (19 KB)

DifferentialRevisionViewController.phpNo OneTemporaryActions

DifferentialRevisionViewController.phpView Options

File Metadata

Event Timeline

DifferentialRevisionViewController.php
No OneTemporary
Actions

DifferentialRevisionViewController.php
View Options