HarbormasterPlanViewController.php
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Fri, Dec 20, 18:32

HarbormasterPlanViewController.php
View Options

	<?php

	final class HarbormasterPlanViewController extends HarbormasterPlanController {

	private $id;

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

	public function processRequest() {
	$request = $this->getRequest();
	$viewer = $request->getUser();

	$id = $this->id;

	$plan = id(new HarbormasterBuildPlanQuery())
	->setViewer($viewer)
	->withIDs(array($id))
	->executeOne();
	if (!$plan) {
	return new Aphront404Response();
	}

	$timeline = $this->buildTransactionTimeline(
	$plan,
	new HarbormasterBuildPlanTransactionQuery());
	$timeline->setShouldTerminate(true);

	$title = $plan->getName();

	$header = id(new PHUIHeaderView())
	->setHeader($plan->getName())
	->setUser($viewer)
	->setPolicyObject($plan);

	$box = id(new PHUIObjectBoxView())
	->setHeader($header);

	$actions = $this->buildActionList($plan);
	$this->buildPropertyLists($box, $plan, $actions);

	$crumbs = $this->buildApplicationCrumbs();
	$crumbs->addTextCrumb(pht('Plan %d', $id));

	list($step_list, $has_any_conflicts, $would_deadlock) =
	$this->buildStepList($plan);

	if ($would_deadlock) {
	$box->setFormErrors(
	array(
	pht(
	'This build plan will deadlock when executed, due to '.
	'circular dependencies present in the build plan. '.
	'Examine the step list and resolve the deadlock.'),
	));
	} else if ($has_any_conflicts) {
	// A deadlocking build will also cause all the artifacts to be
	// invalid, so we just skip showing this message if that's the
	// case.
	$box->setFormErrors(
	array(
	pht(
	'This build plan has conflicts in one or more build steps. '.
	'Examine the step list and resolve the listed errors.'),
	));
	}

	return $this->buildApplicationPage(
	array(
	$crumbs,
	$box,
	$step_list,
	$timeline,
	),
	array(
	'title' => $title,
	));
	}

	private function buildStepList(HarbormasterBuildPlan $plan) {
	$request = $this->getRequest();
	$viewer = $request->getUser();

	$run_order =
	HarbormasterBuildGraph::determineDependencyExecution($plan);

	$steps = id(new HarbormasterBuildStepQuery())
	->setViewer($viewer)
	->withBuildPlanPHIDs(array($plan->getPHID()))
	->execute();
	$steps = mpull($steps, null, 'getPHID');

	$can_edit = $this->hasApplicationCapability(
	HarbormasterManagePlansCapability::CAPABILITY);

	$step_list = id(new PHUIObjectItemListView())
	->setUser($viewer)
	->setNoDataString(
	pht('This build plan does not have any build steps yet.'));

	$i = 1;
	$last_depth = 0;
	$has_any_conflicts = false;
	$is_deadlocking = false;
	foreach ($run_order as $run_ref) {
	$step = $steps[$run_ref['node']->getPHID()];
	$depth = $run_ref['depth'] + 1;
	if ($last_depth !== $depth) {
	$last_depth = $depth;
	$i = 1;
	} else {
	$i++;
	}

	$implementation = null;
	try {
	$implementation = $step->getStepImplementation();
	} catch (Exception $ex) {
	// We can't initialize the implementation. This might be because
	// it's been renamed or no longer exists.
	$item = id(new PHUIObjectItemView())
	->setObjectName(pht('Step %d.%d', $depth, $i))
	->setHeader(pht('Unknown Implementation'))
	->setBarColor('red')
	->addAttribute(pht(
	'This step has an invalid implementation (%s).',
	$step->getClassName()))
	->addAction(
	id(new PHUIListItemView())
	->setIcon('fa-times')
	->addSigil('harbormaster-build-step-delete')
	->setWorkflow(true)
	->setRenderNameAsTooltip(true)
	->setName(pht('Delete'))
	->setHref(
	$this->getApplicationURI('step/delete/'.$step->getID().'/')));
	$step_list->addItem($item);
	continue;
	}
	$item = id(new PHUIObjectItemView())
	->setObjectName(pht('Step %d.%d', $depth, $i))
	->setHeader($step->getName());

	$item->addAttribute($implementation->getDescription());

	$step_id = $step->getID();
	$edit_uri = $this->getApplicationURI("step/edit/{$step_id}/");
	$delete_uri = $this->getApplicationURI("step/delete/{$step_id}/");

	if ($can_edit) {
	$item->setHref($edit_uri);
	}

	$item
	->setHref($edit_uri)
	->addAction(
	id(new PHUIListItemView())
	->setIcon('fa-times')
	->addSigil('harbormaster-build-step-delete')
	->setWorkflow(true)
	->setDisabled(!$can_edit)
	->setHref(
	$this->getApplicationURI('step/delete/'.$step->getID().'/')));

	$depends = $step->getStepImplementation()->getDependencies($step);
	$inputs = $step->getStepImplementation()->getArtifactInputs();
	$outputs = $step->getStepImplementation()->getArtifactOutputs();

	$has_conflicts = false;
	if ($depends \|\| $inputs \|\| $outputs) {
	$available_artifacts =
	HarbormasterBuildStepImplementation::getAvailableArtifacts(
	$plan,
	$step,
	null);
	$available_artifacts = ipull($available_artifacts, 'type');

	list($depends_ui, $has_conflicts) = $this->buildDependsOnList(
	$depends,
	pht('Depends On'),
	$steps);

	list($inputs_ui, $has_conflicts) = $this->buildArtifactList(
	$inputs,
	'in',
	pht('Input Artifacts'),
	$available_artifacts);

	list($outputs_ui) = $this->buildArtifactList(
	$outputs,
	'out',
	pht('Output Artifacts'),
	array());

	$item->appendChild(
	phutil_tag(
	'div',
	array(
	'class' => 'harbormaster-artifact-io',
	),
	array(
	$depends_ui,
	$inputs_ui,
	$outputs_ui,
	)));
	}

	if ($has_conflicts) {
	$has_any_conflicts = true;
	$item->setBarColor('red');
	}

	if ($run_ref['cycle']) {
	$is_deadlocking = true;
	}

	if ($is_deadlocking) {
	$item->setBarColor('red');
	}

	$step_list->addItem($item);
	}

	return array($step_list, $has_any_conflicts, $is_deadlocking);
	}

	private function buildActionList(HarbormasterBuildPlan $plan) {
	$request = $this->getRequest();
	$viewer = $request->getUser();
	$id = $plan->getID();

	$list = id(new PhabricatorActionListView())
	->setUser($viewer)
	->setObject($plan)
	->setObjectURI($this->getApplicationURI("plan/{$id}/"));

	$can_edit = $this->hasApplicationCapability(
	HarbormasterManagePlansCapability::CAPABILITY);

	$list->addAction(
	id(new PhabricatorActionView())
	->setName(pht('Edit Plan'))
	->setHref($this->getApplicationURI("plan/edit/{$id}/"))
	->setWorkflow(!$can_edit)
	->setDisabled(!$can_edit)
	->setIcon('fa-pencil'));

	if ($plan->isDisabled()) {
	$list->addAction(
	id(new PhabricatorActionView())
	->setName(pht('Enable Plan'))
	->setHref($this->getApplicationURI("plan/disable/{$id}/"))
	->setWorkflow(true)
	->setDisabled(!$can_edit)
	->setIcon('fa-check'));
	} else {
	$list->addAction(
	id(new PhabricatorActionView())
	->setName(pht('Disable Plan'))
	->setHref($this->getApplicationURI("plan/disable/{$id}/"))
	->setWorkflow(true)
	->setDisabled(!$can_edit)
	->setIcon('fa-ban'));
	}

	$list->addAction(
	id(new PhabricatorActionView())
	->setName(pht('Add Build Step'))
	->setHref($this->getApplicationURI("step/add/{$id}/"))
	->setWorkflow(true)
	->setDisabled(!$can_edit)
	->setIcon('fa-plus'));

	$list->addAction(
	id(new PhabricatorActionView())
	->setName(pht('Run Plan Manually'))
	->setHref($this->getApplicationURI("plan/run/{$id}/"))
	->setWorkflow(true)
	->setDisabled(!$can_edit)
	->setIcon('fa-play-circle'));

	return $list;
	}

	private function buildPropertyLists(
	PHUIObjectBoxView $box,
	HarbormasterBuildPlan $plan,
	PhabricatorActionListView $actions) {
	$request = $this->getRequest();
	$viewer = $request->getUser();

	$properties = id(new PHUIPropertyListView())
	->setUser($viewer)
	->setObject($plan)
	->setActionList($actions);
	$box->addPropertyList($properties);

	$properties->addProperty(
	pht('Created'),
	phabricator_datetime($plan->getDateCreated(), $viewer));

	}

	private function buildArtifactList(
	array $artifacts,
	$kind,
	$name,
	array $available_artifacts) {
	$has_conflicts = false;

	if (!$artifacts) {
	return array(null, $has_conflicts);
	}

	$this->requireResource('harbormaster-css');

	$header = phutil_tag(
	'div',
	array(
	'class' => 'harbormaster-artifact-summary-header',
	),
	$name);

	$is_input = ($kind == 'in');

	$list = new PHUIStatusListView();
	foreach ($artifacts as $artifact) {
	$error = null;

	$key = idx($artifact, 'key');
	if (!strlen($key)) {
	$bound = phutil_tag('em', array(), pht('(null)'));
	if ($is_input) {
	// This is an unbound input. For now, all inputs are always required.
	$icon = PHUIStatusItemView::ICON_WARNING;
	$color = 'red';
	$icon_label = pht('Required Input');
	$has_conflicts = true;
	$error = pht('This input is required, but not configured.');
	} else {
	// This is an unnamed output. Outputs do not necessarily need to be
	// named.
	$icon = PHUIStatusItemView::ICON_OPEN;
	$color = 'bluegrey';
	$icon_label = pht('Unused Output');
	}
	} else {
	$bound = phutil_tag('strong', array(), $key);
	if ($is_input) {
	if (isset($available_artifacts[$key])) {
	if ($available_artifacts[$key] == idx($artifact, 'type')) {
	$icon = PHUIStatusItemView::ICON_ACCEPT;
	$color = 'green';
	$icon_label = pht('Valid Input');
	} else {
	$icon = PHUIStatusItemView::ICON_WARNING;
	$color = 'red';
	$icon_label = pht('Bad Input Type');
	$has_conflicts = true;
	$error = pht(
	'This input is bound to the wrong artifact type. It is bound '.
	'to a "%s" artifact, but should be bound to a "%s" artifact.',
	$available_artifacts[$key],
	idx($artifact, 'type'));
	}
	} else {
	$icon = PHUIStatusItemView::ICON_QUESTION;
	$color = 'red';
	$icon_label = pht('Unknown Input');
	$has_conflicts = true;
	$error = pht(
	'This input is bound to an artifact ("%s") which does not exist '.
	'at this stage in the build process.',
	$key);
	}
	} else {
	$icon = PHUIStatusItemView::ICON_DOWN;
	$color = 'green';
	$icon_label = pht('Valid Output');
	}
	}

	if ($error) {
	$note = array(
	phutil_tag('strong', array(), pht('ERROR:')),
	' ',
	$error,
	);
	} else {
	$note = $bound;
	}

	$list->addItem(
	id(new PHUIStatusItemView())
	->setIcon($icon, $color, $icon_label)
	->setTarget($artifact['name'])
	->setNote($note));
	}

	$ui = array(
	$header,
	$list,
	);

	return array($ui, $has_conflicts);
	}

	private function buildDependsOnList(
	array $step_phids,
	$name,
	array $steps) {
	$has_conflicts = false;

	if (count($step_phids) === 0) {
	return null;
	}

	$this->requireResource('harbormaster-css');

	$steps = mpull($steps, null, 'getPHID');

	$header = phutil_tag(
	'div',
	array(
	'class' => 'harbormaster-artifact-summary-header',
	),
	$name);

	$list = new PHUIStatusListView();
	foreach ($step_phids as $step_phid) {
	$error = null;

	if (idx($steps, $step_phid) === null) {
	$icon = PHUIStatusItemView::ICON_WARNING;
	$color = 'red';
	$icon_label = pht('Missing Dependency');
	$has_conflicts = true;
	$error = pht(
	"This dependency specifies a build step which doesn't exist.");
	} else {
	$bound = phutil_tag(
	'strong',
	array(),
	idx($steps, $step_phid)->getName());
	$icon = PHUIStatusItemView::ICON_ACCEPT;
	$color = 'green';
	$icon_label = pht('Valid Input');
	}

	if ($error) {
	$note = array(
	phutil_tag('strong', array(), pht('ERROR:')),
	' ',
	$error,
	);
	} else {
	$note = $bound;
	}

	$list->addItem(
	id(new PHUIStatusItemView())
	->setIcon($icon, $color, $icon_label)
	->setTarget(pht('Build Step'))
	->setNote($note));
	}

	$ui = array(
	$header,
	$list,
	);

	return array($ui, $has_conflicts);
	}
	}

HarbormasterPlanViewController.phpNo OneTemporaryActions

File Metadata

HarbormasterPlanViewController.phpView Options

Event Timeline

HarbormasterPlanViewController.php
No OneTemporary
Actions

HarbormasterPlanViewController.php
View Options