HarbormasterStepEditController.php

<?php

final class HarbormasterStepEditController
  extends HarbormasterPlanController {

  public function handleRequest(AphrontRequest $request) {
    $viewer = $this->getViewer();
    $id = $request->getURIData('id');

    if ($id) {
      $step = id(new HarbormasterBuildStepQuery())
        ->setViewer($viewer)
        ->withIDs(array($id))
        ->requireCapabilities(
          array(
            PhabricatorPolicyCapability::CAN_VIEW,
            PhabricatorPolicyCapability::CAN_EDIT,
          ))
        ->executeOne();
      if (!$step) {
        return new Aphront404Response();
      }
      $plan = $step->getBuildPlan();

      $is_new = false;
    } else {
      $plan_id = $request->getURIData('plan');
      $class = $request->getURIData('class');

      $plan = id(new HarbormasterBuildPlanQuery())
        ->setViewer($viewer)
        ->withIDs(array($plan_id))
        ->requireCapabilities(
          array(
            PhabricatorPolicyCapability::CAN_VIEW,
            PhabricatorPolicyCapability::CAN_EDIT,
          ))
        ->executeOne();
      if (!$plan) {
        return new Aphront404Response();
      }

      $impl = HarbormasterBuildStepImplementation::getImplementation($class);
      if (!$impl) {
        return new Aphront404Response();
      }

      if ($impl->shouldRequireAutotargeting()) {
        // No manual creation of autotarget steps.
        return new Aphront404Response();
      }

      $step = HarbormasterBuildStep::initializeNewStep($viewer)
        ->setBuildPlanPHID($plan->getPHID())
        ->setClassName($class);

      $is_new = true;
    }

    $plan_uri = $this->getApplicationURI('plan/'.$plan->getID().'/');

    if ($is_new) {
      $cancel_uri = $plan_uri;
    } else {
      $cancel_uri = $this->getApplicationURI('step/view/'.$step->getID().'/');
    }

    $implementation = $step->getStepImplementation();

    $field_list = PhabricatorCustomField::getObjectFields(
      $step,
      PhabricatorCustomField::ROLE_EDIT);
    $field_list
      ->setViewer($viewer)
      ->readFieldsFromStorage($step);

    $e_name = true;
    $v_name = $step->getName();
    $e_description = null;
    $v_description = $step->getDescription();
    $e_depends_on = null;
    $v_depends_on = $step->getDetail('dependsOn', array());

    $errors = array();
    $validation_exception = null;
    if ($request->isFormPost()) {
      $e_name = null;
      $v_name = $request->getStr('name');
      $v_description = $request->getStr('description');
      $v_depends_on = $request->getArr('dependsOn');

      $xactions = $field_list->buildFieldTransactionsFromRequest(
        new HarbormasterBuildStepTransaction(),
        $request);

      $editor = id(new HarbormasterBuildStepEditor())
        ->setActor($viewer)
        ->setContinueOnNoEffect(true)
        ->setContentSourceFromRequest($request);

      $name_xaction = id(new HarbormasterBuildStepTransaction())
        ->setTransactionType(HarbormasterBuildStepTransaction::TYPE_NAME)
        ->setNewValue($v_name);
      array_unshift($xactions, $name_xaction);

      $depends_on_xaction = id(new HarbormasterBuildStepTransaction())
        ->setTransactionType(
          HarbormasterBuildStepTransaction::TYPE_DEPENDS_ON)
        ->setNewValue($v_depends_on);
      array_unshift($xactions, $depends_on_xaction);

      $description_xaction = id(new HarbormasterBuildStepTransaction())
        ->setTransactionType(
          HarbormasterBuildStepTransaction::TYPE_DESCRIPTION)
        ->setNewValue($v_description);
      array_unshift($xactions, $description_xaction);

      if ($is_new) {
        // When creating a new step, make sure we have a create transaction
        // so we'll apply the transactions even if the step has no
        // configurable options.
        $create_xaction = id(new HarbormasterBuildStepTransaction())
          ->setTransactionType(HarbormasterBuildStepTransaction::TYPE_CREATE);
        array_unshift($xactions, $create_xaction);
      }

      try {
        $editor->applyTransactions($step, $xactions);

        $step_uri = $this->getApplicationURI('step/view/'.$step->getID().'/');

        return id(new AphrontRedirectResponse())->setURI($step_uri);
      } catch (PhabricatorApplicationTransactionValidationException $ex) {
        $validation_exception = $ex;
      }
    }

    $form = id(new AphrontFormView())
      ->setUser($viewer);

    $instructions = $implementation->getEditInstructions();
    if (strlen($instructions)) {
      $form->appendRemarkupInstructions($instructions);
    }

    $form->appendChild(
      id(new AphrontFormTextControl())
        ->setName('name')
        ->setLabel(pht('Name'))
        ->setError($e_name)
        ->setValue($v_name));

    $form->appendChild(id(new AphrontFormDividerControl()));

    $field_list->appendFieldsToForm($form);

    $form->appendChild(id(new AphrontFormDividerControl()));

    $form
      ->appendControl(
        id(new AphrontFormTokenizerControl())
          ->setDatasource(id(new HarbormasterBuildDependencyDatasource())
            ->setParameters(array(
              'planPHID' => $plan->getPHID(),
              'stepPHID' => $is_new ? null : $step->getPHID(),
            )))
          ->setName('dependsOn')
          ->setLabel(pht('Depends On'))
          ->setError($e_depends_on)
          ->setValue($v_depends_on));

    $form
      ->appendChild(
        id(new PhabricatorRemarkupControl())
          ->setUser($viewer)
          ->setName('description')
          ->setLabel(pht('Description'))
          ->setError($e_description)
          ->setValue($v_description));

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

    if ($is_new) {
      $submit = pht('Create Build Step');
      $header = id(new PHUIHeaderView())
        ->setHeader(pht('New Step: %s', $implementation->getName()))
        ->setHeaderIcon('fa-plus-square');
      $crumbs->addTextCrumb(pht('Add Step'));
    } else {
      $submit = pht('Save Build Step');
      $header = id(new PHUIHeaderView())
        ->setHeader(pht('Edit Step: %s', $implementation->getName()))
        ->setHeaderIcon('fa-pencil');
      $crumbs->addTextCrumb(pht('Step %d', $step->getID()), $cancel_uri);
      $crumbs->addTextCrumb(pht('Edit Step'));
    }
    $crumbs->setBorder(true);

    $form->appendChild(
      id(new AphrontFormSubmitControl())
        ->setValue($submit)
        ->addCancelButton($cancel_uri));

    $box = id(new PHUIObjectBoxView())
      ->setHeaderText(pht('Step'))
      ->setValidationException($validation_exception)
      ->setBackground(PHUIObjectBoxView::BLUE_PROPERTY)
      ->setForm($form);

    $variables = $this->renderBuildVariablesTable();

    if ($is_new) {
      $xaction_view = null;
      $timeline = null;
    } else {
      $timeline = $this->buildTransactionTimeline(
        $step,
        new HarbormasterBuildStepTransactionQuery());
      $timeline->setShouldTerminate(true);
    }

    $view = id(new PHUITwoColumnView())
      ->setHeader($header)
      ->setFooter(array(
        $box,
        $variables,
        $timeline,
      ));

    return $this->newPage()
      ->setTitle($implementation->getName())
      ->setCrumbs($crumbs)
      ->appendChild($view);

  }

  private function renderBuildVariablesTable() {
    $viewer = $this->getRequest()->getUser();

    $variables = HarbormasterBuild::getAvailableBuildVariables();
    ksort($variables);

    $rows = array();
    $rows[] = pht(
      'The following variables can be used in most fields. '.
      'To reference a variable, use `%s` in a field.',
      '${name}');
    $rows[] = sprintf(
      '| %s | %s |',
      pht('Variable'),
      pht('Description'));
    $rows[] = '|---|---|';
    foreach ($variables as $name => $description) {
      $rows[] = '| `'.$name.'` | '.$description.' |';
    }
    $rows = implode("\n", $rows);

    $form = id(new AphrontFormView())
      ->setUser($viewer)
      ->appendRemarkupInstructions($rows);

    return id(new PHUIObjectBoxView())
      ->setHeaderText(pht('Build Variables'))
      ->setBackground(PHUIObjectBoxView::BLUE_PROPERTY)
      ->appendChild($form);
  }

}