silverstripe / silverstripe-routewhitelist

code/SiteTreeWhitelistExtension.php

Spacing +2 added lines, -2 removed lines

@@ -1,14 +1,14 @@
 <?php
 class SiteTreeWhitelistExtension extends DataExtension {
 
-	public function onAfterWrite(){
+	public function onAfterWrite() {
 		//top level page change should trigger re-generation of whitelist
 		if ($this->owner->getParentType() === 'root') {
 			WhitelistGenerator::generateWhitelist();
 		}
 	}
 	
-	public function onAfterDelete(){
+	public function onAfterDelete() {
 		if ($this->owner->getParentType() === 'root') {
 			WhitelistGenerator::generateWhitelist();
 		}

tests/WhitelistGeneratorTest.php

Spacing +11 added lines, -11 removed lines

@@ -8,7 +8,7 @@ 
         parent::setUp();
     }
 
-	public function testGenerateWhitelist(){
+	public function testGenerateWhitelist() {
 		$whitelist = WhitelistGenerator::generateWhitelistRules();
 
 		$top1 = $this->objFromFixture('SiteTree', 'top1');
@@ -31,10 +31,10 @@ 
 	}
 
     public function testWhitelistAfterDelete() {
-        $dir = BASE_PATH . DIRECTORY_SEPARATOR . Config::inst()->get('WhitelistGenerator', 'dir');
+        $dir = BASE_PATH.DIRECTORY_SEPARATOR.Config::inst()->get('WhitelistGenerator', 'dir');
         $whitelist = WhitelistGenerator::generateWhitelistRules();
         $top1 = $this->objFromFixture('SiteTree', 'top1');
-        $path = $dir . '/' . $top1->URLSegment;
+        $path = $dir.'/'.$top1->URLSegment;
 
         //Check that relevant file exists in cache directory of checks
         $this->assertTrue(file_exists($path));
@@ -45,7 +45,7 @@ 
     }
 
     private function getFilesFromCacheDir() {
-        $dir = BASE_PATH . DIRECTORY_SEPARATOR . Config::inst()->get('WhitelistGenerator', 'dir');
+        $dir = BASE_PATH.DIRECTORY_SEPARATOR.Config::inst()->get('WhitelistGenerator', 'dir');
         $files = array();
         if ($handle = opendir($dir)) {
             while (false !== ($entry = readdir($handle))) {
@@ -72,10 +72,10 @@ 
     }
 
     public function testWhitelistAfterUnpublish() {
-        $dir = BASE_PATH . DIRECTORY_SEPARATOR . Config::inst()->get('WhitelistGenerator', 'dir');
+        $dir = BASE_PATH.DIRECTORY_SEPARATOR.Config::inst()->get('WhitelistGenerator', 'dir');
         $whitelist = WhitelistGenerator::generateWhitelistRules();
         $top1 = $this->objFromFixture('SiteTree', 'top1');
-        $path = $dir . '/' . $top1->URLSegment;
+        $path = $dir.'/'.$top1->URLSegment;
 
         //Check that relevant file exists in cache directory of checks
         $this->assertTrue(file_exists($path));
@@ -107,13 +107,13 @@ 
 
 	function testSiteTreeVersionsIncludedInWhitelist() {
 		$top1 = $this->objFromFixture('SiteTree', 'top1');
-		$top1->publish('Stage', 'Live');    //publish the page so it has been live and needs redirecting to
+		$top1->publish('Stage', 'Live'); //publish the page so it has been live and needs redirecting to
 
 		$newSegment = 'new-url-segment';
 		$oldSegment = $top1->URLSegment;
 		$top1->URLSegment = $newSegment;
 		$top1->write();
-		$top1->publish('Stage', 'Live');    //publish again with a new URL
+		$top1->publish('Stage', 'Live'); //publish again with a new URL
 
 
 		$whitelist = WhitelistGenerator::generateWhitelistRules();
@@ -124,7 +124,7 @@ 
 	}
 
     public function testFlush() {
-        $dir = BASE_PATH . DIRECTORY_SEPARATOR . Config::inst()->get('WhitelistGenerator', 'dir');
+        $dir = BASE_PATH.DIRECTORY_SEPARATOR.Config::inst()->get('WhitelistGenerator', 'dir');
 
         //Delete cache directory
         WhitelistGenerator::clearWhitelist();
@@ -147,7 +147,7 @@ 
 		
 		$whitelist = WhitelistGenerator::generateWhitelistRules();
 
-		foreach($addToList as $add) {
+		foreach ($addToList as $add) {
 			$this->assertContains($add, $whitelist);
 		}
 	}
@@ -161,7 +161,7 @@ 
 
 		$whitelist = WhitelistGenerator::generateWhitelistRules();
 
-		foreach($removeFromList as $remove) {
+		foreach ($removeFromList as $remove) {
 			$this->assertNotContains($remove, $whitelist);
 		}
 	}

code/WhitelistGenerator.php

Spacing +24 added lines, -24 removed lines

@@ -1,12 +1,12 @@ 
 <?php
 class WhitelistGenerator extends SS_Object implements Flushable {
 
-	public static function generateWhitelist(){
+	public static function generateWhitelist() {
 		$whitelist = self::generateWhitelistRules();
 		self::syncCacheFilesystem($whitelist);
 	}
 
-	public static function generateWhitelistRules(){
+	public static function generateWhitelistRules() {
 		//get all URL rules
 		$rules = Config::inst()->get('Director', 'rules');
 
@@ -16,8 +16,8 @@ 
 			$pattern = ltrim($pattern, '/!');
 
 			//match first portion of the URL, either delimited by slash or colon or end-of-line
-			if (preg_match('/^(.*?)(\/|:|$)/', $pattern, $matches)){
-				if (!empty($matches[1])){
+			if (preg_match('/^(.*?)(\/|:|$)/', $pattern, $matches)) {
+				if (!empty($matches[1])) {
 					array_push($allTopLevelRules, $matches[1]);
 				}
 			}
@@ -29,18 +29,18 @@ 
 			$filteredRules = array_merge($filteredRules, $addToWhitelist);
 		}
 		
-		foreach($allTopLevelRules as $rule) {
+		foreach ($allTopLevelRules as $rule) {
 			if (strpos($rule, '$') !== false) {
 				if ($rule === '$Controller') {
 					//special case for Controllers, add all possible controllers
 					$subControllers = ClassInfo::subclassesFor(new Controller());
 
-					foreach ($subControllers as $controller){
-						array_push($filteredRules, $controller);    //add the controller name as a link
+					foreach ($subControllers as $controller) {
+						array_push($filteredRules, $controller); //add the controller name as a link
 					}
 
 				} elseif ($rule === '$URLSegment') {
-					$topLevelPagesArray = array();  //temporary array to store top-level pages
+					$topLevelPagesArray = array(); //temporary array to store top-level pages
 					$oldTopLevelPagesArray = array();
 
 					//special case for SiteTree, add all possible top Level Pages
@@ -87,13 +87,13 @@ 
 	 * Sync the list of all top-level routes with the file system whitelist cache
 	 */
 	protected static function syncCacheFilesystem($whitelist) {
-		$dir = BASE_PATH . DIRECTORY_SEPARATOR . Config::inst()->get('WhitelistGenerator', 'dir');
+		$dir = BASE_PATH.DIRECTORY_SEPARATOR.Config::inst()->get('WhitelistGenerator', 'dir');
 
 		$whitelistFolderContents = scandir($dir);
 
 		//create list of files to create
 		$toCreate = array();
-		foreach ($whitelist as $listItem){
+		foreach ($whitelist as $listItem) {
 			if (!in_array($listItem, $whitelistFolderContents)) {
 				if (!empty($listItem)) {    //don't include empty files, such as the file for /
 					array_push($toCreate, $listItem);
@@ -103,8 +103,8 @@ 
 
 		//create list of files to delete
 		$toDelete = array();
-		foreach ($whitelistFolderContents as $file){
-			if (!in_array($file, array('','..','.','.htaccess'))) {    //exclude things that should stay in the folder
+		foreach ($whitelistFolderContents as $file) {
+			if (!in_array($file, array('', '..', '.', '.htaccess'))) {    //exclude things that should stay in the folder
 				if (!in_array($file, $whitelist)) {
 					array_push($toDelete, $file);
 				}
@@ -113,12 +113,12 @@ 
 
 		//delete files which are no longer necessary
 		foreach ($toDelete as $delete) {
-			unlink($dir . DIRECTORY_SEPARATOR . $delete);
+			unlink($dir.DIRECTORY_SEPARATOR.$delete);
 		}
 
 		//create new whitelist items as files
 		foreach ($toCreate as $create) {
-			touch($dir . DIRECTORY_SEPARATOR . $create);
+			touch($dir.DIRECTORY_SEPARATOR.$create);
 		}
 	}
 
@@ -130,11 +130,11 @@ 
 	 * @param $currentTopLevelPages
 	 * @return array URLs of past top-level pages
 	 */
-	protected static function find_old_top_level_pages($currentTopLevelPages){
+	protected static function find_old_top_level_pages($currentTopLevelPages) {
 		$oldPageURLs = array();
 
 		$queryClass = 'SQLSelect';
-		if (!class_exists($queryClass) && class_exists('SQLQuery')){
+		if (!class_exists($queryClass) && class_exists('SQLQuery')) {
 			$queryClass = 'SQLQuery';
 		}
 		
@@ -144,13 +144,13 @@ 
 			array(
 				'ParentID = 0',
 				'WasPublished = 1',
-				'URLSegment NOT IN (\''.implode("','",array_filter($currentTopLevelPages)).'\')'
+				'URLSegment NOT IN (\''.implode("','", array_filter($currentTopLevelPages)).'\')'
 			)
 		);
 
 		$records = $query->execute();
 		if ($records) {
-			foreach($records as $record) {
+			foreach ($records as $record) {
 				array_push($oldPageURLs, $record['URLSegment']);
 			}
 		}
@@ -158,25 +158,25 @@ 
 		return $oldPageURLs;
 	}
 
-    public static function ensureWhitelistFolderExists(){
-		$dir = BASE_PATH . DIRECTORY_SEPARATOR . Config::inst()->get('WhitelistGenerator', 'dir');
+    public static function ensureWhitelistFolderExists() {
+		$dir = BASE_PATH.DIRECTORY_SEPARATOR.Config::inst()->get('WhitelistGenerator', 'dir');
 		if (!file_exists($dir)) {
 			mkdir($dir); //create a new whitelist dir
-			chmod($dir,0777);    //make sure it is readable by the web-server user
+			chmod($dir, 0777); //make sure it is readable by the web-server user
 			//create a htaccess file to ensure that the whitelist cache directory is not web-accessible
 			file_put_contents($dir.DIRECTORY_SEPARATOR.'.htaccess', "Deny from all\n");
 		}
 	}
 
-	public static function clearWhitelist(){
-		$dir = BASE_PATH . DIRECTORY_SEPARATOR . Config::inst()->get('WhitelistGenerator', 'dir');
+	public static function clearWhitelist() {
+		$dir = BASE_PATH.DIRECTORY_SEPARATOR.Config::inst()->get('WhitelistGenerator', 'dir');
 		if (file_exists($dir)) {
 			array_map('unlink', glob($dir."/*"));
 		}
 	}
 
 	public static function flush() {
-		self::ensureWhitelistFolderExists();    //only create folder on flush, not on sitetree changes
+		self::ensureWhitelistFolderExists(); //only create folder on flush, not on sitetree changes
 		self::generateWhitelist();
 	}
 }