Differential D16981 Diff 41128 src/applications/release/storage/ReleaseRelease.php

Changeset View

Standalone View

src/applications/release/storage/ReleaseRelease.php

This file was added.

				<?php
				Lint: Newline After PHP Open Tag Inline Actions `<?php` should be separated from code by an empty line. Lint: Newline After PHP Open Tag: `<?php` should be separated from code by an empty line.
				// TODO space?
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				final class ReleaseRelease extends PhabricatorReleaseDAO
				implements
				PhabricatorApplicationTransactionInterface,
				PhabricatorSubscribableInterface,
				PhabricatorFlaggableInterface,
				PhabricatorMentionableInterface,
				PhabricatorConduitResultInterface,
				PhabricatorCustomFieldInterface,
				PhabricatorPolicyInterface {

				const STATE_PLANNED = 'planned';
				const STATE_TESTING = 'testing';
				const STATE_PRODUCTION = 'production';
				const STATE_OBSOLETE = 'obsolete';
				const STATE_INVALID = 'invalid';

				const DETAIL_CUTPOINTS = 'cutpoints';
				const DETAIL_CURRENTREF = 'currentref';

				protected $name;
				protected $state = self::STATE_PLANNED;
				protected $description = '';
				protected $releaseTemplateKey;
				protected $details = array();

				protected $viewPolicy;
				protected $editPolicy;

				protected $mailKey;

				public static function initializeNewRelease(PhabricatorUser $actor) {
				$release_application = id(new PhabricatorApplicationQuery())
				->setViewer($actor)
				->withClasses(array('PhabricatorReleaseApplication'))
				->executeOne();

				$view_policy = $release_application->getPolicy(
				ReleaseReleaseDefaultViewCapability::CAPABILITY);

				$edit_policy = $release_application->getPolicy(
				ReleaseReleaseDefaultEditCapability::CAPABILITY);

				return id(new self())
				->setViewPolicy($view_policy)
				->setEditPolicy($edit_policy);
				}

				protected function getConfiguration() {
				return array(
				self::CONFIG_AUX_PHID => true,
				self::CONFIG_SERIALIZATION => array(
				'details' => self::SERIALIZATION_JSON,
				),
				self::CONFIG_COLUMN_SCHEMA => array(
				'name' => 'sort128',
				'state' => 'text12',
				'description' => 'text',
				'releaseTemplateKey' => 'text12',
				'mailKey' => 'bytes20',
				),
				self::CONFIG_KEY_SCHEMA => array(
				'key_name' => array(
				'columns' => array('name'),
				'unique' => false,
				),
				'key_state' => array(
				'columns' => array('state'),
				'unique' => false,
				),
				),
				) + parent::getConfiguration();
				}

				public function generatePHID() {
				return PhabricatorPHID::generateNewPHID(
				ReleaseReleasePHIDType::TYPECONST);
				}

				public function save() {
				if (!$this->getMailKey()) {
				$this->setMailKey(Filesystem::readRandomCharacters(20));
				}
				return parent::save();
				}

				public function getURI() {
				return '/X'.$this->getID();
				}

				public function getMonogram() {
				return 'X'.$this->getID();
				}

				public function getStateName() {
				return idx(self::getStatesMap(), $this->state, $this->state);
				}

				public function getReleaseTemplateName() {
				return idx(
				PhabricatorReleaseTemplate::getTemplatesMap(),
				$this->releaseTemplateKey,
				$this->releaseTemplateKey);
				}

				public function getReleaseTemplate() {
				return PhabricatorReleaseTemplate::getTemplatesInstance(
				$this->releaseTemplateKey);
				}

				/**
				* closed, deleted, canceled, whatever.
				*/
				public function isClosed() {
				switch ($this->state) {
				case self::STATE_OBSOLETE:
				case self::STATE_INVALID:
				return true;
				}
				return false;
				}

				public function getDetail($key, $default = null) {
				return idx($this->details, $key, $default);
				}

				public function setDetail($key, $value) {
				$this->details[$key] = $value;
				return $this;
				}

				public static function getStatesMap() {
				return array(
				self::STATE_PLANNED => pht('Planned'),
				self::STATE_TESTING => pht('In Testing'),
				self::STATE_PRODUCTION => pht('In Production'),
				self::STATE_OBSOLETE => pht('Obsolete'),
				self::STATE_INVALID => pht('Invalid'),
				);
				}
				public static function getOpenStates() {
				return array(
				self::STATE_PLANNED,
				self::STATE_TESTING,
				self::STATE_PRODUCTION,
				);
				}

				public function getCurrentRefs() {
				return $this->getDetail(self::DETAIL_CURRENTREF, array());
				}

				public function getCutpoints() {
				return $this->getDetail(self::DETAIL_CUTPOINTS, array());
				}

				public function isRefMutable($ref) {
				return !preg_match('/[a-f0-9]{40}/', $ref);
				}

				public function getSimpleRefName($ref) {
				if (!$this->isRefMutable($ref)) {
				return $ref;
				}

				$count = 0;
				$branch = preg_replace('/^refs\/heads\//', '', $ref, 1, $count);

				return $branch;
				}

				public function getNormalizedName() {
				return preg_replace('/[^0-9a-zA-Z\.-]+\|\.\./', '_', $this->getName());
				}

				/* -( PhabricatorApplicationTransactionInterface )------------------------- */

				public function getApplicationTransactionEditor() {
				return new ReleaseReleaseEditor();
				}

				public function getApplicationTransactionObject() {
				return $this;
				}

				public function getApplicationTransactionTemplate() {
				return new ReleaseReleaseTransaction();
				}

				public function willRenderTimeline(
				PhabricatorApplicationTransactionView $timeline,
				AphrontRequest $request) {

				return $timeline;
				}


				/* -( PhabricatorSubscribableInterface )----------------------------------- */

				public function isAutomaticallySubscribed($phid) {
				return false;
				}

				/* -( PhabricatorConduitResultInterface )---------------------------------- */

				public function getFieldSpecificationsForConduit() {
				return array(
				id(new PhabricatorConduitSearchFieldSpecification())
				->setKey('name')
				->setType('string')
				->setDescription(pht('The name of the release.')),
				id(new PhabricatorConduitSearchFieldSpecification())
				->setKey('state')
				->setType('string')
				->setDescription(pht('Status of the release.')),
				id(new PhabricatorConduitSearchFieldSpecification())
				->setKey('type')
				->setType('string')
				->setDescription(pht('Type of the release.')),
				id(new PhabricatorConduitSearchFieldSpecification())
				->setKey('cut_points')
				->setType('map<phid, hash>')
				->setDescription(pht('Hashes where this release was cut from')),
				id(new PhabricatorConduitSearchFieldSpecification())
				->setKey('current_refs')
				->setType('map<phid, hash>')
				->setDescription(pht('Current hashes/branches of this release')),
				);
				}

				public function getFieldValuesForConduit() {
				return array(
				'name' => $this->getName(),
				'state' => $this->getState(),
				'type' => $this->getReleaseTemplateKey(),
				'cut_points' => $this->getCutpoints(),
				'current_refs' => $this->getCurrentRefs(),
				);
				}

				public function getConduitSearchAttachments() {
				return array();
				}

				/* -( PhabricatorCustomFieldInterface )------------------------------------ */

				private $customFields = self::ATTACHABLE;

				public function getCustomFieldSpecificationForRole($role) {
				return array(); // TODO ?
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				}

				public function getCustomFieldBaseClass() {
				return 'ReleaseCustomField';
				}

				public function getCustomFields() {
				return $this->assertAttached($this->customFields);
				}

				public function attachCustomFields(PhabricatorCustomFieldAttachment $fields) {
				$this->customFields = $fields;
				return $this;
				}


				/* -( PhabricatorPolicyInterface )----------------------------------------- */

				public function getCapabilities() {
				return array(
				PhabricatorPolicyCapability::CAN_VIEW,
				PhabricatorPolicyCapability::CAN_EDIT,
				);
				}

				public function getPolicy($capability) {
				switch ($capability) {
				case PhabricatorPolicyCapability::CAN_VIEW:
				return $this->getViewPolicy();
				case PhabricatorPolicyCapability::CAN_EDIT:
				return $this->getEditPolicy();
				}
				}

				public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
				return false;
				}

				public function describeAutomaticCapability($capability) {
				return null;
				}
				}