src/applications/harbormaster/storage/configuration/HarbormasterBuildStep.php

   1 <?php
   2
   3 final class HarbormasterBuildStep extends HarbormasterDAO
   4   implements
   5     PhabricatorApplicationTransactionInterface,
   6     PhabricatorPolicyInterface,
   7     PhabricatorCustomFieldInterface,
   8     PhabricatorConduitResultInterface {
   9
  10   protected $name;
  11   protected $description;
  12   protected $buildPlanPHID;
  13   protected $className;
  14   protected $details = array();
  15   protected $sequence = 0;
  16   protected $stepAutoKey;
  17
  18   private $buildPlan = self::ATTACHABLE;
  19   private $customFields = self::ATTACHABLE;
  20   private $implementation;
  21
  22   public static function initializeNewStep(PhabricatorUser $actor) {
  23     return id(new HarbormasterBuildStep())
  24       ->setName('')
  25       ->setDescription('');
  26   }
  27
  28   protected function getConfiguration() {
  29     return array(
  30       self::CONFIG_AUX_PHID => true,
  31       self::CONFIG_SERIALIZATION => array(
  32         'details' => self::SERIALIZATION_JSON,
  33       ),
  34       self::CONFIG_COLUMN_SCHEMA => array(
  35         'className' => 'text255',
  36         'sequence' => 'uint32',
  37         'description' => 'text',
  38
  39         // T6203/NULLABILITY
  40         // This should not be nullable. Current `null` values indicate steps
  41         // which predated editable names. These should be backfilled with
  42         // default names, then the code for handling `null` should be removed.
  43         'name' => 'text255?',
  44         'stepAutoKey' => 'text32?',
  45       ),
  46       self::CONFIG_KEY_SCHEMA => array(
  47         'key_plan' => array(
  48           'columns' => array('buildPlanPHID'),
  49         ),
  50         'key_stepautokey' => array(
  51           'columns' => array('buildPlanPHID', 'stepAutoKey'),
  52           'unique' => true,
  53         ),
  54       ),
  55     ) + parent::getConfiguration();
  56   }
  57
  58   public function generatePHID() {
  59     return PhabricatorPHID::generateNewPHID(
  60       HarbormasterBuildStepPHIDType::TYPECONST);
  61   }
  62
  63   public function attachBuildPlan(HarbormasterBuildPlan $plan) {
  64     $this->buildPlan = $plan;
  65     return $this;
  66   }
  67
  68   public function getBuildPlan() {
  69     return $this->assertAttached($this->buildPlan);
  70   }
  71
  72   public function getDetail($key, $default = null) {
  73     return idx($this->details, $key, $default);
  74   }
  75
  76   public function setDetail($key, $value) {
  77     $this->details[$key] = $value;
  78     return $this;
  79   }
  80
  81   public function getName() {
  82     if (strlen($this->name)) {
  83       return $this->name;
  84     }
  85
  86     return $this->getStepImplementation()->getName();
  87   }
  88
  89   public function getStepImplementation() {
  90     if ($this->implementation === null) {
  91       $obj = HarbormasterBuildStepImplementation::requireImplementation(
  92         $this->className);
  93       $obj->loadSettings($this);
  94       $this->implementation = $obj;
  95     }
  96
  97     return $this->implementation;
  98   }
  99
 100   public function isAutostep() {
 101     return ($this->getStepAutoKey() !== null);
 102   }
 103
 104   public function willStartBuild(
 105     PhabricatorUser $viewer,
 106     HarbormasterBuildable $buildable,
 107     HarbormasterBuild $build,
 108     HarbormasterBuildPlan $plan) {
 109     return $this->getStepImplementation()->willStartBuild(
 110       $viewer,
 111       $buildable,
 112       $build,
 113       $plan,
 114       $this);
 115   }
 116
 117
 118 /* -(  PhabricatorApplicationTransactionInterface  )------------------------- */
 119
 120
 121   public function getApplicationTransactionEditor() {
 122     return new HarbormasterBuildStepEditor();
 123   }
 124
 125   public function getApplicationTransactionTemplate() {
 126     return new HarbormasterBuildStepTransaction();
 127   }
 128
 129
 130 /* -(  PhabricatorPolicyInterface  )----------------------------------------- */
 131
 132
 133   public function getCapabilities() {
 134     return array(
 135       PhabricatorPolicyCapability::CAN_VIEW,
 136       PhabricatorPolicyCapability::CAN_EDIT,
 137     );
 138   }
 139
 140   public function getPolicy($capability) {
 141     return $this->getBuildPlan()->getPolicy($capability);
 142   }
 143
 144   public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
 145     return $this->getBuildPlan()->hasAutomaticCapability($capability, $viewer);
 146   }
 147
 148   public function describeAutomaticCapability($capability) {
 149     return pht('A build step has the same policies as its build plan.');
 150   }
 151
 152
 153 /* -(  PhabricatorCustomFieldInterface  )------------------------------------ */
 154
 155
 156   public function getCustomFieldSpecificationForRole($role) {
 157     return array();
 158   }
 159
 160   public function getCustomFieldBaseClass() {
 161     return 'HarbormasterBuildStepCustomField';
 162   }
 163
 164   public function getCustomFields() {
 165     return $this->assertAttached($this->customFields);
 166   }
 167
 168   public function attachCustomFields(PhabricatorCustomFieldAttachment $fields) {
 169     $this->customFields = $fields;
 170     return $this;
 171   }
 172
 173 /* -(  PhabricatorConduitResultInterface  )---------------------------------- */
 174
 175
 176   public function getFieldSpecificationsForConduit() {
 177     return array(
 178       id(new PhabricatorConduitSearchFieldSpecification())
 179         ->setKey('name')
 180         ->setType('string')
 181         ->setDescription(pht('The name of the build step.')),
 182       id(new PhabricatorConduitSearchFieldSpecification())
 183         ->setKey('description')
 184         ->setType('remarkup')
 185         ->setDescription(pht('The build step description.')),
 186       id(new PhabricatorConduitSearchFieldSpecification())
 187         ->setKey('buildPlanPHID')
 188         ->setType('phid')
 189         ->setDescription(
 190           pht(
 191             'The PHID of the build plan this build step belongs to.')),
 192     );
 193   }
 194
 195   public function getFieldValuesForConduit() {
 196     // T6203: This can be removed once the field becomes non-nullable.
 197     $name = $this->getName();
 198     $name = phutil_string_cast($name);
 199
 200     return array(
 201       'name' => $name,
 202       'description' => array(
 203         'raw' => $this->getDescription(),
 204       ),
 205       'buildPlanPHID' => $this->getBuildPlanPHID(),
 206     );
 207   }
 208
 209   public function getConduitSearchAttachments() {
 210     return array();
 211   }
 212
 213
 214 }