DeployDispatcher

Complexity

Total Complexity

20

Size/Duplication

Total Lines	192
Duplicated Lines	7.81 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes	3
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	15	15	3
A	index()	0	3	1
B	history()	0	40	6
B	start()	0	30	1
C	log()	0	26	7
A	Link()	0	3	1
A	getModel()	0	3	1

<?php

/**
 * This dispatcher takes care of updating and returning information about this
 * projects git repository
 */
class DeployDispatcher extends Dispatcher {

	const ACTION_DEPLOY = 'deploy';

	/**
	 * @var array
	 */
	private static $action_types = [
		self::ACTION_DEPLOY
	];

	/**
	 * @var array
	 */
	public static $allowed_actions = [
		'history',
		'start',
		'log'
	];

	/**
	 * @var \DNProject
	 */
	protected $project = null;

	/**
	 * @var \DNEnvironment
	 */
	protected $environment = null;

	public function init() {

This method seems to be duplicated in your project.

		parent::init();

		$this->project = $this->getCurrentProject();

		if(!$this->project) {
			return $this->project404Response();
		}

		// Performs canView permission check by limiting visible projects
		$this->environment = $this->getCurrentEnvironment($this->project);
		if(!$this->environment) {
			return $this->environment404Response();
		}
	}

	/**
	 *
	 * @param \SS_HTTPRequest $request
	 *
	 * @return \HTMLText|\SS_HTTPResponse
	 */
	public function index(\SS_HTTPRequest $request) {
		return $this->redirect(\Controller::join_links($this->Link(), 'history'), 302);
	}

	/**
	 * @return SS_HTTPResponse
	 */
	public function history(SS_HTTPRequest $request) {
		$data = [];
		$list = $this->DeployHistory();
		$page = $request->getVar('page') ?: 1;
		if ($page > $list->TotalPages()) {
			$page = 1;
		}
		if ($page < 1) {
			$page = 1;
		}
		$start = ($page - 1) * $list->getPageLength();
		$list->setPageStart((int) $start);
		if (empty($list)) {
			return $this->getAPIResponse(['message' => 'No deploy history'], 404);
		}

		foreach ($list as $deployment) {
			$data[] = [
				'CreatedDate' => $deployment->Created,
				'Branch' => $deployment->Branch,
				'Tags' => $deployment->getTags()->toArray(),
				'Changes' => $deployment->getDeploymentStrategy()->getChanges(),
				'CommitMessage' => $deployment->getCommitMessage(),
				'Deployer' => $deployment->Deployer()->getName(),
				'Approver' => $deployment->Approver()->getName(),
				'State' => $deployment->State,
			];
		}

		return $this->getAPIResponse(
			[
				'list' => $data,
				'pagelength' => $list->getPageLength(),
				'pagestart' => $list->getPageStart(),
				'totalpages' => $list->TotalPages(),
				'currentpage' => $list->CurrentPage()
			],
			200
		);
	}

	/**
	 *
	 * @param SS_HTTPRequest $request
	 *
	 * @return SS_HTTPResponse
	 * @throws ValidationException
	 * @throws null
	 */
	public function start(SS_HTTPRequest $request) {
		$this->checkSecurityToken();

		// @todo permission checks?

		// Initiate the deployment
		// The extension point should pass in: Project, Environment, SelectRelease, buildName
		// @todo: compat breakage: check what extends this in DNRoot and switch it to this dispatcher
		$this->extend('doDeploy', $this->project, $this->environment, $buildName, $data);

		$options = [
			'sha' => $request->requestVar('sha'),
		];

		// @todo replan and check if it's changed compared since it was originally planned?
		$strategy = $this->environment->Backend()->planDeploy($this->environment, $options);

		$strategy->fromArray($request->requestVars());
		$deployment = $strategy->createDeployment();
		// Skip through the approval state for now.
		$deployment->getMachine()->apply(DNDeployment::TR_SUBMIT);
		$deployment->getMachine()->apply(DNDeployment::TR_QUEUE);

		$output = [
			'message' => 'deployed queued',
			'deployID' => $deployment->ID,
		];

		return $this->getAPIResponse($output, 201);
	}

	/**
	    * Action - Get the latest deploy log
	    *
	    * @param SS_HTTPRequest $request
	    *
	    * @return string
	    * @throws SS_HTTPResponse_Exception
	    */
	public function log(SS_HTTPRequest $request) {
		$params = $request->params();
		$deployment = DNDeployment::get()->byId($params['ID']);
		if(!$deployment || !$deployment->ID) {
			throw new SS_HTTPResponse_Exception('Deployment not found', 404);
		}
		if(!$deployment->canView()) {
			return Security::permissionFailure();
		}
		if($this->environment->Name != $params['Environment']) {
			throw new LogicException("Environment in URL doesn't match this deploy");
		}
		if($this->project->Name != $params['Project']) {
			throw new LogicException("Project in URL doesn't match this deploy");
		}
		$log = $deployment->log();
		if($log->exists()) {
			$content = $log->content();
		} else {
			$content = 'Waiting for action to start';
		}

		$lines = explode(PHP_EOL, $content);

		return $this->getAPIResponse(['message' => $lines, 'status' => $deployment->ResqueStatus()], 200);
	}


	/**
	 * @return string
	 */
	public function Link() {
		return \Controller::join_links($this->project->Link(), self::ACTION_DEPLOY);
	}

	/**
	 * @param string $name
	 *
	 * @return array
	 */
	public function getModel($name = '') {
		return [];
	}

}