silverstripe / cwp-core

src/Extension/CustomHtmlEditorField.php

Indentation +9 added lines, -9 removed lines

@@ -13,13 +13,13 @@
 class CustomHtmlEditorFieldToolbar extends Extension
 {
 
-    /**
-     * @param Form $form
-     * @return void
-     */
-    public function updateMediaForm(Form $form)
-    {
-        Requirements::add_i18n_javascript('cwp/cwp-core:javascript/lang');
-        Requirements::javascript('cwp/cwp-core:javascript/CustomHtmlEditorFieldToolbar.js');
-    }
+	/**
+	 * @param Form $form
+	 * @return void
+	 */
+	public function updateMediaForm(Form $form)
+	{
+		Requirements::add_i18n_javascript('cwp/cwp-core:javascript/lang');
+		Requirements::javascript('cwp/cwp-core:javascript/CustomHtmlEditorFieldToolbar.js');
+	}
 }

src/Extension/CwpControllerExtension.php

Indentation +190 added lines, -190 removed lines

@@ -18,194 +18,194 @@
 class CwpControllerExtension extends Extension implements PermissionProvider
 {
 
-    /**
-     * Enables SSL redirections - disabling not recommended as it will prevent forcing SSL on admin panel.
-     *
-     * @config
-     * @var bool
-     */
-    private static $ssl_redirection_enabled = true;
-
-    /**
-     * Specify a domain to redirect the vulnerable areas to.
-     *
-     * If left as null, live instance will set this to <instance-id>.cwp.govt.nz via CWP_SECURE_DOMAIN in _config.php.
-     * This allows us to automatically protect vulnerable areas on live even if the frontend cert is not installed.
-     *
-     * Set to false to redirect to https protocol on current domain (e.g. if you have frontend cert).
-     *
-     * Set to a domain string (e.g. 'example.com') to force that domain.
-     *
-     * @config
-     * @var string
-     */
-    private static $ssl_redirection_force_domain = null;
-
-    /**
-     * Enables the BasicAuth protection on all test environments. Disable with caution - it will open up
-     * all your UAT and test environments to the world.
-     *
-     * @config
-     * @var bool
-     */
-    private static $test_basicauth_enabled = true;
-
-    /**
-     * Enables the BasicAuth protection on all live environments.
-     * Useful for securing sites prior to public launch.
-     *
-     * @config
-     * @var bool
-     */
-    private static $live_basicauth_enabled = false;
-
-    /**
-     * This executes the passed callback with subsite filter disabled,
-     * then enabled the filter again before returning the callback result
-     * (or throwing the exception the callback raised)
-     *
-     * @param  callback  $callback - The callback to execute
-     * @return mixed     The result of the callback
-     * @throws Exception Any exception the callback raised
-     */
-    protected function callWithSubsitesDisabled($callback)
-    {
-        $rv = null;
-
-        try {
-            if (class_exists(Subsite::class)) {
-                Subsite::disable_subsite_filter(true);
-            }
-
-            $rv = call_user_func($callback);
-        } catch (Exception $e) {
-            if (class_exists(Subsite::class)) {
-                Subsite::disable_subsite_filter(false);
-            }
-
-            throw $e;
-        }
-
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(false);
-        }
-
-        return $rv;
-    }
-
-    /**
-     * Trigger Basic Auth protection, except when there's a reason to bypass it
-     *  - The source IP address is in the comma-seperated string in the constant CWP_IP_BYPASS_BASICAUTH
-     *    (so Pingdom, etc, can access the site)
-     *  - There is an identifiable member, that member has the ACCESS_UAT_SERVER permission, and they're trying
-     *    to access a white-list of URLs (so people following a reset password link can reset their password)
-     */
-    protected function triggerBasicAuthProtection()
-    {
-        $allowWithoutAuth = false;
-
-        // Allow whitelisting IPs for bypassing the basic auth.
-        if (Environment::getEnv('CWP_IP_BYPASS_BASICAUTH')) {
-            $remote = $_SERVER['REMOTE_ADDR'];
-            $bypass = explode(',', Environment::getEnv('CWP_IP_BYPASS_BASICAUTH'));
-
-            if (in_array($remote, $bypass)) {
-                $allowWithoutAuth = true;
-            }
-        }
-
-        // First, see if we can get a member to act on, either from a changepassword token or the session
-        if (isset($_REQUEST['m']) && isset($_REQUEST['t'])) {
-            $member = Member::get()->filter('ID', (int) $_REQUEST['m'])->first();
-
-            if (!$member->validateAutoLoginToken($_REQUEST['t'])) {
-                $member = null;
-            }
-        } elseif ($this->owner->getRequest()->getSession()->get('AutoLoginHash')) {
-            $member = Member::member_from_autologinhash(
-                $this->owner->getRequest()->getSession()->get('AutoLoginHash')
-            );
-        } else {
-            $member = Security::getCurrentUser();
-        }
-
-        // Then, if they have the right permissions, check the allowed URLs
-        $existingMemberCanAccessUAT = $member && $this->callWithSubsitesDisabled(function () use ($member) {
-            return Permission::checkMember($member, 'ACCESS_UAT_SERVER');
-        });
-
-        if ($existingMemberCanAccessUAT) {
-            $allowed = array(
-                '/^Security\/changepassword/',
-                '/^Security\/ChangePasswordForm/'
-            );
-
-            $relativeURL = Director::makeRelative(Director::absoluteURL($_SERVER['REQUEST_URI']));
-
-            foreach ($allowed as $pattern) {
-                $allowWithoutAuth = $allowWithoutAuth || preg_match($pattern, $relativeURL);
-            }
-        }
-
-        // Finally if they weren't allowed to bypass Basic Auth, trigger it
-        if (!$allowWithoutAuth) {
-            $this->callWithSubsitesDisabled(function () {
-                BasicAuth::requireLogin(
-                    $this->owner->getRequest(),
-                    _t(__CLASS__ . '.LoginPrompt', "Please log in with your CMS credentials"),
-                    'ACCESS_UAT_SERVER',
-                    true
-                );
-            });
-        }
-    }
-
-    /**
-     * @return void
-     */
-    public function onBeforeInit()
-    {
-        // Grab global injectable service to allow testing.
-        $director = Injector::inst()->get(Director::class);
-
-        if (Config::inst()->get(__CLASS__, 'ssl_redirection_enabled')) {
-            // redirect some vulnerable areas to the secure domain
-            if (!$director::is_https()) {
-                $forceDomain = Config::inst()->get(__CLASS__, 'ssl_redirection_force_domain');
-
-                if ($forceDomain) {
-                    $director::forceSSL(['/^Security/', '/^api/'], $forceDomain);
-                } else {
-                    $director::forceSSL(['/^Security/', '/^api/']);
-                }
-            }
-        }
-
-        if (Config::inst()->get(__CLASS__, 'test_basicauth_enabled')) {
-            // Turn on Basic Auth in testing mode
-            if ($director::isTest()) {
-                $this->triggerBasicAuthProtection();
-            }
-        }
-
-        if (Config::inst()->get(__CLASS__, 'live_basicauth_enabled')) {
-            // Turn on Basic Auth in live mode
-            if ($director::isLive()) {
-                $this->triggerBasicAuthProtection();
-            }
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function providePermissions()
-    {
-        return [
-            'ACCESS_UAT_SERVER' => _t(
-                __CLASS__ . '.UatServerPermission',
-                'Allow users to use their accounts to access the UAT server'
-            )
-        ];
-    }
+	/**
+	 * Enables SSL redirections - disabling not recommended as it will prevent forcing SSL on admin panel.
+	 *
+	 * @config
+	 * @var bool
+	 */
+	private static $ssl_redirection_enabled = true;
+
+	/**
+	 * Specify a domain to redirect the vulnerable areas to.
+	 *
+	 * If left as null, live instance will set this to <instance-id>.cwp.govt.nz via CWP_SECURE_DOMAIN in _config.php.
+	 * This allows us to automatically protect vulnerable areas on live even if the frontend cert is not installed.
+	 *
+	 * Set to false to redirect to https protocol on current domain (e.g. if you have frontend cert).
+	 *
+	 * Set to a domain string (e.g. 'example.com') to force that domain.
+	 *
+	 * @config
+	 * @var string
+	 */
+	private static $ssl_redirection_force_domain = null;
+
+	/**
+	 * Enables the BasicAuth protection on all test environments. Disable with caution - it will open up
+	 * all your UAT and test environments to the world.
+	 *
+	 * @config
+	 * @var bool
+	 */
+	private static $test_basicauth_enabled = true;
+
+	/**
+	 * Enables the BasicAuth protection on all live environments.
+	 * Useful for securing sites prior to public launch.
+	 *
+	 * @config
+	 * @var bool
+	 */
+	private static $live_basicauth_enabled = false;
+
+	/**
+	 * This executes the passed callback with subsite filter disabled,
+	 * then enabled the filter again before returning the callback result
+	 * (or throwing the exception the callback raised)
+	 *
+	 * @param  callback  $callback - The callback to execute
+	 * @return mixed     The result of the callback
+	 * @throws Exception Any exception the callback raised
+	 */
+	protected function callWithSubsitesDisabled($callback)
+	{
+		$rv = null;
+
+		try {
+			if (class_exists(Subsite::class)) {
+				Subsite::disable_subsite_filter(true);
+			}
+
+			$rv = call_user_func($callback);
+		} catch (Exception $e) {
+			if (class_exists(Subsite::class)) {
+				Subsite::disable_subsite_filter(false);
+			}
+
+			throw $e;
+		}
+
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(false);
+		}
+
+		return $rv;
+	}
+
+	/**
+	 * Trigger Basic Auth protection, except when there's a reason to bypass it
+	 *  - The source IP address is in the comma-seperated string in the constant CWP_IP_BYPASS_BASICAUTH
+	 *    (so Pingdom, etc, can access the site)
+	 *  - There is an identifiable member, that member has the ACCESS_UAT_SERVER permission, and they're trying
+	 *    to access a white-list of URLs (so people following a reset password link can reset their password)
+	 */
+	protected function triggerBasicAuthProtection()
+	{
+		$allowWithoutAuth = false;
+
+		// Allow whitelisting IPs for bypassing the basic auth.
+		if (Environment::getEnv('CWP_IP_BYPASS_BASICAUTH')) {
+			$remote = $_SERVER['REMOTE_ADDR'];
+			$bypass = explode(',', Environment::getEnv('CWP_IP_BYPASS_BASICAUTH'));
+
+			if (in_array($remote, $bypass)) {
+				$allowWithoutAuth = true;
+			}
+		}
+
+		// First, see if we can get a member to act on, either from a changepassword token or the session
+		if (isset($_REQUEST['m']) && isset($_REQUEST['t'])) {
+			$member = Member::get()->filter('ID', (int) $_REQUEST['m'])->first();
+
+			if (!$member->validateAutoLoginToken($_REQUEST['t'])) {
+				$member = null;
+			}
+		} elseif ($this->owner->getRequest()->getSession()->get('AutoLoginHash')) {
+			$member = Member::member_from_autologinhash(
+				$this->owner->getRequest()->getSession()->get('AutoLoginHash')
+			);
+		} else {
+			$member = Security::getCurrentUser();
+		}
+
+		// Then, if they have the right permissions, check the allowed URLs
+		$existingMemberCanAccessUAT = $member && $this->callWithSubsitesDisabled(function () use ($member) {
+			return Permission::checkMember($member, 'ACCESS_UAT_SERVER');
+		});
+
+		if ($existingMemberCanAccessUAT) {
+			$allowed = array(
+				'/^Security\/changepassword/',
+				'/^Security\/ChangePasswordForm/'
+			);
+
+			$relativeURL = Director::makeRelative(Director::absoluteURL($_SERVER['REQUEST_URI']));
+
+			foreach ($allowed as $pattern) {
+				$allowWithoutAuth = $allowWithoutAuth || preg_match($pattern, $relativeURL);
+			}
+		}
+
+		// Finally if they weren't allowed to bypass Basic Auth, trigger it
+		if (!$allowWithoutAuth) {
+			$this->callWithSubsitesDisabled(function () {
+				BasicAuth::requireLogin(
+					$this->owner->getRequest(),
+					_t(__CLASS__ . '.LoginPrompt', "Please log in with your CMS credentials"),
+					'ACCESS_UAT_SERVER',
+					true
+				);
+			});
+		}
+	}
+
+	/**
+	 * @return void
+	 */
+	public function onBeforeInit()
+	{
+		// Grab global injectable service to allow testing.
+		$director = Injector::inst()->get(Director::class);
+
+		if (Config::inst()->get(__CLASS__, 'ssl_redirection_enabled')) {
+			// redirect some vulnerable areas to the secure domain
+			if (!$director::is_https()) {
+				$forceDomain = Config::inst()->get(__CLASS__, 'ssl_redirection_force_domain');
+
+				if ($forceDomain) {
+					$director::forceSSL(['/^Security/', '/^api/'], $forceDomain);
+				} else {
+					$director::forceSSL(['/^Security/', '/^api/']);
+				}
+			}
+		}
+
+		if (Config::inst()->get(__CLASS__, 'test_basicauth_enabled')) {
+			// Turn on Basic Auth in testing mode
+			if ($director::isTest()) {
+				$this->triggerBasicAuthProtection();
+			}
+		}
+
+		if (Config::inst()->get(__CLASS__, 'live_basicauth_enabled')) {
+			// Turn on Basic Auth in live mode
+			if ($director::isLive()) {
+				$this->triggerBasicAuthProtection();
+			}
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function providePermissions()
+	{
+		return [
+			'ACCESS_UAT_SERVER' => _t(
+				__CLASS__ . '.UatServerPermission',
+				'Allow users to use their accounts to access the UAT server'
+			)
+		];
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -116,7 +116,7 @@ 
 
         // First, see if we can get a member to act on, either from a changepassword token or the session
         if (isset($_REQUEST['m']) && isset($_REQUEST['t'])) {
-            $member = Member::get()->filter('ID', (int) $_REQUEST['m'])->first();
+            $member = Member::get()->filter('ID', (int)$_REQUEST['m'])->first();
 
             if (!$member->validateAutoLoginToken($_REQUEST['t'])) {
                 $member = null;
@@ -130,7 +130,7 @@ 
         }
 
         // Then, if they have the right permissions, check the allowed URLs
-        $existingMemberCanAccessUAT = $member && $this->callWithSubsitesDisabled(function () use ($member) {
+        $existingMemberCanAccessUAT = $member && $this->callWithSubsitesDisabled(function() use ($member) {
             return Permission::checkMember($member, 'ACCESS_UAT_SERVER');
         });
 
@@ -149,7 +149,7 @@ 
 
         // Finally if they weren't allowed to bypass Basic Auth, trigger it
         if (!$allowWithoutAuth) {
-            $this->callWithSubsitesDisabled(function () {
+            $this->callWithSubsitesDisabled(function() {
                 BasicAuth::requireLogin(
                     $this->owner->getRequest(),
                     _t(__CLASS__ . '.LoginPrompt', "Please log in with your CMS credentials"),

src/Extension/CwpHtmlEditorConfig.php

Indentation +14 added lines, -14 removed lines

@@ -7,20 +7,20 @@
 class CwpHtmlEditorConfig extends DataExtension
 {
 
-    /**
-     * @return string
-     *
-     * Override the default HtmlEditorConfig from 'cms' to 'cwp' defined in cwp-core/_config.php
-     * However if the group has a custom editor configuration set, use that instead.
-     */
-    public function getHtmlEditorConfig()
-    {
-        $originalConfig = $this->owner->getField("HtmlEditorConfig");
+	/**
+	 * @return string
+	 *
+	 * Override the default HtmlEditorConfig from 'cms' to 'cwp' defined in cwp-core/_config.php
+	 * However if the group has a custom editor configuration set, use that instead.
+	 */
+	public function getHtmlEditorConfig()
+	{
+		$originalConfig = $this->owner->getField("HtmlEditorConfig");
 
-        if ($originalConfig) {
-            return $originalConfig;
-        }
+		if ($originalConfig) {
+			return $originalConfig;
+		}
 
-        return 'cwp';
-    }
+		return 'cwp';
+	}
 }

src/Extension/LoginAttemptNotifications.php

Indentation +63 added lines, -63 removed lines

@@ -19,78 +19,78 @@
 class LoginAttemptNotifications extends Extension
 {
 
-    /**
-     *
-     * @return mixed null
-     */
-    public function init()
-    {
+	/**
+	 *
+	 * @return mixed null
+	 */
+	public function init()
+	{
 
-        // Exclude default admin.
-        $member = Security::getCurrentUser();
-        if (!$member || !$member->ID) {
-            return;
-        }
+		// Exclude default admin.
+		$member = Security::getCurrentUser();
+		if (!$member || !$member->ID) {
+			return;
+		}
 
-        $message = null;
-        $session = $this->owner->getRequest()->getSession();
+		$message = null;
+		$session = $this->owner->getRequest()->getSession();
 
-        Requirements::javascript('cwp/cwp-core:javascript/LoginAttemptNotifications.js');
-        $sessionLastVisited = $session->get('LoginAttemptNotifications.SessionLastVisited');
-        if ($sessionLastVisited) {
-            // Session already in progress. Show all attempts since the session was last visited.
+		Requirements::javascript('cwp/cwp-core:javascript/LoginAttemptNotifications.js');
+		$sessionLastVisited = $session->get('LoginAttemptNotifications.SessionLastVisited');
+		if ($sessionLastVisited) {
+			// Session already in progress. Show all attempts since the session was last visited.
 
-            $meantimeLoginAttempts = LoginAttempt::get()->filter([
-                'MemberID' => $member->ID,
-                'Created:GreaterThan' => $sessionLastVisited
-            ]);
+			$meantimeLoginAttempts = LoginAttempt::get()->filter([
+				'MemberID' => $member->ID,
+				'Created:GreaterThan' => $sessionLastVisited
+			]);
 
-            $attempts = $meantimeLoginAttempts->count();
-            if ($attempts) {
-                $lastVisitedObj = DBDatetime::create();
-                $lastVisitedObj->setValue($sessionLastVisited);
-                $elapsed = $lastVisitedObj->TimeDiff();
-                $failures = $meantimeLoginAttempts->filter(['Status' => 'Failure'])->count();
-                $IPs = array_unique($meantimeLoginAttempts->column('IP'));
+			$attempts = $meantimeLoginAttempts->count();
+			if ($attempts) {
+				$lastVisitedObj = DBDatetime::create();
+				$lastVisitedObj->setValue($sessionLastVisited);
+				$elapsed = $lastVisitedObj->TimeDiff();
+				$failures = $meantimeLoginAttempts->filter(['Status' => 'Failure'])->count();
+				$IPs = array_unique($meantimeLoginAttempts->column('IP'));
 
-                if ($attempts == 1) {
-                    $statusString = $failures ? "a failed" : "a successful";
-                    $message = "In the last $elapsed $statusString login attempt to your account was "
-                        . "registered. The attempt was made from ${IPs[0]}. ";
-                } else {
-                    if ($failures == $attempts) {
-                        $statusString = $failures ? "failed" : "successful";
-                        $message = "In the last $elapsed $attempts $statusString login "
-                            . "attempts to your account were registered. ";
-                    } else {
-                        $message = "In the last $elapsed $attempts login attempts to your "
-                            . "account were registered, of which $failures failed. ";
-                    }
+				if ($attempts == 1) {
+					$statusString = $failures ? "a failed" : "a successful";
+					$message = "In the last $elapsed $statusString login attempt to your account was "
+						. "registered. The attempt was made from ${IPs[0]}. ";
+				} else {
+					if ($failures == $attempts) {
+						$statusString = $failures ? "failed" : "successful";
+						$message = "In the last $elapsed $attempts $statusString login "
+							. "attempts to your account were registered. ";
+					} else {
+						$message = "In the last $elapsed $attempts login attempts to your "
+							. "account were registered, of which $failures failed. ";
+					}
 
-                    $message .= "The attempts were from " . implode(', ', $IPs) . '. ';
+					$message .= "The attempts were from " . implode(', ', $IPs) . '. ';
 
-                    // TODO: add this call to action in a way that doesn't break out of the availabel space. Fix CSS?
-                    // $message .= "If you suspect somebody else might be trying to access
-                    //  . "your account, please contact support.";
-                }
-            }
-        } else {
-            // New session - show last login attempt.
-            // TODO: this currently does NOT surface to the frontend in any way.
-            $lastLoginAttempt = LoginAttempt::get()->filter([
-                        'MemberID' => $member->ID
-            ])->sort('Created DESC')->First();
+					// TODO: add this call to action in a way that doesn't break out of the availabel space. Fix CSS?
+					// $message .= "If you suspect somebody else might be trying to access
+					//  . "your account, please contact support.";
+				}
+			}
+		} else {
+			// New session - show last login attempt.
+			// TODO: this currently does NOT surface to the frontend in any way.
+			$lastLoginAttempt = LoginAttempt::get()->filter([
+						'MemberID' => $member->ID
+			])->sort('Created DESC')->First();
 
-            if ($lastLoginAttempt) {
-                $date = $lastLoginAttempt->Created;
-                $message = "Last login attempt to your account was on $lastLoginAttempt->Created "
-                    . "from $lastLoginAttempt->IP";
-                $message .= $lastLoginAttempt->Status == 'Failure' ? " and was successful." : "and has failed.";
-            }
-        }
+			if ($lastLoginAttempt) {
+				$date = $lastLoginAttempt->Created;
+				$message = "Last login attempt to your account was on $lastLoginAttempt->Created "
+					. "from $lastLoginAttempt->IP";
+				$message .= $lastLoginAttempt->Status == 'Failure' ? " and was successful." : "and has failed.";
+			}
+		}
 
-        $session->set('LoginAttemptNotifications.SessionLastVisited', DBDatetime::now()->Format('Y-m-d H:i:s'));
+		$session->set('LoginAttemptNotifications.SessionLastVisited', DBDatetime::now()->Format('Y-m-d H:i:s'));
 
-        $this->owner->getResponse()->addHeader('X-LoginAttemptNotifications', $message);
-    }
+		$this->owner->getResponse()->addHeader('X-LoginAttemptNotifications', $message);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -53,12 +53,12 @@ 
                 $failures = $meantimeLoginAttempts->filter(['Status' => 'Failure'])->count();
                 $IPs = array_unique($meantimeLoginAttempts->column('IP'));
 
-                if ($attempts == 1) {
+                if ($attempts==1) {
                     $statusString = $failures ? "a failed" : "a successful";
                     $message = "In the last $elapsed $statusString login attempt to your account was "
                         . "registered. The attempt was made from ${IPs[0]}. ";
                 } else {
-                    if ($failures == $attempts) {
+                    if ($failures==$attempts) {
                         $statusString = $failures ? "failed" : "successful";
                         $message = "In the last $elapsed $attempts $statusString login "
                             . "attempts to your account were registered. ";
@@ -85,7 +85,7 @@ 
                 $date = $lastLoginAttempt->Created;
                 $message = "Last login attempt to your account was on $lastLoginAttempt->Created "
                     . "from $lastLoginAttempt->IP";
-                $message .= $lastLoginAttempt->Status == 'Failure' ? " and was successful." : "and has failed.";
+                $message .= $lastLoginAttempt->Status=='Failure' ? " and was successful." : "and has failed.";
             }
         }
 

src/Model/CwpSolrIndex.php

Indentation +15 added lines, -15 removed lines

@@ -9,22 +9,22 @@
  */
 class CwpSolrIndex extends CwpSearchIndex
 {
-    public function init()
-    {
-        $this->addClass(SiteTree::class);
+	public function init()
+	{
+		$this->addClass(SiteTree::class);
 
-        // By default, we only add text fields that are 'visible' to users (where the content is directly visible on
-        // the website), along with the 'meta' fields that are commonly used to boost / refine search results
-        $this->addFulltextField('Title');
-        $this->addFulltextField('MenuTitle');
-        $this->addFulltextField('Content');
-        $this->addFulltextField('MetaDescription');
-        $this->addFulltextField('ExtraMeta');
+		// By default, we only add text fields that are 'visible' to users (where the content is directly visible on
+		// the website), along with the 'meta' fields that are commonly used to boost / refine search results
+		$this->addFulltextField('Title');
+		$this->addFulltextField('MenuTitle');
+		$this->addFulltextField('Content');
+		$this->addFulltextField('MetaDescription');
+		$this->addFulltextField('ExtraMeta');
 
-        // Adds 'ShowInSearch' boolean field to Solr document so we can later ensure that only documents included in
-        // search are returned by Solr.
-        $this->addFilterField('ShowInSearch');
+		// Adds 'ShowInSearch' boolean field to Solr document so we can later ensure that only documents included in
+		// search are returned by Solr.
+		$this->addFilterField('ShowInSearch');
 
-        parent::init();
-    }
+		parent::init();
+	}
 }

src/Model/CwpSearchIndex.php

Indentation +74 added lines, -74 removed lines

@@ -18,86 +18,86 @@
 abstract class CwpSearchIndex extends SolrIndex
 {
 
-    /**
-     * Copy all fields into both search and spellcheck data source
-     *
-     * @var array
-     * @config
-     */
-    private static $copy_fields = array(
-        '_text',
-        '_spellcheckText'
-    );
+	/**
+	 * Copy all fields into both search and spellcheck data source
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $copy_fields = array(
+		'_text',
+		'_spellcheckText'
+	);
 
-    /**
-     * Default dictionary to use. This will overwrite the 'spellcheck.dictionary' option for searches given,
-     * unless set to empty.
-     *
-     * '_spellcheck' is a predefined by the cwp infrastructure, which is configured
-     * to be built from the '_spellcheckText' field. You can't rename this within CWP.
-     *
-     * @var string
-     * @config
-     */
-    private static $dictionary = '_spellcheck';
+	/**
+	 * Default dictionary to use. This will overwrite the 'spellcheck.dictionary' option for searches given,
+	 * unless set to empty.
+	 *
+	 * '_spellcheck' is a predefined by the cwp infrastructure, which is configured
+	 * to be built from the '_spellcheckText' field. You can't rename this within CWP.
+	 *
+	 * @var string
+	 * @config
+	 */
+	private static $dictionary = '_spellcheck';
 
-    public function init()
-    {
-        // Add optional boost
-        if (SiteTree::has_extension(CwpSearchBoostExtension::class)) {
-            $this->setFieldBoosting(SiteTree::class . '_SearchBoost', SiteTree::config()->get('search_boost'));
-        }
-    }
+	public function init()
+	{
+		// Add optional boost
+		if (SiteTree::has_extension(CwpSearchBoostExtension::class)) {
+			$this->setFieldBoosting(SiteTree::class . '_SearchBoost', SiteTree::config()->get('search_boost'));
+		}
+	}
 
-    /**
-     * Upload config for this index to the given store
-     *
-     * @param SolrConfigStore $store
-     */
-    public function uploadConfig($store)
-    {
-        parent::uploadConfig($store);
+	/**
+	 * Upload config for this index to the given store
+	 *
+	 * @param SolrConfigStore $store
+	 */
+	public function uploadConfig($store)
+	{
+		parent::uploadConfig($store);
 
-        // Upload configured synonyms {@see SynonymsSiteConfig}
-        $siteConfig = SiteConfig::current_site_config();
-        if ($siteConfig->SearchSynonyms) {
-            $store->uploadString(
-                $this->getIndexName(),
-                'synonyms.txt',
-                $siteConfig->SearchSynonyms
-            );
-        }
-    }
+		// Upload configured synonyms {@see SynonymsSiteConfig}
+		$siteConfig = SiteConfig::current_site_config();
+		if ($siteConfig->SearchSynonyms) {
+			$store->uploadString(
+				$this->getIndexName(),
+				'synonyms.txt',
+				$siteConfig->SearchSynonyms
+			);
+		}
+	}
 
-    /**
-     *
-     * @return string
-     */
-    public function getFieldDefinitions()
-    {
-        $xml = parent::getFieldDefinitions();
-        $xml .= "\n\n\t\t<!-- Additional custom fields for spell checking -->";
-        $xml .= "\n\t\t<field name='_spellcheckText' type='textSpellHtml' indexed='true' "
-            . "stored='false' multiValued='true' />";
+	/**
+	 *
+	 * @return string
+	 */
+	public function getFieldDefinitions()
+	{
+		$xml = parent::getFieldDefinitions();
+		$xml .= "\n\n\t\t<!-- Additional custom fields for spell checking -->";
+		$xml .= "\n\t\t<field name='_spellcheckText' type='textSpellHtml' indexed='true' "
+			. "stored='false' multiValued='true' />";
 
-        return $xml;
-    }
+		return $xml;
+	}
 
-    /**
-     *
-     * @param SearchQuery $query
-     * @param int $offset
-     * @param int $limit
-     * @param array $params
-     * @return ArrayData
-     */
-    public function search(SearchQuery $query, $offset = -1, $limit = -1, $params = [])
-    {
-        // Override dictionary if given
-        if ($dictionary = $this->config()->dictionary) {
-            $params["spellcheck.dictionary"] = $dictionary;
-        }
+	/**
+	 *
+	 * @param SearchQuery $query
+	 * @param int $offset
+	 * @param int $limit
+	 * @param array $params
+	 * @return ArrayData
+	 */
+	public function search(SearchQuery $query, $offset = -1, $limit = -1, $params = [])
+	{
+		// Override dictionary if given
+		if ($dictionary = $this->config()->dictionary) {
+			$params["spellcheck.dictionary"] = $dictionary;
+		}
 
-        return parent::search($query, $offset, $limit, $params);
-    }
+		return parent::search($query, $offset, $limit, $params);
+	}
 }

src/Search/CwpSolr.php

Indentation +105 added lines, -105 removed lines

@@ -14,119 +14,119 @@
  */
 class CwpSolr
 {
-    use Configurable;
+	use Configurable;
 
-    /**
-     *
-     * @var array
-     */
-    private static $options;
+	/**
+	 *
+	 * @var array
+	 */
+	private static $options;
 
-    /**
-     * Configure Solr.
-     *
-     * $options - An array consisting of:
-     *
-     * 'extraspath' - (String) Where to find Solr core configuartion files.
-     *     Defaults to '<BASE_PATH>/mysite/conf/extras'.
-     * 'version' - select the Solr configuration to use when in CWP. One of:
-     * * 'cwp-4': preferred version, uses secured 4.x service available on CWP
-     * * 'local-4': this can be use for development using silverstripe-localsolr package, 4.x branch
-     */
-    public static function configure()
-    {
-        if (!class_exists(Solr::class)) {
-            return;
-        }
+	/**
+	 * Configure Solr.
+	 *
+	 * $options - An array consisting of:
+	 *
+	 * 'extraspath' - (String) Where to find Solr core configuartion files.
+	 *     Defaults to '<BASE_PATH>/mysite/conf/extras'.
+	 * 'version' - select the Solr configuration to use when in CWP. One of:
+	 * * 'cwp-4': preferred version, uses secured 4.x service available on CWP
+	 * * 'local-4': this can be use for development using silverstripe-localsolr package, 4.x branch
+	 */
+	public static function configure()
+	{
+		if (!class_exists(Solr::class)) {
+			return;
+		}
 
-        // get options from configuration
-        $options = static::config()->get('options');
+		// get options from configuration
+		$options = static::config()->get('options');
 
-        // get version specific options
-        switch ($options['version']) {
-            case 'cwp-4':
-                $solrOptions = self::options_for_cwp($options);
-                break;
-            case 'local-4':
-                $solrOptions = self::options_for_local($options);
-                break;
-            default:
-                throw new InvalidArgumentException(sprintf(
-                    'Solr version "%s" is not supported on CWP. Please use "local-4" on local ' .
-                        'and "cwp-4" on production. For preferred configuration see ' .
-                        'https://www.cwp.govt.nz/developer-docs/.',
-                    $options['version']
-                ));
-                break;
-        }
+		// get version specific options
+		switch ($options['version']) {
+			case 'cwp-4':
+				$solrOptions = self::options_for_cwp($options);
+				break;
+			case 'local-4':
+				$solrOptions = self::options_for_local($options);
+				break;
+			default:
+				throw new InvalidArgumentException(sprintf(
+					'Solr version "%s" is not supported on CWP. Please use "local-4" on local ' .
+						'and "cwp-4" on production. For preferred configuration see ' .
+						'https://www.cwp.govt.nz/developer-docs/.',
+					$options['version']
+				));
+				break;
+		}
 
-        // Allow users to override extras path.
-        // CAUTION: CWP does not permit usage of customised solrconfig.xml.
-        if (isset($options['extraspath']) && file_exists($options['extraspath'])) {
-            $solrOptions['extraspath'] = $options['extraspath'];
-        } elseif (file_exists(BASE_PATH . '/mysite/conf/extras')) {
-            $solrOptions['extraspath'] = BASE_PATH . '/mysite/conf/extras';
-        }
+		// Allow users to override extras path.
+		// CAUTION: CWP does not permit usage of customised solrconfig.xml.
+		if (isset($options['extraspath']) && file_exists($options['extraspath'])) {
+			$solrOptions['extraspath'] = $options['extraspath'];
+		} elseif (file_exists(BASE_PATH . '/mysite/conf/extras')) {
+			$solrOptions['extraspath'] = BASE_PATH . '/mysite/conf/extras';
+		}
 
-        Solr::configure_server($solrOptions);
-    }
+		Solr::configure_server($solrOptions);
+	}
 
-    /**
-     * @throws Exception
-     */
-    public static function options_from_environment()
-    {
-        throw new Exception(
-            'CwpSolr::options_from_environment has been deprecated, in favour of implicit Solr ' .
-            'configuration provided by the CwpSolr class in the cwp-core module. For preferred configuration see ' .
-            'https://www.cwp.govt.nz/developer-docs/.'
-        );
-    }
+	/**
+	 * @throws Exception
+	 */
+	public static function options_from_environment()
+	{
+		throw new Exception(
+			'CwpSolr::options_from_environment has been deprecated, in favour of implicit Solr ' .
+			'configuration provided by the CwpSolr class in the cwp-core module. For preferred configuration see ' .
+			'https://www.cwp.govt.nz/developer-docs/.'
+		);
+	}
 
-    /**
-     * @param array $options
-     * @return array
-     */
-    public static function options_for_cwp($options)
-    {
-        $version = $options['version'];
+	/**
+	 * @param array $options
+	 * @return array
+	 */
+	public static function options_for_cwp($options)
+	{
+		$version = $options['version'];
 
-        return [
-            'host' => Environment::getEnv('SOLR_SERVER'),
-            'port' => Environment::getEnv('SOLR_PORT'),
-            'path' => '/v4/',
-            'version' => 4,
-            'indexstore' => [
-                'mode' => CwpSolrConfigStore::class,
-                'path' => '/v4',
-            ],
-        ];
-    }
+		return [
+			'host' => Environment::getEnv('SOLR_SERVER'),
+			'port' => Environment::getEnv('SOLR_PORT'),
+			'path' => '/v4/',
+			'version' => 4,
+			'indexstore' => [
+				'mode' => CwpSolrConfigStore::class,
+				'path' => '/v4',
+			],
+		];
+	}
 
-    /**
-     *
-     * @param array $options
-     * @return array
-     */
-    public static function options_for_local($options)
-    {
-        return [
-            'host' => Environment::getEnv('SOLR_SERVER') ? Environment::getEnv('SOLR_SERVER') : 'localhost',
-            'port' => Environment::getEnv('SOLR_PORT') ? Environment::getEnv('SOLR_PORT') : 8983,
-            'path' => Environment::getEnv('SOLR_PATH') ? Environment::getEnv('SOLR_PATH') : '/solr/',
-            'version' => 4,
-            'indexstore' => [
-                'mode' => Environment::getEnv('SOLR_MODE') ? Environment::getEnv('SOLR_MODE') : 'file',
-                'auth' => Environment::getEnv('SOLR_AUTH') ? Environment::getEnv('SOLR_AUTH') : null,
-                // Allow storing the solr index and config data in an arbitrary location,
-                // e.g. outside of the webroot
-                'path' => Environment::getEnv('SOLR_INDEXSTORE_PATH')
-                    ? Environment::getEnv('SOLR_INDEXSTORE_PATH')
-                    : BASE_PATH . '/.solr',
-                'remotepath' => Environment::getEnv('SOLR_REMOTE_PATH')
-                    ? Environment::getEnv('SOLR_REMOTE_PATH')
-                    : null
-            ]
-        ];
-    }
+	/**
+	 *
+	 * @param array $options
+	 * @return array
+	 */
+	public static function options_for_local($options)
+	{
+		return [
+			'host' => Environment::getEnv('SOLR_SERVER') ? Environment::getEnv('SOLR_SERVER') : 'localhost',
+			'port' => Environment::getEnv('SOLR_PORT') ? Environment::getEnv('SOLR_PORT') : 8983,
+			'path' => Environment::getEnv('SOLR_PATH') ? Environment::getEnv('SOLR_PATH') : '/solr/',
+			'version' => 4,
+			'indexstore' => [
+				'mode' => Environment::getEnv('SOLR_MODE') ? Environment::getEnv('SOLR_MODE') : 'file',
+				'auth' => Environment::getEnv('SOLR_AUTH') ? Environment::getEnv('SOLR_AUTH') : null,
+				// Allow storing the solr index and config data in an arbitrary location,
+				// e.g. outside of the webroot
+				'path' => Environment::getEnv('SOLR_INDEXSTORE_PATH')
+					? Environment::getEnv('SOLR_INDEXSTORE_PATH')
+					: BASE_PATH . '/.solr',
+				'remotepath' => Environment::getEnv('SOLR_REMOTE_PATH')
+					? Environment::getEnv('SOLR_REMOTE_PATH')
+					: null
+			]
+		];
+	}
 }

src/Search/CwpSolrConfigStore.php

Indentation +57 added lines, -57 removed lines

@@ -12,68 +12,68 @@
  */
 class CwpSolrConfigStore implements SolrConfigStore
 {
-    /**
-     * @var string
-     */
-    protected $remote = '';
+	/**
+	 * @var string
+	 */
+	protected $remote = '';
 
-    /**
-     * @var string
-     */
-    protected $url = '';
+	/**
+	 * @var string
+	 */
+	protected $url = '';
 
-    /**
-     * @param array $config
-     */
-    public function __construct($config)
-    {
-        $options = Solr::solr_options();
+	/**
+	 * @param array $config
+	 */
+	public function __construct($config)
+	{
+		$options = Solr::solr_options();
 
-        $this->url = implode('', [
-            'http://',
-            isset($config['auth']) ? $config['auth'] . '@' : '',
-            $options['host'] . ':' . $options['port'],
-            $config['path']
-        ]);
-        $this->remote = $config['remotepath'];
-    }
+		$this->url = implode('', [
+			'http://',
+			isset($config['auth']) ? $config['auth'] . '@' : '',
+			$options['host'] . ':' . $options['port'],
+			$config['path']
+		]);
+		$this->remote = $config['remotepath'];
+	}
 
-    /**
-     * @param string $index
-     * @param string $file
-     * @return void
-     */
-    public function uploadFile($index, $file)
-    {
-        $this->uploadString($index, basename($file), file_get_contents($file));
-    }
+	/**
+	 * @param string $index
+	 * @param string $file
+	 * @return void
+	 */
+	public function uploadFile($index, $file)
+	{
+		$this->uploadString($index, basename($file), file_get_contents($file));
+	}
 
-    /**
-     *
-     * @param string $index
-     * @param string $filename
-     * @param string $string
-     * @return void
-     */
-    public function uploadString($index, $filename, $string)
-    {
-        $targetDir = "{$this->url}/config/$index";
+	/**
+	 *
+	 * @param string $index
+	 * @param string $filename
+	 * @param string $string
+	 * @return void
+	 */
+	public function uploadString($index, $filename, $string)
+	{
+		$targetDir = "{$this->url}/config/$index";
 
-        file_get_contents($targetDir . '/' . $filename, false, stream_context_create([
-            'http' => [
-                'method' => 'POST',
-                'header' => 'Content-type: application/octet-stream',
-                'content' => (string) $string
-            ]
-        ]));
-    }
+		file_get_contents($targetDir . '/' . $filename, false, stream_context_create([
+			'http' => [
+				'method' => 'POST',
+				'header' => 'Content-type: application/octet-stream',
+				'content' => (string) $string
+			]
+		]));
+	}
 
-    /**
-     * @param string $index
-     * @return string
-     */
-    public function instanceDir($index)
-    {
-        return $this->remote ? "{$this->remote}/$index" : $index;
-    }
+	/**
+	 * @param string $index
+	 * @return string
+	 */
+	public function instanceDir($index)
+	{
+		return $this->remote ? "{$this->remote}/$index" : $index;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
             'http' => [
                 'method' => 'POST',
                 'header' => 'Content-type: application/octet-stream',
-                'content' => (string) $string
+                'content' => (string)$string
             ]
         ]));
     }

src/Report/CwpStatsReport.php

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
         $records = [];
 
         // Get the query to apply across all variants: looks at all subsites, translations, live stage only.
-        $crossVariant = (function ($dataQuery) {
+        $crossVariant = (function($dataQuery) {
             $params = [
                 'Subsite.filter' => false,
                 'Versioned.mode' => 'stage',

Indentation +104 added lines, -104 removed lines

@@ -20,108 +20,108 @@
  */
 class CwpStatsReport extends Report
 {
-    public function title()
-    {
-        return _t(__CLASS__ . '.Title', 'Summary statistics');
-    }
-
-    public function description()
-    {
-        return _t(
-            __CLASS__ . '.Description',
-            'This report provides various statistics for this site. The "total live page count" is the number that ' .
-                'can be compared against the instance size specifications.'
-        );
-    }
-
-    public function columns()
-    {
-        return [
-            'Name' => _t(__CLASS__ . '.Name', 'Name'),
-            'Count' => _t(__CLASS__ . '.Count', 'Count'),
-        ];
-    }
-
-    /**
-     * Manually create source records for the report. Agreggates cannot be provided as a column of a DataQuery result.
-     *
-     * {@inheritDoc}
-     */
-    public function sourceRecords($params = [], $sort = null, $limit = null)
-    {
-        $records = [];
-
-        // Get the query to apply across all variants: looks at all subsites, translations, live stage only.
-        $crossVariant = (function ($dataQuery) {
-            $params = [
-                'Subsite.filter' => false,
-                'Versioned.mode' => 'stage',
-                'Versioned.stage' => Versioned::LIVE,
-            ];
-
-            return $dataQuery->setDataQueryParam($params);
-        });
-
-        // Total.
-        $records[] = [
-            'Name' => _t(
-                __CLASS__ . '.TotalPageCount',
-                'Total live page count, across all translations and subsites'
-            ),
-            'Count' => $crossVariant(SiteTree::get())->count(),
-        ];
-
-        if (class_exists(Subsite::class)) {
-            // Main site.
-            $records[] = [
-                'Name' => _t(__CLASS__ . '.PagesForMainSite', '- in the main site'),
-                'Count' => $crossVariant(SiteTree::get())
-                    ->filter(['SubsiteID' => 0])
-                    ->count(),
-            ];
-
-            // Per subsite.
-            $subsites = Subsite::get();
-            foreach ($subsites as $subsite) {
-                $records[] = [
-                    'Name' => _t(
-                        __CLASS__ . '.PagesForSubsite',
-                        "- in the subsite '{SubsiteTitle}'",
-                        ['SubsiteTitle' => $subsite->Title]
-                    ),
-                    'Count' => $crossVariant(SiteTree::get())
-                        ->filter(['SubsiteID' => $subsite->ID])
-                        ->count(),
-                ];
-            }
-        }
-
-        // Files.
-        $records[] = [
-            'Name' => _t(__CLASS__ . '.FileCount', 'File count'),
-            'Count' => File::get()
-                ->setDataQueryParam('Subsite.filter', false)
-                ->filter(['ClassName:not' => Folder::class])
-                ->count(),
-        ];
-
-        return ArrayList::create($records);
-    }
-
-    /**
-     * @return GridField
-     */
-    public function getReportField()
-    {
-        /** @var GridField $gridField */
-        $gridField = parent::getReportField();
-
-        /** @var GridFieldConfig $gridConfig */
-        $gridConfig = $gridField->getConfig();
-        $gridConfig->removeComponentsByType(GridFieldPrintButton::class);
-        $gridConfig->removeComponentsByType(GridFieldExportButton::class);
-        $gridConfig->removeComponentsByType(GridFieldSortableHeader::class);
-
-        return $gridField;
-    }
+	public function title()
+	{
+		return _t(__CLASS__ . '.Title', 'Summary statistics');
+	}
+
+	public function description()
+	{
+		return _t(
+			__CLASS__ . '.Description',
+			'This report provides various statistics for this site. The "total live page count" is the number that ' .
+				'can be compared against the instance size specifications.'
+		);
+	}
+
+	public function columns()
+	{
+		return [
+			'Name' => _t(__CLASS__ . '.Name', 'Name'),
+			'Count' => _t(__CLASS__ . '.Count', 'Count'),
+		];
+	}
+
+	/**
+	 * Manually create source records for the report. Agreggates cannot be provided as a column of a DataQuery result.
+	 *
+	 * {@inheritDoc}
+	 */
+	public function sourceRecords($params = [], $sort = null, $limit = null)
+	{
+		$records = [];
+
+		// Get the query to apply across all variants: looks at all subsites, translations, live stage only.
+		$crossVariant = (function ($dataQuery) {
+			$params = [
+				'Subsite.filter' => false,
+				'Versioned.mode' => 'stage',
+				'Versioned.stage' => Versioned::LIVE,
+			];
+
+			return $dataQuery->setDataQueryParam($params);
+		});
+
+		// Total.
+		$records[] = [
+			'Name' => _t(
+				__CLASS__ . '.TotalPageCount',
+				'Total live page count, across all translations and subsites'
+			),
+			'Count' => $crossVariant(SiteTree::get())->count(),
+		];
+
+		if (class_exists(Subsite::class)) {
+			// Main site.
+			$records[] = [
+				'Name' => _t(__CLASS__ . '.PagesForMainSite', '- in the main site'),
+				'Count' => $crossVariant(SiteTree::get())
+					->filter(['SubsiteID' => 0])
+					->count(),
+			];
+
+			// Per subsite.
+			$subsites = Subsite::get();
+			foreach ($subsites as $subsite) {
+				$records[] = [
+					'Name' => _t(
+						__CLASS__ . '.PagesForSubsite',
+						"- in the subsite '{SubsiteTitle}'",
+						['SubsiteTitle' => $subsite->Title]
+					),
+					'Count' => $crossVariant(SiteTree::get())
+						->filter(['SubsiteID' => $subsite->ID])
+						->count(),
+				];
+			}
+		}
+
+		// Files.
+		$records[] = [
+			'Name' => _t(__CLASS__ . '.FileCount', 'File count'),
+			'Count' => File::get()
+				->setDataQueryParam('Subsite.filter', false)
+				->filter(['ClassName:not' => Folder::class])
+				->count(),
+		];
+
+		return ArrayList::create($records);
+	}
+
+	/**
+	 * @return GridField
+	 */
+	public function getReportField()
+	{
+		/** @var GridField $gridField */
+		$gridField = parent::getReportField();
+
+		/** @var GridFieldConfig $gridConfig */
+		$gridConfig = $gridField->getConfig();
+		$gridConfig->removeComponentsByType(GridFieldPrintButton::class);
+		$gridConfig->removeComponentsByType(GridFieldExportButton::class);
+		$gridConfig->removeComponentsByType(GridFieldSortableHeader::class);
+
+		return $gridField;
+	}
 }