silverstripe / cwp-core

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

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.";
             }
         }
 

Indentation +66 added lines, -66 removed lines

@@ -19,81 +19,81 @@
 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(DBDatetime::ISO_DATETIME)
-        );
+		$session->set(
+			'LoginAttemptNotifications.SessionLastVisited',
+			DBDatetime::now()->Format(DBDatetime::ISO_DATETIME)
+		);
 
-        $this->owner->getResponse()->addHeader('X-LoginAttemptNotifications', $message);
-    }
+		$this->owner->getResponse()->addHeader('X-LoginAttemptNotifications', $message);
+	}
 }

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 +105 added lines, -105 removed lines

@@ -16,7 +16,7 @@ 
 use SilverStripe\Versioned\Versioned;
 
 if (!class_exists(Report::class)) {
-    return;
+	return;
 }
 
 /**
@@ -24,108 +24,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;
+	}
 }

src/Feed/CwpAtomFeed.php

Indentation +49 added lines, -49 removed lines

@@ -18,57 +18,57 @@
 
 class CwpAtomFeed extends RSSFeed
 {
-    public function __construct(
-        SS_List $entries,
-        $link,
-        $title,
-        $description = null,
-        $titleField = "Title",
-        $descriptionField = "Content",
-        $authorField = null,
-        $lastModified = null,
-        $etag = null
-    ) {
-        parent::__construct(
-            $entries,
-            $link,
-            $title,
-            $description,
-            $titleField,
-            $descriptionField,
-            $authorField,
-            $lastModified
-        );
+	public function __construct(
+		SS_List $entries,
+		$link,
+		$title,
+		$description = null,
+		$titleField = "Title",
+		$descriptionField = "Content",
+		$authorField = null,
+		$lastModified = null,
+		$etag = null
+	) {
+		parent::__construct(
+			$entries,
+			$link,
+			$title,
+			$description,
+			$titleField,
+			$descriptionField,
+			$authorField,
+			$lastModified
+		);
 
-        $this->setTemplate(__CLASS__);
-    }
+		$this->setTemplate(__CLASS__);
+	}
 
-    /**
-     * Include an link to the feed
-     *
-     * @param string $url URL of the feed
-     * @param string $title Title to show
-     */
-    public static function linkToFeed($url, $title = null)
-    {
-        $title = Convert::raw2xml($title);
-        Requirements::insertHeadTags(
-            '<link rel="alternate" type="application/atom+xml" title="' . $title .
-            '" href="' . $url . '" />'
-        );
-    }
+	/**
+	 * Include an link to the feed
+	 *
+	 * @param string $url URL of the feed
+	 * @param string $title Title to show
+	 */
+	public static function linkToFeed($url, $title = null)
+	{
+		$title = Convert::raw2xml($title);
+		Requirements::insertHeadTags(
+			'<link rel="alternate" type="application/atom+xml" title="' . $title .
+			'" href="' . $url . '" />'
+		);
+	}
 
-    /**
-     * Output the feed to the browser
-     *
-     * @return DBHTMLText
-     */
-    public function outputToBrowser()
-    {
-        $output = parent::outputToBrowser();
-        $response = Controller::curr()->getResponse();
-        $response->addHeader("Content-Type", "application/atom+xml");
+	/**
+	 * Output the feed to the browser
+	 *
+	 * @return DBHTMLText
+	 */
+	public function outputToBrowser()
+	{
+		$output = parent::outputToBrowser();
+		$response = Controller::curr()->getResponse();
+		$response->addHeader("Content-Type", "application/atom+xml");
 
-        return $output;
-    }
+		return $output;
+	}
 }

src/Extension/RichLinksExtension.php

Indentation +44 added lines, -44 removed lines

@@ -16,48 +16,48 @@
 class RichLinksExtension extends Extension
 {
 
-    /**
-     * @var array
-     */
-    private static $casting = [
-        'RichLinks' => 'HTMLText'
-    ];
-
-    /**
-     * @return string
-     */
-    public function RichLinks()
-    {
-        // Note:
-        // Assume we can use Regexes because the link will always be formatted
-        // in the same way coming from the CMS.
-
-        $content = $this->owner->value;
-
-        // Find all file links for processing.
-        preg_match_all('/<a.*href="\[file_link,id=([0-9]+)\].*".*>.*<\/a>/U', $content, $matches);
-
-        // Attach the file type and size to each of the links.
-        for ($i = 0; $i < count($matches[0]); $i++) {
-            $file = DataObject::get_by_id('File', $matches[1][$i]);
-            if ($file) {
-                $size = $file->getSize();
-                $ext = strtoupper($file->getExtension());
-                // Replace the closing </a> tag with the size span (and reattach the closing tag).
-                $newLink = substr($matches[0][$i], 0, strlen($matches[0][$i]) - 4)
-                    . "<span class='fileExt'> [$ext, $size]</span></a>";
-                $content = str_replace($matches[0][$i], $newLink, $content);
-            }
-        }
-
-        // Inject extra attributes into the external links.
-        $pattern = '/(<a.*)(href=\"https?:\/\/[^\"]*\"[^>]*>.*)(<\/a>)/iU';
-        $replacement = sprintf(
-            '$1class="external" rel="external" title="%s" $2<span class="nonvisual-indicator">(external link)</span>$3',
-            _t(__CLASS__ . '.OpenLinkTitle', 'Open external link')
-        );
-        $content = preg_replace($pattern, $replacement, $content, -1);
-
-        return $content;
-    }
+	/**
+	 * @var array
+	 */
+	private static $casting = [
+		'RichLinks' => 'HTMLText'
+	];
+
+	/**
+	 * @return string
+	 */
+	public function RichLinks()
+	{
+		// Note:
+		// Assume we can use Regexes because the link will always be formatted
+		// in the same way coming from the CMS.
+
+		$content = $this->owner->value;
+
+		// Find all file links for processing.
+		preg_match_all('/<a.*href="\[file_link,id=([0-9]+)\].*".*>.*<\/a>/U', $content, $matches);
+
+		// Attach the file type and size to each of the links.
+		for ($i = 0; $i < count($matches[0]); $i++) {
+			$file = DataObject::get_by_id('File', $matches[1][$i]);
+			if ($file) {
+				$size = $file->getSize();
+				$ext = strtoupper($file->getExtension());
+				// Replace the closing </a> tag with the size span (and reattach the closing tag).
+				$newLink = substr($matches[0][$i], 0, strlen($matches[0][$i]) - 4)
+					. "<span class='fileExt'> [$ext, $size]</span></a>";
+				$content = str_replace($matches[0][$i], $newLink, $content);
+			}
+		}
+
+		// Inject extra attributes into the external links.
+		$pattern = '/(<a.*)(href=\"https?:\/\/[^\"]*\"[^>]*>.*)(<\/a>)/iU';
+		$replacement = sprintf(
+			'$1class="external" rel="external" title="%s" $2<span class="nonvisual-indicator">(external link)</span>$3',
+			_t(__CLASS__ . '.OpenLinkTitle', 'Open external link')
+		);
+		$content = preg_replace($pattern, $replacement, $content, -1);
+
+		return $content;
+	}
 }

tests/CwpStatsReportTest.php

Indentation +43 added lines, -43 removed lines

@@ -9,47 +9,47 @@
 
 class CwpStatsReportTest extends SapphireTest
 {
-    protected static $fixture_file = 'CwpStatsReportTest.yml';
-
-    protected function setUp()
-    {
-        if (!class_exists(CwpStatsReport::class)) {
-            // If CMS is not installed, do not run this test class
-            static::$fixture_file = null;
-            parent::setUp();
-            $this->markTestSkipped('This test class requires the CMS module to be installed.');
-        }
-
-        parent::setUp();
-    }
-
-    public function testCount()
-    {
-        // Publish all pages apart from page3.
-        $this->objFromFixture(Page::class, 'page1')->publishRecursive();
-        $this->objFromFixture(Page::class, 'page2')->publishRecursive();
-        $this->objFromFixture(Page::class, 'page3')->publishRecursive();
-
-        // Add page5s to a subsite, if the module is installed.
-        $page5s = $this->objFromFixture(Page::class, 'page5s');
-        if (class_exists(Subsite::class)) {
-            $subsite = Subsite::create();
-            $subsite->Title = 'subsite';
-            $subsite->write();
-
-            $page5s->SubsiteID = $subsite->ID;
-            $page5s->write();
-        }
-        $page5s->publishRecursive();
-
-        $report = CwpStatsReport::create();
-        $records = $report->sourceRecords([])->toArray();
-        $i = 0;
-        $this->assertEquals($records[$i++]['Count'], 4, 'Four pages in total, across locales, subsites, live only.');
-        if (class_exists(Subsite::class)) {
-            $this->assertEquals($records[$i++]['Count'], 3, 'Three pages in the main site, if subsites installed.');
-            $this->assertEquals($records[$i++]['Count'], 1, 'One page in the subsite, if subsites installed');
-        }
-        $this->assertEquals($records[$i++]['Count'], 1, 'One file in total.');
-    }
+	protected static $fixture_file = 'CwpStatsReportTest.yml';
+
+	protected function setUp()
+	{
+		if (!class_exists(CwpStatsReport::class)) {
+			// If CMS is not installed, do not run this test class
+			static::$fixture_file = null;
+			parent::setUp();
+			$this->markTestSkipped('This test class requires the CMS module to be installed.');
+		}
+
+		parent::setUp();
+	}
+
+	public function testCount()
+	{
+		// Publish all pages apart from page3.
+		$this->objFromFixture(Page::class, 'page1')->publishRecursive();
+		$this->objFromFixture(Page::class, 'page2')->publishRecursive();
+		$this->objFromFixture(Page::class, 'page3')->publishRecursive();
+
+		// Add page5s to a subsite, if the module is installed.
+		$page5s = $this->objFromFixture(Page::class, 'page5s');
+		if (class_exists(Subsite::class)) {
+			$subsite = Subsite::create();
+			$subsite->Title = 'subsite';
+			$subsite->write();
+
+			$page5s->SubsiteID = $subsite->ID;
+			$page5s->write();
+		}
+		$page5s->publishRecursive();
+
+		$report = CwpStatsReport::create();
+		$records = $report->sourceRecords([])->toArray();
+		$i = 0;
+		$this->assertEquals($records[$i++]['Count'], 4, 'Four pages in total, across locales, subsites, live only.');
+		if (class_exists(Subsite::class)) {
+			$this->assertEquals($records[$i++]['Count'], 3, 'Three pages in the main site, if subsites installed.');
+			$this->assertEquals($records[$i++]['Count'], 1, 'One page in the subsite, if subsites installed');
+		}
+		$this->assertEquals($records[$i++]['Count'], 1, 'One file in total.');
+	}
 }