Homec4science
Diffusion Phabricator (stable) Browse

phab/src/applications/differential/conduit/ConduitAPI_differential_getcommitmessage_Method.php
b902005bed52stable

Last Change
Raw File

ConduitAPI_differential_getcommitmessage_Method.php
View Options

<?php
/**
* @group conduit
*/
final class ConduitAPI_differential_getcommitmessage_Method
extends ConduitAPIMethod {
public function getMethodDescription() {
return "Retrieve Differential commit messages or message templates.";
}
public function defineParamTypes() {
return array(
'revision_id' => 'optional revision_id',
'fields' => 'optional dict<string, wild>',
'edit' => 'optional enum<"edit", "create">',
);
}
public function defineReturnType() {
return 'nonempty string';
}
public function defineErrorTypes() {
return array(
'ERR_NOT_FOUND' => 'Revision was not found.',
);
}
protected function execute(ConduitAPIRequest $request) {
$id = $request->getValue('revision_id');
if ($id) {
$revision = id(new DifferentialRevisionQuery())
->withIDs(array($id))
->setViewer($request->getUser())
->needRelationships(true)
->needReviewerStatus(true)
->executeOne();
if (!$revision) {
throw new ConduitException('ERR_NOT_FOUND');
}
} else {
$revision = new DifferentialRevision();
$revision->attachRelationships(array());
}
$is_edit = $request->getValue('edit');
$is_create = ($is_edit == 'create');
$aux_fields = DifferentialFieldSelector::newSelector()
->getFieldSpecifications();
$pro_tips = array();
foreach ($aux_fields as $key => $aux_field) {
$aux_field->setUser($request->getUser());
$aux_field->setRevision($revision);
$pro_tips[] = $aux_field->getCommitMessageTips();
if (!$aux_field->shouldAppearOnCommitMessage()) {
unset($aux_fields[$key]);
}
}
$aux_fields = DifferentialAuxiliaryField::loadFromStorage(
$revision,
$aux_fields);
$aux_fields = mpull($aux_fields, null, 'getCommitMessageKey');
if ($is_edit) {
$fields = $request->getValue('fields');
if (!is_array($fields)) {
$fields = array();
}
foreach ($fields as $field => $value) {
$aux_field = idx($aux_fields, $field);
if (!$aux_field) {
throw new Exception(
"Commit message includes field '{$field}' which does not ".
"correspond to any configured field.");
}
if ($is_create ||
$aux_field->shouldOverwriteWhenCommitMessageIsEdited()) {
$aux_field->setValueFromParsedCommitMessage($value);
}
}
}
$aux_phids = array();
foreach ($aux_fields as $field_key => $field) {
$aux_phids[$field_key] = $field->getRequiredHandlePHIDsForCommitMessage();
}
$phids = array_unique(array_mergev($aux_phids));
$handles = id(new PhabricatorHandleQuery())
->setViewer($request->getUser())
->withPHIDs($phids)
->execute();
foreach ($aux_fields as $field_key => $field) {
$field->setHandles(array_select_keys($handles, $aux_phids[$field_key]));
}
$commit_message = array();
foreach ($aux_fields as $field_key => $field) {
$value = $field->renderValueForCommitMessage($is_edit);
$label = $field->renderLabelForCommitMessage();
if (!strlen($value)) {
if ($field_key === 'title') {
$commit_message[] =
DifferentialTitleFieldSpecification::getDefaultRevisionTitle();
} else {
if ($field->shouldAppearOnCommitMessageTemplate() && $is_edit) {
$commit_message[] = $label.': ';
}
}
} else {
if ($field_key === 'title') {
$commit_message[] = $value;
} else {
$value = str_replace(
array("\r\n", "\r"),
array("\n", "\n"),
$value);
if (strpos($value, "\n") !== false || substr($value, 0, 2) === ' ') {
$commit_message[] = "{$label}:\n{$value}";
} else {
$commit_message[] = "{$label}: {$value}";
}
}
}
}
if ($is_edit) {
$pro_tips = array_mergev($pro_tips);
if (!empty($pro_tips)) {
shuffle($pro_tips);
$pro_tip = "Tip: ".$pro_tips[0];
$pro_tip = wordwrap($pro_tip, 78, "\n", true);
$lines = explode("\n", $pro_tip);
foreach ($lines as $key => $line) {
$lines[$key] = "# ".$line;
}
$pro_tip = implode("\n", $lines);
$commit_message[] = $pro_tip;
}
}
$commit_message = implode("\n\n", $commit_message);
return $commit_message;
}
}
c4science · Help