No OneTemporary
Actions

Size

11 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/applications/differential/parser/DifferentialCommitMessageParser.php b/src/applications/differential/parser/DifferentialCommitMessageParser.php
	index 4a5bf6a27b..7e5a50e61f 100644
	--- a/src/applications/differential/parser/DifferentialCommitMessageParser.php
	+++ b/src/applications/differential/parser/DifferentialCommitMessageParser.php
	@@ -1,371 +1,381 @@
	<?php

	/**
	* Parses commit messages (containing relatively freeform text with textual
	* field labels) into a dictionary of fields.
	*
	* $parser = id(new DifferentialCommitMessageParser())
	* ->setLabelMap($label_map)
	* ->setTitleKey($key_title)
	* ->setSummaryKey($key_summary);
	*
	* $fields = $parser->parseCorpus($corpus);
	* $errors = $parser->getErrors();
	*
	* This is used by Differential to parse messages entered from the command line.
	*
	* @task config Configuring the Parser
	* @task parse Parsing Messages
	* @task support Support Methods
	* @task internal Internals
	*/
	final class DifferentialCommitMessageParser extends Phobject {

	private $viewer;
	private $labelMap;
	private $titleKey;
	private $summaryKey;
	private $errors;
	private $commitMessageFields;
	private $raiseMissingFieldErrors = true;

	public static function newStandardParser(PhabricatorUser $viewer) {
	$key_title = DifferentialTitleCommitMessageField::FIELDKEY;
	$key_summary = DifferentialSummaryCommitMessageField::FIELDKEY;

	$field_list = DifferentialCommitMessageField::newEnabledFields($viewer);

	return id(new self())
	->setViewer($viewer)
	->setCommitMessageFields($field_list)
	->setTitleKey($key_title)
	->setSummaryKey($key_summary);
	}


	/* -( Configuring the Parser )--------------------------------------------- */


	/**
	* @task config
	*/
	public function setViewer(PhabricatorUser $viewer) {
	$this->viewer = $viewer;
	return $this;
	}


	/**
	* @task config
	*/
	public function getViewer() {
	return $this->viewer;
	}


	/**
	* @task config
	*/
	public function setCommitMessageFields(array $fields) {
	assert_instances_of($fields, 'DifferentialCommitMessageField');
	$fields = mpull($fields, null, 'getCommitMessageFieldKey');
	$this->commitMessageFields = $fields;
	return $this;
	}


	/**
	* @task config
	*/
	public function getCommitMessageFields() {
	return $this->commitMessageFields;
	}


	/**
	* @task config
	*/
	public function setRaiseMissingFieldErrors($raise) {
	$this->raiseMissingFieldErrors = $raise;
	return $this;
	}


	/**
	* @task config
	*/
	public function getRaiseMissingFieldErrors() {
	return $this->raiseMissingFieldErrors;
	}


	/**
	* @task config
	*/
	public function setLabelMap(array $label_map) {
	$this->labelMap = $label_map;
	return $this;
	}


	/**
	* @task config
	*/
	public function setTitleKey($title_key) {
	$this->titleKey = $title_key;
	return $this;
	}


	/**
	* @task config
	*/
	public function setSummaryKey($summary_key) {
	$this->summaryKey = $summary_key;
	return $this;
	}


	/* -( Parsing Messages )--------------------------------------------------- */


	/**
	* @task parse
	*/
	public function parseCorpus($corpus) {
	$this->errors = array();

	$label_map = $this->getLabelMap();
	$key_title = $this->titleKey;
	$key_summary = $this->summaryKey;

	if (!$key_title \|\| !$key_summary \|\| ($label_map === null)) {
	throw new Exception(
	pht(
	'Expected %s, %s and %s to be set before parsing a corpus.',
	'labelMap',
	'summaryKey',
	'titleKey'));
	}

	$label_regexp = $this->buildLabelRegexp($label_map);

	// NOTE: We're special casing things here to make the "Title:" label
	// optional in the message.
	$field = $key_title;

	$seen = array();

	$lines = trim($corpus);
	$lines = phutil_split_lines($lines, false);

	$field_map = array();
	foreach ($lines as $key => $line) {
	- $match = null;
	- if (preg_match($label_regexp, $line, $match)) {
	- $lines[$key] = trim($match['text']);
	- $field = $label_map[self::normalizeFieldLabel($match['field'])];
	- if (!empty($seen[$field])) {
	- $this->errors[] = pht(
	- 'Field "%s" occurs twice in commit message!',
	- $field);
	- }
	+ // We always parse the first line of the message as a title, even if it
	+ // contains something we recognize as a field header.
	+ if (!isset($seen[$key_title])) {
	+ $field = $key_title;
	+
	+ $lines[$key] = trim($line);
	$seen[$field] = true;
	+ } else {
	+ $match = null;
	+ if (preg_match($label_regexp, $line, $match)) {
	+ $lines[$key] = trim($match['text']);
	+ $field = $label_map[self::normalizeFieldLabel($match['field'])];
	+ if (!empty($seen[$field])) {
	+ $this->errors[] = pht(
	+ 'Field "%s" occurs twice in commit message!',
	+ $match['field']);
	+ }
	+ $seen[$field] = true;
	+ }
	}
	+
	$field_map[$key] = $field;
	}

	$fields = array();
	foreach ($lines as $key => $line) {
	$fields[$field_map[$key]][] = $line;
	}

	// This is a piece of special-cased magic which allows you to omit the
	// field labels for "title" and "summary". If the user enters a large block
	// of text at the beginning of the commit message with an empty line in it,
	// treat everything before the blank line as "title" and everything after
	// as "summary".
	if (isset($fields[$key_title]) && empty($fields[$key_summary])) {
	$lines = $fields[$key_title];
	for ($ii = 0; $ii < count($lines); $ii++) {
	if (strlen(trim($lines[$ii])) == 0) {
	break;
	}
	}
	if ($ii != count($lines)) {
	$fields[$key_title] = array_slice($lines, 0, $ii);
	$summary = array_slice($lines, $ii);
	if (strlen(trim(implode("\n", $summary)))) {
	$fields[$key_summary] = $summary;
	}
	}
	}

	// Implode all the lines back into chunks of text.
	foreach ($fields as $name => $lines) {
	$data = rtrim(implode("\n", $lines));
	$data = ltrim($data, "\n");
	$fields[$name] = $data;
	}

	// This is another piece of special-cased magic which allows you to
	// enter a ridiculously long title, or just type a big block of stream
	// of consciousness text, and have some sort of reasonable result conjured
	// from it.
	if (isset($fields[$key_title])) {
	$terminal = '...';
	$title = $fields[$key_title];
	$short = id(new PhutilUTF8StringTruncator())
	->setMaximumBytes(250)
	->setTerminator($terminal)
	->truncateString($title);

	if ($short != $title) {

	// If we shortened the title, split the rest into the summary, so
	// we end up with a title like:
	//
	// Title title tile title title...
	//
	// ...and a summary like:
	//
	// ...title title title.
	//
	// Summary summary summary summary.

	$summary = idx($fields, $key_summary, '');
	$offset = strlen($short) - strlen($terminal);
	$remainder = ltrim(substr($fields[$key_title], $offset));
	$summary = '...'.$remainder."\n\n".$summary;
	$summary = rtrim($summary, "\n");

	$fields[$key_title] = $short;
	$fields[$key_summary] = $summary;
	}
	}

	return $fields;
	}


	/**
	* @task parse
	*/
	public function parseFields($corpus) {
	$viewer = $this->getViewer();
	$text_map = $this->parseCorpus($corpus);

	$field_map = $this->getCommitMessageFields();

	$result_map = array();
	foreach ($text_map as $field_key => $text_value) {
	$field = idx($field_map, $field_key);
	if (!$field) {
	// This is a strict error, since we only parse fields which we have
	// been told are valid. The caller probably handed us an invalid label
	// map.
	throw new Exception(
	pht(
	'Parser emitted a field with key "%s", but no corresponding '.
	'field definition exists.',
	$field_key));
	}

	try {
	$result = $field->parseFieldValue($text_value);
	$result_map[$field_key] = $result;
	} catch (DifferentialFieldParseException $ex) {
	$this->errors[] = pht(
	'Error parsing field "%s": %s',
	$field->getFieldName(),
	$ex->getMessage());
	}
	}

	if ($this->getRaiseMissingFieldErrors()) {
	foreach ($field_map as $key => $field) {
	try {
	$field->validateFieldValue(idx($result_map, $key));
	} catch (DifferentialFieldValidationException $ex) {
	$this->errors[] = pht(
	'Invalid or missing field "%s": %s',
	$field->getFieldName(),
	$ex->getMessage());
	}
	}
	}

	return $result_map;
	}


	/**
	* @task parse
	*/
	public function getErrors() {
	return $this->errors;
	}


	/* -( Support Methods )---------------------------------------------------- */


	/**
	* @task support
	*/
	public static function normalizeFieldLabel($label) {
	return phutil_utf8_strtolower($label);
	}


	/* -( Internals )---------------------------------------------------------- */


	private function getLabelMap() {
	if ($this->labelMap === null) {
	$field_list = $this->getCommitMessageFields();

	$label_map = array();
	foreach ($field_list as $field_key => $field) {
	$labels = $field->getFieldAliases();
	$labels[] = $field->getFieldName();

	foreach ($labels as $label) {
	$normal_label = self::normalizeFieldLabel($label);
	if (!empty($label_map[$normal_label])) {
	throw new Exception(
	pht(
	'Field label "%s" is parsed by two custom fields: "%s" and '.
	'"%s". Each label must be parsed by only one field.',
	$label,
	$field_key,
	$label_map[$normal_label]));
	}

	$label_map[$normal_label] = $field_key;
	}
	}

	$this->labelMap = $label_map;
	}

	return $this->labelMap;
	}


	/**
	* @task internal
	*/
	private function buildLabelRegexp(array $label_map) {
	$field_labels = array_keys($label_map);
	foreach ($field_labels as $key => $label) {
	$field_labels[$key] = preg_quote($label, '/');
	}
	$field_labels = implode('\|', $field_labels);

	$field_pattern = '/^(?P<field>'.$field_labels.'):(?P<text>.*)$/i';

	return $field_pattern;
	}

	}
	diff --git a/src/applications/differential/parser/__tests__/messages/title-with-label.txt b/src/applications/differential/parser/__tests__/messages/title-with-label.txt
	new file mode 100644
	index 0000000000..dfbba96d14
	--- /dev/null
	+++ b/src/applications/differential/parser/__tests__/messages/title-with-label.txt
	@@ -0,0 +1,11 @@
	+color: orange
	+~~~~~~~~~~
	+{
	+ "color": "color"
	+}
	+~~~~~~~~~~
	+{
	+ "title": "color: orange"
	+}
	+~~~~~~~~~~
	+[]

File Metadata

Mime Type: text/x-diff
Expires: Sun, Jan 19, 18:17 (1 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1127360
Default Alt Text: (11 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions