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

   1 <?php
   2
   3 /**
   4  * @task autoplan Autoplans
   5  */
   6 final class HarbormasterBuildPlan extends HarbormasterDAO
   7   implements
   8     PhabricatorApplicationTransactionInterface,
   9     PhabricatorPolicyInterface,
  10     PhabricatorSubscribableInterface,
  11     PhabricatorNgramsInterface,
  12     PhabricatorConduitResultInterface,
  13     PhabricatorProjectInterface,
  14     PhabricatorPolicyCodexInterface {
  15
  16   protected $name;
  17   protected $planStatus;
  18   protected $planAutoKey;
  19   protected $viewPolicy;
  20   protected $editPolicy;
  21   protected $properties = array();
  22
  23   const STATUS_ACTIVE   = 'active';
  24   const STATUS_DISABLED = 'disabled';
  25
  26   private $buildSteps = self::ATTACHABLE;
  27
  28   public static function initializeNewBuildPlan(PhabricatorUser $actor) {
  29     $app = id(new PhabricatorApplicationQuery())
  30       ->setViewer($actor)
  31       ->withClasses(array('PhabricatorHarbormasterApplication'))
  32       ->executeOne();
  33
  34     $view_policy = $app->getPolicy(
  35       HarbormasterBuildPlanDefaultViewCapability::CAPABILITY);
  36     $edit_policy = $app->getPolicy(
  37       HarbormasterBuildPlanDefaultEditCapability::CAPABILITY);
  38
  39     return id(new HarbormasterBuildPlan())
  40       ->setName('')
  41       ->setPlanStatus(self::STATUS_ACTIVE)
  42       ->attachBuildSteps(array())
  43       ->setViewPolicy($view_policy)
  44       ->setEditPolicy($edit_policy);
  45   }
  46
  47   protected function getConfiguration() {
  48     return array(
  49       self::CONFIG_AUX_PHID => true,
  50       self::CONFIG_SERIALIZATION => array(
  51         'properties' => self::SERIALIZATION_JSON,
  52       ),
  53       self::CONFIG_COLUMN_SCHEMA => array(
  54         'name' => 'sort128',
  55         'planStatus' => 'text32',
  56         'planAutoKey' => 'text32?',
  57       ),
  58       self::CONFIG_KEY_SCHEMA => array(
  59         'key_status' => array(
  60           'columns' => array('planStatus'),
  61         ),
  62         'key_name' => array(
  63           'columns' => array('name'),
  64         ),
  65         'key_planautokey' => array(
  66           'columns' => array('planAutoKey'),
  67           'unique' => true,
  68         ),
  69       ),
  70     ) + parent::getConfiguration();
  71   }
  72
  73   public function generatePHID() {
  74     return PhabricatorPHID::generateNewPHID(
  75       HarbormasterBuildPlanPHIDType::TYPECONST);
  76   }
  77
  78   public function attachBuildSteps(array $steps) {
  79     assert_instances_of($steps, 'HarbormasterBuildStep');
  80     $this->buildSteps = $steps;
  81     return $this;
  82   }
  83
  84   public function getBuildSteps() {
  85     return $this->assertAttached($this->buildSteps);
  86   }
  87
  88   public function isDisabled() {
  89     return ($this->getPlanStatus() == self::STATUS_DISABLED);
  90   }
  91
  92   public function getURI() {
  93     return urisprintf(
  94       '/harbormaster/plan/%s/',
  95       $this->getID());
  96   }
  97
  98   public function getObjectName() {
  99     return pht('Plan %d', $this->getID());
 100   }
 101
 102   public function getPlanProperty($key, $default = null) {
 103     return idx($this->properties, $key, $default);
 104   }
 105
 106   public function setPlanProperty($key, $value) {
 107     $this->properties[$key] = $value;
 108     return $this;
 109   }
 110
 111
 112 /* -(  Autoplans  )---------------------------------------------------------- */
 113
 114
 115   public function isAutoplan() {
 116     return ($this->getPlanAutoKey() !== null);
 117   }
 118
 119
 120   public function getAutoplan() {
 121     if (!$this->isAutoplan()) {
 122       return null;
 123     }
 124
 125     return HarbormasterBuildAutoplan::getAutoplan($this->getPlanAutoKey());
 126   }
 127
 128
 129   public function canRunManually() {
 130     if ($this->isAutoplan()) {
 131       return false;
 132     }
 133
 134     return true;
 135   }
 136
 137   public function getName() {
 138     $autoplan = $this->getAutoplan();
 139     if ($autoplan) {
 140       return $autoplan->getAutoplanName();
 141     }
 142
 143     return parent::getName();
 144   }
 145
 146   public function hasRunCapability(PhabricatorUser $viewer) {
 147     try {
 148       $this->assertHasRunCapability($viewer);
 149       return true;
 150     } catch (PhabricatorPolicyException $ex) {
 151       return false;
 152     }
 153   }
 154
 155   public function canRunWithoutEditCapability() {
 156     $runnable = HarbormasterBuildPlanBehavior::BEHAVIOR_RUNNABLE;
 157     $if_viewable = HarbormasterBuildPlanBehavior::RUNNABLE_IF_VIEWABLE;
 158
 159     $option = HarbormasterBuildPlanBehavior::getBehavior($runnable)
 160       ->getPlanOption($this);
 161
 162     return ($option->getKey() === $if_viewable);
 163   }
 164
 165   public function assertHasRunCapability(PhabricatorUser $viewer) {
 166     if ($this->canRunWithoutEditCapability()) {
 167       $capability = PhabricatorPolicyCapability::CAN_VIEW;
 168     } else {
 169       $capability = PhabricatorPolicyCapability::CAN_EDIT;
 170     }
 171
 172     PhabricatorPolicyFilter::requireCapability(
 173       $viewer,
 174       $this,
 175       $capability);
 176   }
 177
 178
 179 /* -(  PhabricatorSubscribableInterface  )----------------------------------- */
 180
 181
 182   public function isAutomaticallySubscribed($phid) {
 183     return false;
 184   }
 185
 186
 187 /* -(  PhabricatorApplicationTransactionInterface  )------------------------- */
 188
 189
 190   public function getApplicationTransactionEditor() {
 191     return new HarbormasterBuildPlanEditor();
 192   }
 193
 194   public function getApplicationTransactionTemplate() {
 195     return new HarbormasterBuildPlanTransaction();
 196   }
 197
 198 /* -(  PhabricatorPolicyInterface  )----------------------------------------- */
 199
 200
 201   public function getCapabilities() {
 202     return array(
 203       PhabricatorPolicyCapability::CAN_VIEW,
 204       PhabricatorPolicyCapability::CAN_EDIT,
 205     );
 206   }
 207
 208   public function getPolicy($capability) {
 209     switch ($capability) {
 210       case PhabricatorPolicyCapability::CAN_VIEW:
 211         if ($this->isAutoplan()) {
 212           return PhabricatorPolicies::getMostOpenPolicy();
 213         }
 214         return $this->getViewPolicy();
 215       case PhabricatorPolicyCapability::CAN_EDIT:
 216         if ($this->isAutoplan()) {
 217           return PhabricatorPolicies::POLICY_NOONE;
 218         }
 219         return $this->getEditPolicy();
 220     }
 221   }
 222
 223   public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
 224     return false;
 225   }
 226
 227   public function describeAutomaticCapability($capability) {
 228     $messages = array();
 229
 230     switch ($capability) {
 231       case PhabricatorPolicyCapability::CAN_EDIT:
 232         if ($this->isAutoplan()) {
 233           $messages[] = pht(
 234             'This is an autoplan (a builtin plan provided by an application) '.
 235             'so it can not be edited.');
 236         }
 237         break;
 238     }
 239
 240     return $messages;
 241   }
 242
 243
 244 /* -(  PhabricatorNgramsInterface  )----------------------------------------- */
 245
 246
 247   public function newNgrams() {
 248     return array(
 249       id(new HarbormasterBuildPlanNameNgrams())
 250         ->setValue($this->getName()),
 251     );
 252   }
 253
 254
 255 /* -(  PhabricatorConduitResultInterface  )---------------------------------- */
 256
 257
 258   public function getFieldSpecificationsForConduit() {
 259     return array(
 260       id(new PhabricatorConduitSearchFieldSpecification())
 261         ->setKey('name')
 262         ->setType('string')
 263         ->setDescription(pht('The name of this build plan.')),
 264       id(new PhabricatorConduitSearchFieldSpecification())
 265         ->setKey('status')
 266         ->setType('map<string, wild>')
 267         ->setDescription(pht('The current status of this build plan.')),
 268       id(new PhabricatorConduitSearchFieldSpecification())
 269         ->setKey('behaviors')
 270         ->setType('map<string, string>')
 271         ->setDescription(pht('Behavior configuration for the build plan.')),
 272     );
 273   }
 274
 275   public function getFieldValuesForConduit() {
 276     $behavior_map = array();
 277
 278     $behaviors = HarbormasterBuildPlanBehavior::newPlanBehaviors();
 279     foreach ($behaviors as $behavior) {
 280       $option = $behavior->getPlanOption($this);
 281
 282       $behavior_map[$behavior->getKey()] = array(
 283         'value' => $option->getKey(),
 284       );
 285     }
 286
 287     return array(
 288       'name' => $this->getName(),
 289       'status' => array(
 290         'value' => $this->getPlanStatus(),
 291       ),
 292       'behaviors' => $behavior_map,
 293     );
 294   }
 295
 296   public function getConduitSearchAttachments() {
 297     return array();
 298   }
 299
 300
 301 /* -(  PhabricatorPolicyCodexInterface  )------------------------------------ */
 302
 303
 304   public function newPolicyCodex() {
 305     return new HarbormasterBuildPlanPolicyCodex();
 306   }
 307
 308 }