silverstripe / silverstripe-securityreport

src/UserSecurityReport.php

Indentation +116 added lines, -116 removed lines

@@ -22,130 +22,130 @@
 class UserSecurityReport extends Report
 {
 
-    /**
-     * Columns in the report
-     *
-     * @var array
-     * @config
-     */
-    private static $columns = array(
-        'ID' => 'User ID',
-        'FirstName' => 'First Name',
-        'Surname' => 'Surname',
-        'Email' => 'Email',
-        'Created' => 'Date Created',
-        'LastLoggedIn' => 'Last Logged In',
-        'GroupsDescription' => 'Groups',
-        'PermissionsDescription' => 'Permissions',
-    );
+	/**
+	 * Columns in the report
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $columns = array(
+		'ID' => 'User ID',
+		'FirstName' => 'First Name',
+		'Surname' => 'Surname',
+		'Email' => 'Email',
+		'Created' => 'Date Created',
+		'LastLoggedIn' => 'Last Logged In',
+		'GroupsDescription' => 'Groups',
+		'PermissionsDescription' => 'Permissions',
+	);
     
-    protected $dataClass = Member::class;
+	protected $dataClass = Member::class;
 
-    /**
-     * Returns the report title
-     *
-     * @return string
-     */
-    public function title()
-    {
-        return _t(__CLASS__ . '.REPORTTITLE', 'Users, Groups and Permissions');
-    }
+	/**
+	 * Returns the report title
+	 *
+	 * @return string
+	 */
+	public function title()
+	{
+		return _t(__CLASS__ . '.REPORTTITLE', 'Users, Groups and Permissions');
+	}
 
-    /**
-     * Builds a report description which is the current hostname with the current date and time
-     *
-     * @return string e.g. localhost/sitename - 21/12/2112
-     */
-    public function description()
-    {
-        return str_replace(
-            array('http', 'https', '://'),
-            '',
-            Director::protocolAndHost() . ' - ' . date('d/m/Y H:i:s')
-        );
-    }
+	/**
+	 * Builds a report description which is the current hostname with the current date and time
+	 *
+	 * @return string e.g. localhost/sitename - 21/12/2112
+	 */
+	public function description()
+	{
+		return str_replace(
+			array('http', 'https', '://'),
+			'',
+			Director::protocolAndHost() . ' - ' . date('d/m/Y H:i:s')
+		);
+	}
 
-    /**
-     * Returns the column names of the report
-     *
-     * @return array
-     */
-    public function columns()
-    {
-        $columns = self::config()->columns;
-        if (!Security::config()->get('login_recording')) {
-            unset($columns['LastLoggedIn']);
-        }
-        return $columns;
-    }
+	/**
+	 * Returns the column names of the report
+	 *
+	 * @return array
+	 */
+	public function columns()
+	{
+		$columns = self::config()->columns;
+		if (!Security::config()->get('login_recording')) {
+			unset($columns['LastLoggedIn']);
+		}
+		return $columns;
+	}
 
-    /**
-     * Alias of columns(), to support the export to csv action
-     * in {@link GridFieldExportButton} generateExportFileData method.
-     * @return array
-     */
-    public function getColumns()
-    {
-        return $this->columns();
-    }
+	/**
+	 * Alias of columns(), to support the export to csv action
+	 * in {@link GridFieldExportButton} generateExportFileData method.
+	 * @return array
+	 */
+	public function getColumns()
+	{
+		return $this->columns();
+	}
 
-    /**
-     * @return array
-     */
-    public function summaryFields()
-    {
-        return $this->columns();
-    }
+	/**
+	 * @return array
+	 */
+	public function summaryFields()
+	{
+		return $this->columns();
+	}
 
-    /**
-     * Defines the sortable columns on the report gridfield
-     *
-     * @return array
-     */
-    public function sortColumns()
-    {
-        return array_keys($this->columns());
-    }
+	/**
+	 * Defines the sortable columns on the report gridfield
+	 *
+	 * @return array
+	 */
+	public function sortColumns()
+	{
+		return array_keys($this->columns());
+	}
 
-    /**
-     * Get the source records for the report gridfield
-     *
-     * @return DataList
-     */
-    public function sourceRecords()
-    {
-        // Get members sorted by ID
-        return Member::get()->sort('ID');
-    }
+	/**
+	 * Get the source records for the report gridfield
+	 *
+	 * @return DataList
+	 */
+	public function sourceRecords()
+	{
+		// Get members sorted by ID
+		return Member::get()->sort('ID');
+	}
 
-    /**
-     * Restrict access to this report to users with security admin access
-     *
-     * @param Member $member
-     * @return boolean
-     */
-    public function canView($member = null)
-    {
-        return (bool)Permission::checkMember($member, "CMS_ACCESS_SecurityAdmin");
-    }
+	/**
+	 * Restrict access to this report to users with security admin access
+	 *
+	 * @param Member $member
+	 * @return boolean
+	 */
+	public function canView($member = null)
+	{
+		return (bool)Permission::checkMember($member, "CMS_ACCESS_SecurityAdmin");
+	}
 
-    /**
-     * Return a field, such as a {@link GridField} that is
-     * used to show and manipulate data relating to this report.
-     *
-     * @return FormField subclass
-     */
-    public function getReportField()
-    {
-        /** @var GridField $gridField */
-        $gridField = parent::getReportField();
-        $gridField->setModelClass(self::class);
-        $gridConfig = $gridField->getConfig();
-        $gridConfig->removeComponentsByType([GridFieldPrintButton::class, GridFieldExportButton::class]);
-        $gridConfig->addComponents(
-            new GridFieldPrintReportButton('buttons-before-left'),
-            new GridFieldExportReportButton('buttons-before-left')
-        );
-        return $gridField;
-    }
+	/**
+	 * Return a field, such as a {@link GridField} that is
+	 * used to show and manipulate data relating to this report.
+	 *
+	 * @return FormField subclass
+	 */
+	public function getReportField()
+	{
+		/** @var GridField $gridField */
+		$gridField = parent::getReportField();
+		$gridField->setModelClass(self::class);
+		$gridConfig = $gridField->getConfig();
+		$gridConfig->removeComponentsByType([GridFieldPrintButton::class, GridFieldExportButton::class]);
+		$gridConfig->addComponents(
+			new GridFieldPrintReportButton('buttons-before-left'),
+			new GridFieldExportReportButton('buttons-before-left')
+		);
+		return $gridField;
+	}
 }

tests/UserSecurityReportTest.php

Indentation +76 added lines, -76 removed lines

@@ -20,80 +20,80 @@
 class UserSecurityReportTest extends SapphireTest
 {
 
-    protected static $fixture_file = 'UserSecurityReportTest.yml';
-
-    protected $records;
-    protected $report;
-
-    protected static $required_extensions = [
-        Member::class => [
-            MemberReportExtension::class,
-        ],
-    ];
-
-    protected static $illegal_extensions = [
-        Group::class => [
-            GroupSubsites::class,
-        ],
-    ];
-
-    /**
-     * Utility method for all tests to use.
-     *
-     * @return \ArrayList
-     * @todo pre-fill the report with fixture-defined users
-     */
-    protected function setUp()
-    {
-        parent::setUp();
-        $reports = Report::get_reports();
-        $report = $reports[UserSecurityReport::class];
-        $this->report = $report;
-        $this->records = $report->sourceRecords()->toArray();
-    }
-
-    public function testSourceRecords()
-    {
-        $this->assertNotEmpty($this->records);
-    }
-
-    public function testGetMemberGroups()
-    {
-        //getMemberGroups(&$member) returns string
-        $member = $this->objFromFixture(Member::class, 'member-has-0-groups');
-        $groups = $member->GroupsDescription;
-        $this->assertEquals('Not in a Security Group', $groups);
-
-        $member = $this->objFromFixture(Member::class, 'member-has-1-groups');
-        $groups = $member->GroupsDescription;
-        $this->assertEquals('Group Test 01', $groups);
-    }
-
-    public function testGetMemberPermissions()
-    {
-        $member = $this->objFromFixture(Member::class, 'member-has-0-permissions');
-        $perms = $member->PermissionsDescription;
-        $this->assertEquals('No Permissions', $perms);
-
-        $member = $this->objFromFixture(Member::class, 'member-has-1-permissions');
-        $perms = $member->PermissionsDescription;
-        $this->assertEquals('Full administrative rights', $perms);
-
-        $member = $this->objFromFixture(Member::class, 'member-has-n-permissions');
-        $perms = $member->PermissionsDescription;
-        $this->assertEquals('Full administrative rights, Edit any page', $perms);
-    }
-
-    public function testLoginLoggingColumnShowsOnlyWhenApplicable()
-    {
-        $original = Config::inst()->get(Security::class, 'login_recording');
-
-        Config::modify()->set(Security::class, 'login_recording', true);
-        $this->assertContains('LastLoggedIn', array_keys($this->report->columns()));
-
-        Config::modify()->set(Security::class, 'login_recording', false);
-        $this->assertNotContains('LastLoggedIn', array_keys($this->report->columns()));
-
-        Config::modify()->set(Security::class, 'login_recording', $original);
-    }
+	protected static $fixture_file = 'UserSecurityReportTest.yml';
+
+	protected $records;
+	protected $report;
+
+	protected static $required_extensions = [
+		Member::class => [
+			MemberReportExtension::class,
+		],
+	];
+
+	protected static $illegal_extensions = [
+		Group::class => [
+			GroupSubsites::class,
+		],
+	];
+
+	/**
+	 * Utility method for all tests to use.
+	 *
+	 * @return \ArrayList
+	 * @todo pre-fill the report with fixture-defined users
+	 */
+	protected function setUp()
+	{
+		parent::setUp();
+		$reports = Report::get_reports();
+		$report = $reports[UserSecurityReport::class];
+		$this->report = $report;
+		$this->records = $report->sourceRecords()->toArray();
+	}
+
+	public function testSourceRecords()
+	{
+		$this->assertNotEmpty($this->records);
+	}
+
+	public function testGetMemberGroups()
+	{
+		//getMemberGroups(&$member) returns string
+		$member = $this->objFromFixture(Member::class, 'member-has-0-groups');
+		$groups = $member->GroupsDescription;
+		$this->assertEquals('Not in a Security Group', $groups);
+
+		$member = $this->objFromFixture(Member::class, 'member-has-1-groups');
+		$groups = $member->GroupsDescription;
+		$this->assertEquals('Group Test 01', $groups);
+	}
+
+	public function testGetMemberPermissions()
+	{
+		$member = $this->objFromFixture(Member::class, 'member-has-0-permissions');
+		$perms = $member->PermissionsDescription;
+		$this->assertEquals('No Permissions', $perms);
+
+		$member = $this->objFromFixture(Member::class, 'member-has-1-permissions');
+		$perms = $member->PermissionsDescription;
+		$this->assertEquals('Full administrative rights', $perms);
+
+		$member = $this->objFromFixture(Member::class, 'member-has-n-permissions');
+		$perms = $member->PermissionsDescription;
+		$this->assertEquals('Full administrative rights, Edit any page', $perms);
+	}
+
+	public function testLoginLoggingColumnShowsOnlyWhenApplicable()
+	{
+		$original = Config::inst()->get(Security::class, 'login_recording');
+
+		Config::modify()->set(Security::class, 'login_recording', true);
+		$this->assertContains('LastLoggedIn', array_keys($this->report->columns()));
+
+		Config::modify()->set(Security::class, 'login_recording', false);
+		$this->assertNotContains('LastLoggedIn', array_keys($this->report->columns()));
+
+		Config::modify()->set(Security::class, 'login_recording', $original);
+	}
 }

src/MemberReportExtension.php

Indentation +98 added lines, -98 removed lines

@@ -13,113 +13,113 @@
 class MemberReportExtension extends DataExtension
 {
 
-    /**
-     * Connect the link to LoginAttempt.
-     * This relationship is always defined (whether enabled or not),
-     * although only normally accessible from the `LoginAttempt` side.
-     * This is adding the reflection, as that it is also accessible
-     * from the `Member` side.
-     *
-     * @var array
-     * @config
-     */
-    private static $has_many = [
-        'LoginAttempts' => LoginAttempt::class
-    ];
+	/**
+	 * Connect the link to LoginAttempt.
+	 * This relationship is always defined (whether enabled or not),
+	 * although only normally accessible from the `LoginAttempt` side.
+	 * This is adding the reflection, as that it is also accessible
+	 * from the `Member` side.
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $has_many = [
+		'LoginAttempts' => LoginAttempt::class
+	];
     
-    /**
-     * Set cast of additional fields
-     *
-     * @var array
-     * @config
-     */
-    private static $casting = array(
-        'GroupsDescription' => 'Text',
-        'PermissionsDescription' => 'Text'
-    );
+	/**
+	 * Set cast of additional fields
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $casting = array(
+		'GroupsDescription' => 'Text',
+		'PermissionsDescription' => 'Text'
+	);
 
-    /**
-     * Retrieves the most recent successful LoginAttempt
-     *
-     * @return DBDatetime|string
-     */
-    public function getLastLoggedIn()
-    {
-        $lastTime = $this->owner->LoginAttempts()
-            ->filter('Status', 'Success')
-            ->sort('Created', 'DESC')
-            ->first();
+	/**
+	 * Retrieves the most recent successful LoginAttempt
+	 *
+	 * @return DBDatetime|string
+	 */
+	public function getLastLoggedIn()
+	{
+		$lastTime = $this->owner->LoginAttempts()
+			->filter('Status', 'Success')
+			->sort('Created', 'DESC')
+			->first();
 
-        return $lastTime ? $lastTime->dbObject('Created') : _t(__CLASS__ . '.NEVER', 'Never');
-    }
+		return $lastTime ? $lastTime->dbObject('Created') : _t(__CLASS__ . '.NEVER', 'Never');
+	}
 
-    /**
-     * Builds a comma separated list of member group names for a given Member.
-     *
-     * @return string
-     */
-    public function getGroupsDescription()
-    {
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(true);
-        }
+	/**
+	 * Builds a comma separated list of member group names for a given Member.
+	 *
+	 * @return string
+	 */
+	public function getGroupsDescription()
+	{
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(true);
+		}
         
-        // Get the member's groups, if any
-        $groups = $this->owner->Groups();
-        if ($groups->Count()) {
-            // Collect the group names
-            $groupNames = array();
-            foreach ($groups as $group) {
-                $groupNames[] = html_entity_decode($group->getTreeTitle());
-            }
-            // return a csv string of the group names, sans-markup
-            $result = preg_replace("#</?[^>]>#", '', implode(', ', $groupNames));
-        } else {
-            // If no groups then return a status label
-            $result = _t(__CLASS__ . '.NOGROUPS', 'Not in a Security Group');
-        }
+		// Get the member's groups, if any
+		$groups = $this->owner->Groups();
+		if ($groups->Count()) {
+			// Collect the group names
+			$groupNames = array();
+			foreach ($groups as $group) {
+				$groupNames[] = html_entity_decode($group->getTreeTitle());
+			}
+			// return a csv string of the group names, sans-markup
+			$result = preg_replace("#</?[^>]>#", '', implode(', ', $groupNames));
+		} else {
+			// If no groups then return a status label
+			$result = _t(__CLASS__ . '.NOGROUPS', 'Not in a Security Group');
+		}
         
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(false);
-        }
-        return $result;
-    }
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(false);
+		}
+		return $result;
+	}
     
-    /**
-     * Builds a comma separated list of human-readbale permissions for a given Member.
-     *
-     * @return string
-     */
-    public function getPermissionsDescription()
-    {
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(true);
-        }
+	/**
+	 * Builds a comma separated list of human-readbale permissions for a given Member.
+	 *
+	 * @return string
+	 */
+	public function getPermissionsDescription()
+	{
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(true);
+		}
         
-        $permissionsUsr = Permission::permissions_for_member($this->owner->ID);
-        $permissionsSrc = Permission::get_codes(true);
-        sort($permissionsUsr);
+		$permissionsUsr = Permission::permissions_for_member($this->owner->ID);
+		$permissionsSrc = Permission::get_codes(true);
+		sort($permissionsUsr);
         
-        $permissionNames = array();
-        foreach ($permissionsUsr as $code) {
-            $code = strtoupper($code);
-            foreach ($permissionsSrc as $k => $v) {
-                if (isset($v[$code])) {
-                    $name = empty($v[$code]['name'])
-                        ? _t(__CLASS__ . '.UNKNOWN', 'Unknown')
-                        : $v[$code]['name'];
-                    $permissionNames[] = $name;
-                }
-            }
-        }
+		$permissionNames = array();
+		foreach ($permissionsUsr as $code) {
+			$code = strtoupper($code);
+			foreach ($permissionsSrc as $k => $v) {
+				if (isset($v[$code])) {
+					$name = empty($v[$code]['name'])
+						? _t(__CLASS__ . '.UNKNOWN', 'Unknown')
+						: $v[$code]['name'];
+					$permissionNames[] = $name;
+				}
+			}
+		}
 
-        $result = $permissionNames
-            ? implode(', ', $permissionNames)
-            : _t(__CLASS__ . '.NOPERMISSIONS', 'No Permissions');
+		$result = $permissionNames
+			? implode(', ', $permissionNames)
+			: _t(__CLASS__ . '.NOPERMISSIONS', 'No Permissions');
         
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(false);
-        }
-        return $result;
-    }
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(false);
+		}
+		return $result;
+	}
 }