silverstripe / deploynaut

code/model/DNProject.php

Doc Comments +1 added lines, -1 removed lines

@@ -1134,7 +1134,7 @@
 	 * This is a proxy call to gitonmy that caches the information per project and sha
 	 *
 	 * @param string $sha
-	 * @return false|\Gitonomy\Git\Commit
+	 * @return Gitonomy\Git\Commit
 	 */
 	public function getCommit($sha) {
 		$repo = $this->getRepository();

Spacing +72 added lines, -72 removed lines

@@ -109,7 +109,7 @@ 
 
 		// add the administrators group as the viewers of the new project
 		$adminGroup = Group::get()->filter('Code', 'administrators')->first();
-		if($adminGroup && $adminGroup->exists()) {
+		if ($adminGroup && $adminGroup->exists()) {
 			$project->Viewers()->add($adminGroup);
 		}
 		return $project;
@@ -131,7 +131,7 @@ 
 	public static function get_git_cache() {
 		return SS_Cache::factory('gitonomy', 'Output', [
 			'automatic_serialization' => true,
-			'lifetime' => 60*60*24*7 // seven days
+			'lifetime' => 60 * 60 * 24 * 7 // seven days
 		]);
 	}
 
@@ -144,8 +144,8 @@ 
 	public function getUsedQuotaMB($round = 2) {
 		$size = 0;
 
-		foreach($this->Environments() as $environment) {
-			foreach($environment->DataArchives()->filter('IsBackup', 0) as $archive) {
+		foreach ($this->Environments() as $environment) {
+			foreach ($environment->DataArchives()->filter('IsBackup', 0) as $archive) {
 				$size += $archive->ArchiveFile()->getAbsoluteSize();
 			}
 		}
@@ -164,7 +164,7 @@ 
 	public function getDiskQuotaMB() {
 		$size = $this->getField('DiskQuotaMB');
 
-		if(empty($size)) {
+		if (empty($size)) {
 			$defaults = $this->config()->get('defaults');
 			$size = (isset($defaults['DiskQuotaMB'])) ? $defaults['DiskQuotaMB'] : 0;
 		}
@@ -197,7 +197,7 @@ 
 	 */
 	public function DiskQuotaUsagePercent() {
 		$quota = $this->getDiskQuotaMB();
-		if($quota > 0) {
+		if ($quota > 0) {
 			return $this->getUsedQuotaMB() * 100 / $quota;
 		}
 		return 100;
@@ -214,7 +214,7 @@ 
 		$controller = Controller::curr();
 		$actionType = $controller->getField('CurrentActionType');
 
-		if(DNRoot::FlagSnapshotsEnabled() && $this->isProjectReady()) {
+		if (DNRoot::FlagSnapshotsEnabled() && $this->isProjectReady()) {
 			$list->push(new ArrayData(array(
 				'Link' => sprintf('naut/project/%s/snapshots', $this->Name),
 				'Title' => 'Snapshots',
@@ -265,11 +265,11 @@ 
 	 * @return boolean
 	 */
 	public function canView($member = null) {
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
 
-		if(Permission::checkMember($member, 'ADMIN')) {
+		if (Permission::checkMember($member, 'ADMIN')) {
 			return true;
 		}
 
@@ -292,7 +292,7 @@ 
 			return true;
 		}
 
-		return (bool)$this->Environments()->filterByCallback(function($env) use($member) {
+		return (bool) $this->Environments()->filterByCallback(function($env) use($member) {
 			return $env->canRestore($member);
 		})->Count();
 	}
@@ -312,7 +312,7 @@ 
 			return true;
 		}
 
-		return (bool)$this->Environments()->filterByCallback(function($env) use($member) {
+		return (bool) $this->Environments()->filterByCallback(function($env) use($member) {
 			return $env->canBackup($member);
 		})->Count();
 	}
@@ -332,7 +332,7 @@ 
 			return true;
 		}
 
-		return (bool)$this->Environments()->filterByCallback(function($env) use($member) {
+		return (bool) $this->Environments()->filterByCallback(function($env) use($member) {
 			return $env->canUploadArchive($member);
 		})->Count();
 	}
@@ -352,7 +352,7 @@ 
 			return true;
 		}
 
-		return (bool)$this->Environments()->filterByCallback(function($env) use($member) {
+		return (bool) $this->Environments()->filterByCallback(function($env) use($member) {
 			return $env->canDownloadArchive($member);
 		})->Count();
 	}
@@ -369,9 +369,9 @@ 
 	 */
 	public function canCreateEnvironments($member = null) {
 		$envType = $this->AllowedEnvironmentType;
-		if($envType) {
+		if ($envType) {
 			$env = Injector::inst()->get($envType);
-			if($env instanceof EnvironmentCreateBackend) {
+			if ($env instanceof EnvironmentCreateBackend) {
 				return $this->allowed(DNRoot::ALLOW_CREATE_ENVIRONMENT, $member);
 			}
 		}
@@ -407,11 +407,11 @@ 
 	 * @return array
 	 */
 	public function getProcessEnv() {
-		if(file_exists($this->getPrivateKeyPath())) {
+		if (file_exists($this->getPrivateKeyPath())) {
 			// Key-pair is available, use it.
 			$processEnv = array(
 				'IDENT_KEY' => $this->getPrivateKeyPath(),
-				'GIT_SSH' => BASE_PATH . "/deploynaut/git-deploy.sh"
+				'GIT_SSH' => BASE_PATH."/deploynaut/git-deploy.sh"
 			);
 		} else {
 			$processEnv = array();
@@ -452,7 +452,7 @@ 
 	 * @return DNBranchList
 	 */
 	public function DNBranchList() {
-		if($this->CVSPath && !$this->repoExists()) {
+		if ($this->CVSPath && !$this->repoExists()) {
 			$this->cloneRepo();
 		}
 		return DNBranchList::create($this, $this->DNData());
@@ -464,7 +464,7 @@ 
 	 * @return DNReferenceList
 	 */
 	public function DNTagList() {
-		if($this->CVSPath && !$this->repoExists()) {
+		if ($this->CVSPath && !$this->repoExists()) {
 			$this->cloneRepo();
 		}
 		return DNReferenceList::create($this, $this->DNData(), null, null, true);
@@ -474,7 +474,7 @@ 
 	 * @return false|Gitonomy\Git\Repository
 	 */
 	public function getRepository() {
-		if(!$this->repoExists()) {
+		if (!$this->repoExists()) {
 			return false;
 		}
 
@@ -489,11 +489,11 @@ 
 	 */
 	public function DNEnvironmentList() {
 
-		if(!self::$_current_member_cache) {
+		if (!self::$_current_member_cache) {
 			self::$_current_member_cache = Member::currentUser();
 		}
 
-		if(self::$_current_member_cache === false) {
+		if (self::$_current_member_cache === false) {
 			return new ArrayList();
 		}
 
@@ -518,9 +518,9 @@ 
 	 * @return false|DNDeployment
 	 */
 	public function currentBuilds() {
-		if(!isset(self::$relation_cache['currentBuilds.'.$this->ID])) {
+		if (!isset(self::$relation_cache['currentBuilds.'.$this->ID])) {
 			$currentBuilds = array();
-			foreach($this->Environments() as $env) {
+			foreach ($this->Environments() as $env) {
 				$currentBuilds[$env->Name] = $env->CurrentBuild();
 			}
 			self::$relation_cache['currentBuilds.'.$this->ID] = $currentBuilds;
@@ -540,7 +540,7 @@ 
 	 * @return string|null
 	 */
 	public function CreateEnvironmentLink() {
-		if($this->canCreateEnvironments()) {
+		if ($this->canCreateEnvironments()) {
 			return $this->Link('createenv');
 		}
 		return null;
@@ -558,11 +558,11 @@ 
 	 */
 	public function IsStarred() {
 		$member = Member::currentUser();
-		if($member === null) {
+		if ($member === null) {
 			return false;
 		}
 		$favourited = $this->StarredBy()->filter('MemberID', $member->ID);
-		if($favourited->count() == 0) {
+		if ($favourited->count() == 0) {
 			return false;
 		}
 		return true;
@@ -617,7 +617,7 @@ 
 
 		$environmentTypes = ClassInfo::implementorsOf('EnvironmentCreateBackend');
 		$types = array();
-		foreach($environmentTypes as $type) {
+		foreach ($environmentTypes as $type) {
 			$types[$type] = $type;
 		}
 
@@ -641,11 +641,11 @@ 
 	 */
 	public function setCreateProjectFolderField(&$fields) {
 		// Check if the capistrano project folder exists
-		if(!$this->Name) {
+		if (!$this->Name) {
 			return;
 		}
 
-		if($this->projectFolderExists()) {
+		if ($this->projectFolderExists()) {
 			return;
 		}
 
@@ -677,7 +677,7 @@ 
 	 */
 	public function cloneRepo() {
 		// Avoid this being called multiple times in the same request
-		if(!isset(self::$has_cloned_cache[$this->ID])) {
+		if (!isset(self::$has_cloned_cache[$this->ID])) {
 			$fetch = DNGitFetch::create();
 			$fetch->ProjectID = $this->ID;
 			$fetch->write();
@@ -701,7 +701,7 @@ 
 	public function onBeforeWrite() {
 		parent::onBeforeWrite();
 
-		if($this->CreateEnvFolder && !file_exists($this->getProjectFolderPath())) {
+		if ($this->CreateEnvFolder && !file_exists($this->getProjectFolderPath())) {
 			mkdir($this->getProjectFolderPath());
 		}
 	}
@@ -709,12 +709,12 @@ 
 	public function onAfterWrite() {
 		parent::onAfterWrite();
 
-		if(!$this->CVSPath) {
+		if (!$this->CVSPath) {
 			return;
 		}
 
 		$changedFields = $this->getChangedFields(true, 2);
-		if(isset($changedFields['CVSPath']) || isset($changedFields['Name'])) {
+		if (isset($changedFields['CVSPath']) || isset($changedFields['Name'])) {
 			$this->cloneRepo();
 		}
 	}
@@ -726,22 +726,22 @@ 
 		parent::onAfterDelete();
 
 		// Delete related environments
-		foreach($this->Environments() as $env) {
+		foreach ($this->Environments() as $env) {
 			$env->delete();
 		}
 
 		// Delete local repository
-		if(file_exists($this->getLocalCVSPath())) {
+		if (file_exists($this->getLocalCVSPath())) {
 			Filesystem::removeFolder($this->getLocalCVSPath());
 		}
 
 		// Delete project template
-		if(file_exists($this->getProjectFolderPath()) && Config::inst()->get('DNEnvironment', 'allow_web_editing')) {
+		if (file_exists($this->getProjectFolderPath()) && Config::inst()->get('DNEnvironment', 'allow_web_editing')) {
 			Filesystem::removeFolder($this->getProjectFolderPath());
 		}
 
 		// Delete the deploy key
-		if(file_exists($this->getKeyDir())) {
+		if (file_exists($this->getKeyDir())) {
 			Filesystem::removeFolder($this->getKeyDir());
 		}
 	}
@@ -754,7 +754,7 @@ 
 	public function getPublicKey() {
 		$key = $this->getPublicKeyPath();
 
-		if(file_exists($key)) {
+		if (file_exists($key)) {
 			return trim(file_get_contents($key));
 		}
 	}
@@ -765,8 +765,8 @@ 
 	 * @return string|null
 	 */
 	public function getPublicKeyPath() {
-		if($privateKey = $this->getPrivateKeyPath()) {
-			return $privateKey . '.pub';
+		if ($privateKey = $this->getPrivateKeyPath()) {
+			return $privateKey.'.pub';
 		}
 		return null;
 	}
@@ -778,10 +778,10 @@ 
 	 */
 	public function getPrivateKeyPath() {
 		$keyDir = $this->getKeyDir();
-		if(!empty($keyDir)) {
+		if (!empty($keyDir)) {
 			$filter = FileNameFilter::create();
 			$name = $filter->filter($this->Name);
-			return $keyDir . '/' . $name;
+			return $keyDir.'/'.$name;
 		}
 		return null;
 	}
@@ -793,14 +793,14 @@ 
 	 */
 	public function getKeyDir() {
 		$keyDir = $this->DNData()->getKeyDir();
-		if(!$keyDir) {
+		if (!$keyDir) {
 			return null;
 		}
 
 		$filter = FileNameFilter::create();
 		$name = $filter->filter($this->Name);
 
-		return $this->DNData()->getKeyDir() . '/' . $name;
+		return $this->DNData()->getKeyDir().'/'.$name;
 	}
 
 	/**
@@ -810,7 +810,7 @@ 
 	 * @param GridField $environments
 	 */
 	protected function setEnvironmentFields(&$fields, $environments) {
-		if(!$environments) {
+		if (!$environments) {
 			return;
 		}
 
@@ -819,7 +819,7 @@ 
 		$environments->getConfig()->removeComponentsByType('GridFieldAddExistingAutocompleter');
 		$environments->getConfig()->removeComponentsByType('GridFieldDeleteAction');
 		$environments->getConfig()->removeComponentsByType('GridFieldPageCount');
-		if(Config::inst()->get('DNEnvironment', 'allow_web_editing')) {
+		if (Config::inst()->get('DNEnvironment', 'allow_web_editing')) {
 			$addNewRelease = new GridFieldAddNewButton('toolbar-header-right');
 			$addNewRelease->setButtonName('Add');
 			$environments->getConfig()->addComponent($addNewRelease);
@@ -835,7 +835,7 @@ 
 	 */
 	public function getRepositoryURL() {
 		$showUrl = Config::inst()->get($this->class, 'show_repository_url');
-		if($showUrl) {
+		if ($showUrl) {
 			return $this->CVSPath;
 		}
 	}
@@ -887,9 +887,9 @@ 
 		$interfaces = $this->config()->repository_interfaces;
 
 		/* Look for each whitelisted hostname */
-		foreach($interfaces as $host => $interface) {
+		foreach ($interfaces as $host => $interface) {
 			/* See if the CVS Path is for this hostname, followed by some junk (maybe a port), then the path */
-			if(preg_match('{^[^.]*' . $host . '(.*?)([/a-zA-Z].+)}', $this->CVSPath, $match)) {
+			if (preg_match('{^[^.]*'.$host.'(.*?)([/a-zA-Z].+)}', $this->CVSPath, $match)) {
 
 				$path = $match[2];
 
@@ -899,13 +899,13 @@ 
 
 				$components = explode('.', $host);
 
-				foreach($regex as $pattern => $replacement) {
-					$path = preg_replace('/' . $pattern . '/', $replacement, $path);
+				foreach ($regex as $pattern => $replacement) {
+					$path = preg_replace('/'.$pattern.'/', $replacement, $path);
 				}
 
-				$uxurl = Controller::join_links($scheme . '://', $host, $path);
+				$uxurl = Controller::join_links($scheme.'://', $host, $path);
 
-				if(array_key_exists('commit', $interface) && $interface['commit'] == false) {
+				if (array_key_exists('commit', $interface) && $interface['commit'] == false) {
 					$commiturl = false;
 				} else {
 					$commiturl = Controller::join_links(
@@ -949,7 +949,7 @@ 
 	 * @return SS_List
 	 */
 	public function whoIsAllowedAny($codes) {
-		if(!is_array($codes)) $codes = array($codes);
+		if (!is_array($codes)) $codes = array($codes);
 
 		$SQLa_codes = Convert::raw2sql($codes);
 		$SQL_codes = join("','", $SQLa_codes);
@@ -988,11 +988,11 @@ 
 	 */
 	public function groupAllowed($permissionCode, Group $group) {
 		$viewers = $this->Viewers();
-		if(!$viewers->find('ID', $group->ID)) {
+		if (!$viewers->find('ID', $group->ID)) {
 			return false;
 		}
 		$groups = Permission::get_groups_by_permission($permissionCode);
-		if(!$groups->find('ID', $group->ID)) {
+		if (!$groups->find('ID', $group->ID)) {
 			return false;
 		}
 		return true;
@@ -1011,10 +1011,10 @@ 
 			$member = Member::currentUser();
 		}
 
-		if(Permission::checkMember($member, 'ADMIN')) return true;
+		if (Permission::checkMember($member, 'ADMIN')) return true;
 
 		$hits = $this->whoIsAllowedAny($codes)->filter('Member.ID', $member->ID)->count();
-		return ($hits>0 ? true : false);
+		return ($hits > 0 ? true : false);
 	}
 
 	/**
@@ -1023,7 +1023,7 @@ 
 	 * @return bool
 	 */
 	public function isProjectReady() {
-		if($this->getRunningInitialEnvironmentCreations()->count() > 0) {
+		if ($this->getRunningInitialEnvironmentCreations()->count() > 0) {
 			// We're still creating the initial environments for this project so we're
 			// not quite done
 			return false;
@@ -1032,13 +1032,13 @@ 
 		// Provide a hook for further checks. Logic stolen from
 		// {@see DataObject::extendedCan()}
 		$isDone = $this->extend('isProjectReady');
-		if($isDone && is_array($isDone)) {
+		if ($isDone && is_array($isDone)) {
 			$isDone = array_filter($isDone, function($val) {
 				return !is_null($val);
 			});
 
 			// If anything returns false then we're not ready.
-			if($isDone) return min($isDone);
+			if ($isDone) return min($isDone);
 		}
 
 		return true;
@@ -1088,25 +1088,25 @@ 
 	 */
 	protected function validate() {
 		$validation = parent::validate();
-		if($validation->valid()) {
-			if(empty($this->Name)) {
+		if ($validation->valid()) {
+			if (empty($this->Name)) {
 				return $validation->error('The stack must have a name.');
 			}
 
 			// The name is used to build filepaths so should be restricted
-			if(!preg_match('/^[a-zA-Z0-9][a-zA-Z0-9\-\_]+$/', $this->Name)) {
+			if (!preg_match('/^[a-zA-Z0-9][a-zA-Z0-9\-\_]+$/', $this->Name)) {
 				return $validation->error('Project name can only contain alphanumeric, hyphens and underscores.');
 			}
 
-			if(empty($this->CVSPath)) {
+			if (empty($this->CVSPath)) {
 				return $validation->error('You must provide a repository URL.');
 			}
 
 			$existing = DNProject::get()->filter('Name', $this->Name);
-			if($this->ID) {
+			if ($this->ID) {
 				$existing = $existing->exclude('ID', $this->ID);
 			}
-			if($existing->count() > 0) {
+			if ($existing->count() > 0) {
 				return $validation->error('A stack already exists with that name.');
 			}
 		}
@@ -1119,10 +1119,10 @@ 
 	 * @return bool
 	 */
 	public function canCreate($member = null) {
-		if(!$member) $member = Member::currentUser();
-		if(!$member) return false;
+		if (!$member) $member = Member::currentUser();
+		if (!$member) return false;
 
-		if(Permission::checkMember($member, 'ADMIN')) {
+		if (Permission::checkMember($member, 'ADMIN')) {
 			return true;
 		}
 
@@ -1138,7 +1138,7 @@ 
 	 */
 	public function getCommit($sha) {
 		$repo = $this->getRepository();
-		if(!$repo) {
+		if (!$repo) {
 			return false;
 		}
 

code/model/jobs/DNDeployment.php

Spacing +14 added lines, -14 removed lines

@@ -108,7 +108,7 @@ 
 	}
 
 	public function LogLink() {
-		return $this->Link() . '/log';
+		return $this->Link().'/log';
 	}
 
 	public function canView($member = null) {
@@ -154,7 +154,7 @@ 
 	 * @return \Gitonomy\Git\Repository|null
 	 */
 	public function getRepository() {
-		if(!$this->SHA) {
+		if (!$this->SHA) {
 			return null;
 		}
 		return $this->Environment()->Project()->getRepository();
@@ -167,10 +167,10 @@ 
 	 */
 	public function getCommit() {
 		$repo = $this->getRepository();
-		if($repo) {
+		if ($repo) {
 			try {
 				return $this->Environment()->getCommit($this->SHA);
-			} catch(Gitonomy\Git\Exception\ReferenceNotFoundException $ex) {
+			} catch (Gitonomy\Git\Exception\ReferenceNotFoundException $ex) {
 				return null;
 			}
 		}
@@ -195,7 +195,7 @@ 
 		if (!$interface) {
 			return null;
 		}
-		return $interface->CommitURL . '/' . $this->SHA;
+		return $interface->CommitURL.'/'.$this->SHA;
 	}
 
 	/**
@@ -205,10 +205,10 @@ 
 	 */
 	public function getCommitMessage() {
 		$commit = $this->getCommit();
-		if($commit) {
+		if ($commit) {
 			try {
 				return Convert::raw2xml($this->Environment()->getCommitMessage($commit));
-			} catch(Gitonomy\Git\Exception\ReferenceNotFoundException $e) {
+			} catch (Gitonomy\Git\Exception\ReferenceNotFoundException $e) {
 				return null;
 			}
 		}
@@ -225,7 +225,7 @@ 
 		$this->Environment()->getCommitTags($commit);
 		$returnTags = [];
 		if (!empty($tags)) {
-			foreach($tags as $tag) {
+			foreach ($tags as $tag) {
 				$field = Varchar::create('Tag', '255');
 				$field->setValue($tag->getName());
 				$returnTags[] = $field;
@@ -242,12 +242,12 @@ 
 	 */
 	public function getFullDeployMessages() {
 		$strategy = $this->getDeploymentStrategy();
-		if ($strategy->getActionCode()!=='full') return null;
+		if ($strategy->getActionCode() !== 'full') return null;
 
 		$changes = $strategy->getChangesModificationNeeded();
 		$messages = [];
 		foreach ($changes as $change => $details) {
-			if ($change==='Code version') continue;
+			if ($change === 'Code version') continue;
 
 			$messages[] = [
 				'Flag' => sprintf(
@@ -275,7 +275,7 @@ 
 	 */
 	public function getTag() {
 		$tags = $this->getTags();
-		if($tags->count() > 0) {
+		if ($tags->count() > 0) {
 			return $tags->last();
 		}
 		return null;
@@ -300,7 +300,7 @@ 
 	public function getChanges() {
 		$list = new ArrayList();
 		$strategy = $this->getDeploymentStrategy();
-		foreach($strategy->getChanges() as $name => $change) {
+		foreach ($strategy->getChanges() as $name => $change) {
 			$changed = (isset($change['from']) && isset($change['to'])) ? $change['from'] != $change['to'] : null;
 			$description = isset($change['description']) ? $change['description'] : '';
 			$compareUrl = null;
@@ -350,11 +350,11 @@ 
 		// Make sure we use the SHA as it was written into this DNDeployment.
 		$args['sha'] = $this->SHA;
 
-		if(!$this->DeployerID) {
+		if (!$this->DeployerID) {
 			$this->DeployerID = Member::currentUserID();
 		}
 
-		if($this->DeployerID) {
+		if ($this->DeployerID) {
 			$deployer = $this->Deployer();
 			$message = sprintf(
 				'Deploy to %s initiated by %s (%s), with IP address %s',

code/control/GitDispatcher.php

Spacing +3 added lines, -3 removed lines

@@ -168,7 +168,7 @@ 
 	protected function getUpdateStatus($ID) {
 		$ping = DNGitFetch::get()->byID($ID);
 		if (!$ping) {
-			return $this->getAPIResponse(['message' => 'GIT update (' . $ID . ') not found'], 404);
+			return $this->getAPIResponse(['message' => 'GIT update ('.$ID.') not found'], 404);
 		}
 		$output = [
 			'id' => $ID,
@@ -189,7 +189,7 @@ 
 		$fetch->write();
 		$fetch->start();
 
-		$location = Director::absoluteBaseURL() . $this->Link() . '/update/' . $fetch->ID;
+		$location = Director::absoluteBaseURL().$this->Link().'/update/'.$fetch->ID;
 		$output = [
 			'message' => 'git fetch has been queued',
 			'id' => $fetch->ID,
@@ -212,7 +212,7 @@ 
 			$commit = $this->project->getCommit($branch->SHA());
 			$branches[] = [
 				'key' => $branch->SHA(),
-				'value' => $branch->Name() . ' (' . $this->project->getCommitMessage($commit) . ')',
+				'value' => $branch->Name().' ('.$this->project->getCommitMessage($commit).')',
 			];
 		}
 		return $branches;