silverstripe / silverstripe-siteconfig

code/SiteConfig.php

Doc Comments +4 added lines, -1 removed lines

@@ -277,7 +277,7 @@ 
      * Can a user view this SiteConfig instance?
      *
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -372,6 +372,9 @@ 
         return false;
     }
 
+    /**
+     * @param Member $member
+     */
     public function canEdit($member = null)
     {
         if (!$member) {

Indentation +414 added lines, -414 removed lines

@@ -35,418 +35,418 @@
  */
 class SiteConfig extends DataObject implements PermissionProvider, TemplateGlobalProvider
 {
-    private static $db = array(
-        "Title" => "Varchar(255)",
-        "Tagline" => "Varchar(255)",
-        "CanViewType" => "Enum('Anyone, LoggedInUsers, OnlyTheseUsers', 'Anyone')",
-        "CanEditType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
-        "CanCreateTopLevelType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
-    );
-
-    private static $many_many = array(
-        "ViewerGroups" => "SilverStripe\\Security\\Group",
-        "EditorGroups" => "SilverStripe\\Security\\Group",
-        "CreateTopLevelGroups" => "SilverStripe\\Security\\Group"
-    );
-
-    private static $defaults = array(
-        "CanViewType" => "Anyone",
-        "CanEditType" => "LoggedInUsers",
-        "CanCreateTopLevelType" => "LoggedInUsers",
-    );
-
-    private static $table_name = 'SiteConfig';
-
-    /**
-     * Default permission to check for 'LoggedInUsers' to create or edit pages
-     *
-     * @var array
-     * @config
-     */
-    private static $required_permission = array('CMS_ACCESS_CMSMain', 'CMS_ACCESS_LeftAndMain');
-
-
-    public function populateDefaults()
-    {
-        $this->Title = _t('SilverStripe\\SiteConfig\\SiteConfig.SITENAMEDEFAULT', "Your Site Name");
-        $this->Tagline = _t('SilverStripe\\SiteConfig\\SiteConfig.TAGLINEDEFAULT', "your tagline here");
-
-        // Allow these defaults to be overridden
-        parent::populateDefaults();
-    }
-
-    /**
-     * Get the fields that are sent to the CMS.
-     *
-     * In your extensions: updateCMSFields($fields).
-     *
-     * @return FieldList
-     */
-    public function getCMSFields()
-    {
-        $mapFn = function ($groups = []) {
-            $map = [];
-            foreach ($groups as $group) {
-                // Listboxfield values are escaped, use ASCII char instead of »
-                $map[$group->ID] = $group->getBreadcrumbs(' > ');
-            }
-            asort($map);
-            return $map;
-        };
-        $groupsMap = $mapFn(Group::get());
-        $viewAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_VIEW_ALL', 'ADMIN']));
-        $editAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_EDIT_ALL', 'ADMIN']));
-
-        $fields = new FieldList(
-            new TabSet(
-                "Root",
-                $tabMain = new Tab(
-                    'Main',
-                    $titleField = new TextField("Title", _t('SilverStripe\\SiteConfig\\SiteConfig.SITETITLE', "Site title")),
-                    $taglineField = new TextField("Tagline", _t('SilverStripe\\SiteConfig\\SiteConfig.SITETAGLINE', "Site Tagline/Slogan"))
-                ),
-                $tabAccess = new Tab(
-                    'Access',
-                    $viewersOptionsField = new OptionsetField("CanViewType", _t('SilverStripe\\SiteConfig\\SiteConfig.VIEWHEADER', "Who can view pages on this site?")),
-                    $viewerGroupsField = ListboxField::create("ViewerGroups", _t('SilverStripe\\CMS\\Model\\SiteTree.VIEWERGROUPS', "Viewer Groups"))
-                        ->setSource($groupsMap)
-                        ->setAttribute(
-                            'data-placeholder',
-                            _t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
-                        ),
-                    $editorsOptionsField = new OptionsetField("CanEditType", _t('SilverStripe\\SiteConfig\\SiteConfig.EDITHEADER', "Who can edit pages on this site?")),
-                    $editorGroupsField = ListboxField::create("EditorGroups", _t('SilverStripe\\CMS\\Model\\SiteTree.EDITORGROUPS', "Editor Groups"))
-                        ->setSource($groupsMap)
-                        ->setAttribute(
-                            'data-placeholder',
-                            _t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
-                        ),
-                    $topLevelCreatorsOptionsField = new OptionsetField("CanCreateTopLevelType", _t('SilverStripe\\SiteConfig\\SiteConfig.TOPLEVELCREATE', "Who can create pages in the root of the site?")),
-                    $topLevelCreatorsGroupsField = ListboxField::create("CreateTopLevelGroups", _t(__CLASS__.'.TOPLEVELCREATORGROUPS', "Top level creators"))
-                        ->setSource($groupsMap)
-                        ->setAttribute(
-                            'data-placeholder',
-                            _t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
-                        )
-                )
-            ),
-            new HiddenField('ID')
-        );
-
-        $viewersOptionsSource = array();
-        $viewersOptionsSource["Anyone"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSANYONE', "Anyone");
-        $viewersOptionsSource["LoggedInUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSLOGGEDIN', "Logged-in users");
-        $viewersOptionsSource["OnlyTheseUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSONLYTHESE', "Only these people (choose from list)");
-        $viewersOptionsField->setSource($viewersOptionsSource);
-
-        if ($viewAllGroupsMap) {
-            $viewerGroupsField->setDescription(_t(
-                'SilverStripe\\CMS\\Model\\SiteTree.VIEWER_GROUPS_FIELD_DESC',
-                'Groups with global view permissions: {groupList}',
-                ['groupList' => implode(', ', array_values($viewAllGroupsMap))]
-            ));
-        }
-
-        if ($editAllGroupsMap) {
-            $editorGroupsField->setDescription(_t(
-                'SilverStripe\\CMS\\Model\\SiteTree.EDITOR_GROUPS_FIELD_DESC',
-                'Groups with global edit permissions: {groupList}',
-                ['groupList' => implode(', ', array_values($editAllGroupsMap))]
-            ));
-        }
-
-        $editorsOptionsSource = array();
-        $editorsOptionsSource["LoggedInUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.EDITANYONE', "Anyone who can log-in to the CMS");
-        $editorsOptionsSource["OnlyTheseUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.EDITONLYTHESE', "Only these groups (choose from list)");
-        $editorsOptionsField->setSource($editorsOptionsSource);
-
-        $topLevelCreatorsOptionsField->setSource($editorsOptionsSource);
-
-        if (!Permission::check('EDIT_SITECONFIG')) {
-            $fields->makeFieldReadonly($viewersOptionsField);
-            $fields->makeFieldReadonly($viewerGroupsField);
-            $fields->makeFieldReadonly($editorsOptionsField);
-            $fields->makeFieldReadonly($editorGroupsField);
-            $fields->makeFieldReadonly($topLevelCreatorsOptionsField);
-            $fields->makeFieldReadonly($topLevelCreatorsGroupsField);
-            $fields->makeFieldReadonly($taglineField);
-            $fields->makeFieldReadonly($titleField);
-        }
-
-        if (file_exists(BASE_PATH . '/install.php')) {
-            $fields->addFieldToTab(
-                "Root.Main",
-                new LiteralField(
-                    "InstallWarningHeader",
-                    "<p class=\"message warning\">" . _t(
-                        "SilverStripe\\CMS\\Model\\SiteTree.REMOVE_INSTALL_WARNING",
-                        "Warning: You should remove install.php from this SilverStripe install for security reasons."
-                    ) . "</p>"
-                ),
-                "Title"
-            );
-        }
-
-        $tabMain->setTitle(_t('SilverStripe\\SiteConfig\\SiteConfig.TABMAIN', "Main"));
-        $tabAccess->setTitle(_t('SilverStripe\\SiteConfig\\SiteConfig.TABACCESS', "Access"));
-        $this->extend('updateCMSFields', $fields);
-
-        return $fields;
-    }
-
-    /**
-     * Get the actions that are sent to the CMS.
-     *
-     * In your extensions: updateEditFormActions($actions)
-     *
-     * @return FieldList
-     */
-    public function getCMSActions()
-    {
-        if (Permission::check('ADMIN') || Permission::check('EDIT_SITECONFIG')) {
-            $actions = new FieldList(
-                FormAction::create(
-                    'save_siteconfig',
-                    _t('SilverStripe\\CMS\\Controllers\\CMSMain.SAVE', 'Save')
-                )->addExtraClass('btn-primary font-icon-save')
-            );
-        } else {
-            $actions = new FieldList();
-        }
-
-        $this->extend('updateCMSActions', $actions);
-
-        return $actions;
-    }
-
-    /**
-     * @return string
-     */
-    public function CMSEditLink()
-    {
-        return SiteConfigLeftAndMain::singleton()->Link();
-    }
-
-    /**
-     * Get the current sites SiteConfig, and creates a new one through
-     * {@link make_site_config()} if none is found.
-     *
-     * @return SiteConfig
-     */
-    public static function current_site_config()
-    {
-        /** @var SiteConfig $siteConfig */
-        $siteConfig = DataObject::get_one(SiteConfig::class);
-        if ($siteConfig) {
-            return $siteConfig;
-        }
-
-        return self::make_site_config();
-    }
-
-    /**
-     * Setup a default SiteConfig record if none exists.
-     */
-    public function requireDefaultRecords()
-    {
-        parent::requireDefaultRecords();
-
-        $config = DataObject::get_one(SiteConfig::class);
-
-        if (!$config) {
-            self::make_site_config();
-
-            DB::alteration_message("Added default site config", "created");
-        }
-    }
-
-    /**
-     * Create SiteConfig with defaults from language file.
-     *
-     * @return SiteConfig
-     */
-    public static function make_site_config()
-    {
-        $config = SiteConfig::create();
-        $config->write();
-
-        return $config;
-    }
-
-    /**
-     * Can a user view this SiteConfig instance?
-     *
-     * @param Member $member
-     * @return boolean
-     */
-    public function canView($member = null)
-    {
-        if (!$member) {
-            $member = Security::getCurrentUser();
-        }
-
-        $extended = $this->extendedCan('canView', $member);
-        if ($extended !== null) {
-            return $extended;
-        }
-
-        // Assuming all that can edit this object can also view it
-        return $this->canEdit($member);
-    }
-
-    /**
-     * Can a user view pages on this site? This method is only
-     * called if a page is set to Inherit, but there is nothing
-     * to inherit from.
-     *
-     * @param Member $member
-     * @return boolean
-     */
-    public function canViewPages($member = null)
-    {
-        if (!$member) {
-            $member = Security::getCurrentUser();
-        }
-
-        if ($member && Permission::checkMember($member, "ADMIN")) {
-            return true;
-        }
-
-        $extended = $this->extendedCan('canViewPages', $member);
-        if ($extended !== null) {
-            return $extended;
-        }
-
-        if (!$this->CanViewType || $this->CanViewType == 'Anyone') {
-            return true;
-        }
-
-        // check for any logged-in users
-        if ($this->CanViewType === 'LoggedInUsers' && $member) {
-            return true;
-        }
-
-        // check for specific groups
-        if ($this->CanViewType === 'OnlyTheseUsers' && $member && $member->inGroups($this->ViewerGroups())) {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Can a user edit pages on this site? This method is only
-     * called if a page is set to Inherit, but there is nothing
-     * to inherit from, or on new records without a parent.
-     *
-     * @param Member $member
-     * @return boolean
-     */
-    public function canEditPages($member = null)
-    {
-        if (!$member) {
-            $member = Security::getCurrentUser();
-        }
-
-        if ($member && Permission::checkMember($member, "ADMIN")) {
-            return true;
-        }
-
-        $extended = $this->extendedCan('canEditPages', $member);
-        if ($extended !== null) {
-            return $extended;
-        }
-
-        // check for any logged-in users with CMS access
-        if ($this->CanEditType === 'LoggedInUsers'
-            && Permission::checkMember($member, $this->config()->get('required_permission'))
-        ) {
-            return true;
-        }
-
-            // check for specific groups
-        if ($this->CanEditType === 'OnlyTheseUsers' && $member && $member->inGroups($this->EditorGroups())) {
-            return true;
-        }
-
-        return false;
-    }
-
-    public function canEdit($member = null)
-    {
-        if (!$member) {
-            $member = Security::getCurrentUser();
-        }
-
-        $extended = $this->extendedCan('canEdit', $member);
-        if ($extended !== null) {
-            return $extended;
-        }
-
-        return Permission::checkMember($member, "EDIT_SITECONFIG");
-    }
-
-    /**
-     * @return array
-     */
-    public function providePermissions()
-    {
-        return array(
-            'EDIT_SITECONFIG' => array(
-                'name' => _t('SilverStripe\\SiteConfig\\SiteConfig.EDIT_PERMISSION', 'Manage site configuration'),
-                'category' => _t('SilverStripe\\Security\\Permission.PERMISSIONS_CATEGORY', 'Roles and access permissions'),
-                'help' => _t('SilverStripe\\SiteConfig\\SiteConfig.EDIT_PERMISSION_HELP', 'Ability to edit global access settings/top-level page permissions.'),
-                'sort' => 400
-            )
-        );
-    }
-
-    /**
-     * Can a user create pages in the root of this site?
-     *
-     * @param Member $member
-     * @return boolean
-     */
-    public function canCreateTopLevel($member = null)
-    {
-        if (!$member) {
-            $member = Security::getCurrentUser();
-        }
-
-        if ($member && Permission::checkMember($member, "ADMIN")) {
-            return true;
-        }
-
-        $extended = $this->extendedCan('canCreateTopLevel', $member);
-        if ($extended !== null) {
-            return $extended;
-        }
-
-        // check for any logged-in users with CMS permission
-        if ($this->CanCreateTopLevelType === 'LoggedInUsers'
-            && Permission::checkMember($member, $this->config()->get('required_permission'))
-        ) {
-            return true;
-        }
-
-        // check for specific groups
-        if ($this->CanCreateTopLevelType === 'OnlyTheseUsers'
-            && $member
-            && $member->inGroups($this->CreateTopLevelGroups())
-        ) {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Add $SiteConfig to all SSViewers
-     */
-    public static function get_template_global_variables()
-    {
-        return array(
-            'SiteConfig' => 'current_site_config',
-        );
-    }
+	private static $db = array(
+		"Title" => "Varchar(255)",
+		"Tagline" => "Varchar(255)",
+		"CanViewType" => "Enum('Anyone, LoggedInUsers, OnlyTheseUsers', 'Anyone')",
+		"CanEditType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
+		"CanCreateTopLevelType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
+	);
+
+	private static $many_many = array(
+		"ViewerGroups" => "SilverStripe\\Security\\Group",
+		"EditorGroups" => "SilverStripe\\Security\\Group",
+		"CreateTopLevelGroups" => "SilverStripe\\Security\\Group"
+	);
+
+	private static $defaults = array(
+		"CanViewType" => "Anyone",
+		"CanEditType" => "LoggedInUsers",
+		"CanCreateTopLevelType" => "LoggedInUsers",
+	);
+
+	private static $table_name = 'SiteConfig';
+
+	/**
+	 * Default permission to check for 'LoggedInUsers' to create or edit pages
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $required_permission = array('CMS_ACCESS_CMSMain', 'CMS_ACCESS_LeftAndMain');
+
+
+	public function populateDefaults()
+	{
+		$this->Title = _t('SilverStripe\\SiteConfig\\SiteConfig.SITENAMEDEFAULT', "Your Site Name");
+		$this->Tagline = _t('SilverStripe\\SiteConfig\\SiteConfig.TAGLINEDEFAULT', "your tagline here");
+
+		// Allow these defaults to be overridden
+		parent::populateDefaults();
+	}
+
+	/**
+	 * Get the fields that are sent to the CMS.
+	 *
+	 * In your extensions: updateCMSFields($fields).
+	 *
+	 * @return FieldList
+	 */
+	public function getCMSFields()
+	{
+		$mapFn = function ($groups = []) {
+			$map = [];
+			foreach ($groups as $group) {
+				// Listboxfield values are escaped, use ASCII char instead of &raquo;
+				$map[$group->ID] = $group->getBreadcrumbs(' > ');
+			}
+			asort($map);
+			return $map;
+		};
+		$groupsMap = $mapFn(Group::get());
+		$viewAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_VIEW_ALL', 'ADMIN']));
+		$editAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_EDIT_ALL', 'ADMIN']));
+
+		$fields = new FieldList(
+			new TabSet(
+				"Root",
+				$tabMain = new Tab(
+					'Main',
+					$titleField = new TextField("Title", _t('SilverStripe\\SiteConfig\\SiteConfig.SITETITLE', "Site title")),
+					$taglineField = new TextField("Tagline", _t('SilverStripe\\SiteConfig\\SiteConfig.SITETAGLINE', "Site Tagline/Slogan"))
+				),
+				$tabAccess = new Tab(
+					'Access',
+					$viewersOptionsField = new OptionsetField("CanViewType", _t('SilverStripe\\SiteConfig\\SiteConfig.VIEWHEADER', "Who can view pages on this site?")),
+					$viewerGroupsField = ListboxField::create("ViewerGroups", _t('SilverStripe\\CMS\\Model\\SiteTree.VIEWERGROUPS', "Viewer Groups"))
+						->setSource($groupsMap)
+						->setAttribute(
+							'data-placeholder',
+							_t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
+						),
+					$editorsOptionsField = new OptionsetField("CanEditType", _t('SilverStripe\\SiteConfig\\SiteConfig.EDITHEADER', "Who can edit pages on this site?")),
+					$editorGroupsField = ListboxField::create("EditorGroups", _t('SilverStripe\\CMS\\Model\\SiteTree.EDITORGROUPS', "Editor Groups"))
+						->setSource($groupsMap)
+						->setAttribute(
+							'data-placeholder',
+							_t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
+						),
+					$topLevelCreatorsOptionsField = new OptionsetField("CanCreateTopLevelType", _t('SilverStripe\\SiteConfig\\SiteConfig.TOPLEVELCREATE', "Who can create pages in the root of the site?")),
+					$topLevelCreatorsGroupsField = ListboxField::create("CreateTopLevelGroups", _t(__CLASS__.'.TOPLEVELCREATORGROUPS', "Top level creators"))
+						->setSource($groupsMap)
+						->setAttribute(
+							'data-placeholder',
+							_t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
+						)
+				)
+			),
+			new HiddenField('ID')
+		);
+
+		$viewersOptionsSource = array();
+		$viewersOptionsSource["Anyone"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSANYONE', "Anyone");
+		$viewersOptionsSource["LoggedInUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSLOGGEDIN', "Logged-in users");
+		$viewersOptionsSource["OnlyTheseUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSONLYTHESE', "Only these people (choose from list)");
+		$viewersOptionsField->setSource($viewersOptionsSource);
+
+		if ($viewAllGroupsMap) {
+			$viewerGroupsField->setDescription(_t(
+				'SilverStripe\\CMS\\Model\\SiteTree.VIEWER_GROUPS_FIELD_DESC',
+				'Groups with global view permissions: {groupList}',
+				['groupList' => implode(', ', array_values($viewAllGroupsMap))]
+			));
+		}
+
+		if ($editAllGroupsMap) {
+			$editorGroupsField->setDescription(_t(
+				'SilverStripe\\CMS\\Model\\SiteTree.EDITOR_GROUPS_FIELD_DESC',
+				'Groups with global edit permissions: {groupList}',
+				['groupList' => implode(', ', array_values($editAllGroupsMap))]
+			));
+		}
+
+		$editorsOptionsSource = array();
+		$editorsOptionsSource["LoggedInUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.EDITANYONE', "Anyone who can log-in to the CMS");
+		$editorsOptionsSource["OnlyTheseUsers"] = _t('SilverStripe\\CMS\\Model\\SiteTree.EDITONLYTHESE', "Only these groups (choose from list)");
+		$editorsOptionsField->setSource($editorsOptionsSource);
+
+		$topLevelCreatorsOptionsField->setSource($editorsOptionsSource);
+
+		if (!Permission::check('EDIT_SITECONFIG')) {
+			$fields->makeFieldReadonly($viewersOptionsField);
+			$fields->makeFieldReadonly($viewerGroupsField);
+			$fields->makeFieldReadonly($editorsOptionsField);
+			$fields->makeFieldReadonly($editorGroupsField);
+			$fields->makeFieldReadonly($topLevelCreatorsOptionsField);
+			$fields->makeFieldReadonly($topLevelCreatorsGroupsField);
+			$fields->makeFieldReadonly($taglineField);
+			$fields->makeFieldReadonly($titleField);
+		}
+
+		if (file_exists(BASE_PATH . '/install.php')) {
+			$fields->addFieldToTab(
+				"Root.Main",
+				new LiteralField(
+					"InstallWarningHeader",
+					"<p class=\"message warning\">" . _t(
+						"SilverStripe\\CMS\\Model\\SiteTree.REMOVE_INSTALL_WARNING",
+						"Warning: You should remove install.php from this SilverStripe install for security reasons."
+					) . "</p>"
+				),
+				"Title"
+			);
+		}
+
+		$tabMain->setTitle(_t('SilverStripe\\SiteConfig\\SiteConfig.TABMAIN', "Main"));
+		$tabAccess->setTitle(_t('SilverStripe\\SiteConfig\\SiteConfig.TABACCESS', "Access"));
+		$this->extend('updateCMSFields', $fields);
+
+		return $fields;
+	}
+
+	/**
+	 * Get the actions that are sent to the CMS.
+	 *
+	 * In your extensions: updateEditFormActions($actions)
+	 *
+	 * @return FieldList
+	 */
+	public function getCMSActions()
+	{
+		if (Permission::check('ADMIN') || Permission::check('EDIT_SITECONFIG')) {
+			$actions = new FieldList(
+				FormAction::create(
+					'save_siteconfig',
+					_t('SilverStripe\\CMS\\Controllers\\CMSMain.SAVE', 'Save')
+				)->addExtraClass('btn-primary font-icon-save')
+			);
+		} else {
+			$actions = new FieldList();
+		}
+
+		$this->extend('updateCMSActions', $actions);
+
+		return $actions;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function CMSEditLink()
+	{
+		return SiteConfigLeftAndMain::singleton()->Link();
+	}
+
+	/**
+	 * Get the current sites SiteConfig, and creates a new one through
+	 * {@link make_site_config()} if none is found.
+	 *
+	 * @return SiteConfig
+	 */
+	public static function current_site_config()
+	{
+		/** @var SiteConfig $siteConfig */
+		$siteConfig = DataObject::get_one(SiteConfig::class);
+		if ($siteConfig) {
+			return $siteConfig;
+		}
+
+		return self::make_site_config();
+	}
+
+	/**
+	 * Setup a default SiteConfig record if none exists.
+	 */
+	public function requireDefaultRecords()
+	{
+		parent::requireDefaultRecords();
+
+		$config = DataObject::get_one(SiteConfig::class);
+
+		if (!$config) {
+			self::make_site_config();
+
+			DB::alteration_message("Added default site config", "created");
+		}
+	}
+
+	/**
+	 * Create SiteConfig with defaults from language file.
+	 *
+	 * @return SiteConfig
+	 */
+	public static function make_site_config()
+	{
+		$config = SiteConfig::create();
+		$config->write();
+
+		return $config;
+	}
+
+	/**
+	 * Can a user view this SiteConfig instance?
+	 *
+	 * @param Member $member
+	 * @return boolean
+	 */
+	public function canView($member = null)
+	{
+		if (!$member) {
+			$member = Security::getCurrentUser();
+		}
+
+		$extended = $this->extendedCan('canView', $member);
+		if ($extended !== null) {
+			return $extended;
+		}
+
+		// Assuming all that can edit this object can also view it
+		return $this->canEdit($member);
+	}
+
+	/**
+	 * Can a user view pages on this site? This method is only
+	 * called if a page is set to Inherit, but there is nothing
+	 * to inherit from.
+	 *
+	 * @param Member $member
+	 * @return boolean
+	 */
+	public function canViewPages($member = null)
+	{
+		if (!$member) {
+			$member = Security::getCurrentUser();
+		}
+
+		if ($member && Permission::checkMember($member, "ADMIN")) {
+			return true;
+		}
+
+		$extended = $this->extendedCan('canViewPages', $member);
+		if ($extended !== null) {
+			return $extended;
+		}
+
+		if (!$this->CanViewType || $this->CanViewType == 'Anyone') {
+			return true;
+		}
+
+		// check for any logged-in users
+		if ($this->CanViewType === 'LoggedInUsers' && $member) {
+			return true;
+		}
+
+		// check for specific groups
+		if ($this->CanViewType === 'OnlyTheseUsers' && $member && $member->inGroups($this->ViewerGroups())) {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Can a user edit pages on this site? This method is only
+	 * called if a page is set to Inherit, but there is nothing
+	 * to inherit from, or on new records without a parent.
+	 *
+	 * @param Member $member
+	 * @return boolean
+	 */
+	public function canEditPages($member = null)
+	{
+		if (!$member) {
+			$member = Security::getCurrentUser();
+		}
+
+		if ($member && Permission::checkMember($member, "ADMIN")) {
+			return true;
+		}
+
+		$extended = $this->extendedCan('canEditPages', $member);
+		if ($extended !== null) {
+			return $extended;
+		}
+
+		// check for any logged-in users with CMS access
+		if ($this->CanEditType === 'LoggedInUsers'
+			&& Permission::checkMember($member, $this->config()->get('required_permission'))
+		) {
+			return true;
+		}
+
+			// check for specific groups
+		if ($this->CanEditType === 'OnlyTheseUsers' && $member && $member->inGroups($this->EditorGroups())) {
+			return true;
+		}
+
+		return false;
+	}
+
+	public function canEdit($member = null)
+	{
+		if (!$member) {
+			$member = Security::getCurrentUser();
+		}
+
+		$extended = $this->extendedCan('canEdit', $member);
+		if ($extended !== null) {
+			return $extended;
+		}
+
+		return Permission::checkMember($member, "EDIT_SITECONFIG");
+	}
+
+	/**
+	 * @return array
+	 */
+	public function providePermissions()
+	{
+		return array(
+			'EDIT_SITECONFIG' => array(
+				'name' => _t('SilverStripe\\SiteConfig\\SiteConfig.EDIT_PERMISSION', 'Manage site configuration'),
+				'category' => _t('SilverStripe\\Security\\Permission.PERMISSIONS_CATEGORY', 'Roles and access permissions'),
+				'help' => _t('SilverStripe\\SiteConfig\\SiteConfig.EDIT_PERMISSION_HELP', 'Ability to edit global access settings/top-level page permissions.'),
+				'sort' => 400
+			)
+		);
+	}
+
+	/**
+	 * Can a user create pages in the root of this site?
+	 *
+	 * @param Member $member
+	 * @return boolean
+	 */
+	public function canCreateTopLevel($member = null)
+	{
+		if (!$member) {
+			$member = Security::getCurrentUser();
+		}
+
+		if ($member && Permission::checkMember($member, "ADMIN")) {
+			return true;
+		}
+
+		$extended = $this->extendedCan('canCreateTopLevel', $member);
+		if ($extended !== null) {
+			return $extended;
+		}
+
+		// check for any logged-in users with CMS permission
+		if ($this->CanCreateTopLevelType === 'LoggedInUsers'
+			&& Permission::checkMember($member, $this->config()->get('required_permission'))
+		) {
+			return true;
+		}
+
+		// check for specific groups
+		if ($this->CanCreateTopLevelType === 'OnlyTheseUsers'
+			&& $member
+			&& $member->inGroups($this->CreateTopLevelGroups())
+		) {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Add $SiteConfig to all SSViewers
+	 */
+	public static function get_template_global_variables()
+	{
+		return array(
+			'SiteConfig' => 'current_site_config',
+		);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -84,7 +84,7 @@ 
      */
     public function getCMSFields()
     {
-        $mapFn = function ($groups = []) {
+        $mapFn = function($groups = []) {
             $map = [];
             foreach ($groups as $group) {
                 // Listboxfield values are escaped, use ASCII char instead of »
@@ -173,15 +173,15 @@ 
             $fields->makeFieldReadonly($titleField);
         }
 
-        if (file_exists(BASE_PATH . '/install.php')) {
+        if (file_exists(BASE_PATH.'/install.php')) {
             $fields->addFieldToTab(
                 "Root.Main",
                 new LiteralField(
                     "InstallWarningHeader",
-                    "<p class=\"message warning\">" . _t(
+                    "<p class=\"message warning\">"._t(
                         "SilverStripe\\CMS\\Model\\SiteTree.REMOVE_INSTALL_WARNING",
                         "Warning: You should remove install.php from this SilverStripe install for security reasons."
-                    ) . "</p>"
+                    )."</p>"
                 ),
                 "Title"
             );

code/SiteConfigLeftAndMain.php

Doc Comments +1 added lines, -1 removed lines

@@ -139,7 +139,7 @@
      *
      * @param array $data
      * @param Form $form
-     * @return String
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     public function save_siteconfig($data, $form)
     {

Indentation +144 added lines, -144 removed lines

@@ -16,148 +16,148 @@
 
 class SiteConfigLeftAndMain extends LeftAndMain
 {
-    /**
-     * @var string
-     */
-    private static $url_segment = 'settings';
-
-    /**
-     * @var string
-     */
-    private static $url_rule = '/$Action/$ID/$OtherID';
-
-    /**
-     * @var int
-     */
-    private static $menu_priority = -1;
-
-    /**
-     * @var string
-     */
-    private static $menu_title = 'Settings';
-
-    /**
-     * @var string
-     */
-    private static $menu_icon_class = 'font-icon-cog';
-
-    /**
-     * @var string
-     */
-    private static $tree_class = 'SilverStripe\\SiteConfig\\SiteConfig';
-
-    /**
-     * @var array
-     */
-    private static $required_permission_codes = array('EDIT_SITECONFIG');
-
-    /**
-     * Initialises the {@link SiteConfig} controller.
-     */
-    public function init()
-    {
-        parent::init();
-        if (class_exists(SiteTree::class)) {
-            Requirements::javascript('silverstripe/cms: client/dist/js/bundle.js');
-        }
-    }
-
-    /**
-     * @param null $id Not used.
-     * @param null $fields Not used.
-     *
-     * @return Form
-     */
-    public function getEditForm($id = null, $fields = null)
-    {
-        $siteConfig = SiteConfig::current_site_config();
-        $fields = $siteConfig->getCMSFields();
-
-        // Tell the CMS what URL the preview should show
-        $home = Director::absoluteBaseURL();
-        $fields->push(new HiddenField('PreviewURL', 'Preview URL', $home));
-
-        // Added in-line to the form, but plucked into different view by LeftAndMain.Preview.js upon load
-        /** @skipUpgrade */
-        $fields->push($navField = new LiteralField('SilverStripeNavigator', $this->getSilverStripeNavigator()));
-        $navField->setAllowHTML(true);
-
-        // Retrieve validator, if one has been setup (e.g. via data extensions).
-        if ($siteConfig->hasMethod("getCMSValidator")) {
-            $validator = $siteConfig->getCMSValidator();
-        } else {
-            $validator = null;
-        }
-
-        $actions = $siteConfig->getCMSActions();
-        $negotiator = $this->getResponseNegotiator();
-        /** @var Form $form */
-        $form = Form::create(
-            $this,
-            'EditForm',
-            $fields,
-            $actions,
-            $validator
-        )->setHTMLID('Form_EditForm');
-        $form->setValidationResponseCallback(function (ValidationResult $errors) use ($negotiator, $form) {
-            $request = $this->getRequest();
-            if ($request->isAjax() && $negotiator) {
-                $result = $form->forTemplate();
-                return $negotiator->respond($request, array(
-                    'CurrentForm' => function () use ($result) {
-                        return $result;
-                    }
-                ));
-            }
-        });
-        $form->addExtraClass('flexbox-area-grow fill-height cms-content cms-edit-form');
-        $form->setAttribute('data-pjax-fragment', 'CurrentForm');
-
-        if ($form->Fields()->hasTabSet()) {
-            $form->Fields()->findOrMakeTab('Root')->setTemplate('SilverStripe\\Forms\\CMSTabSet');
-        }
-        $form->setHTMLID('Form_EditForm');
-        $form->loadDataFrom($siteConfig);
-        $form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));
-
-        // Use <button> to allow full jQuery UI styling
-        $actions = $actions->dataFields();
-        if ($actions) {
-            /** @var FormAction $action */
-            foreach ($actions as $action) {
-                $action->setUseButtonTag(true);
-            }
-        }
-
-        $this->extend('updateEditForm', $form);
-
-        return $form;
-    }
-
-    /**
-     * Save the current sites {@link SiteConfig} into the database.
-     *
-     * @param array $data
-     * @param Form $form
-     * @return String
-     */
-    public function save_siteconfig($data, $form)
-    {
-        $siteConfig = SiteConfig::current_site_config();
-        $form->saveInto($siteConfig);
-        $siteConfig->write();
-        $this->response->addHeader('X-Status', rawurlencode(_t('SilverStripe\\Admin\\LeftAndMain.SAVEDUP', 'Saved.')));
-        return $form->forTemplate();
-    }
-
-
-    public function Breadcrumbs($unlinked = false)
-    {
-        return new ArrayList(array(
-            new ArrayData(array(
-                'Title' => static::menu_title(),
-                'Link' => $this->Link()
-            ))
-        ));
-    }
+	/**
+	 * @var string
+	 */
+	private static $url_segment = 'settings';
+
+	/**
+	 * @var string
+	 */
+	private static $url_rule = '/$Action/$ID/$OtherID';
+
+	/**
+	 * @var int
+	 */
+	private static $menu_priority = -1;
+
+	/**
+	 * @var string
+	 */
+	private static $menu_title = 'Settings';
+
+	/**
+	 * @var string
+	 */
+	private static $menu_icon_class = 'font-icon-cog';
+
+	/**
+	 * @var string
+	 */
+	private static $tree_class = 'SilverStripe\\SiteConfig\\SiteConfig';
+
+	/**
+	 * @var array
+	 */
+	private static $required_permission_codes = array('EDIT_SITECONFIG');
+
+	/**
+	 * Initialises the {@link SiteConfig} controller.
+	 */
+	public function init()
+	{
+		parent::init();
+		if (class_exists(SiteTree::class)) {
+			Requirements::javascript('silverstripe/cms: client/dist/js/bundle.js');
+		}
+	}
+
+	/**
+	 * @param null $id Not used.
+	 * @param null $fields Not used.
+	 *
+	 * @return Form
+	 */
+	public function getEditForm($id = null, $fields = null)
+	{
+		$siteConfig = SiteConfig::current_site_config();
+		$fields = $siteConfig->getCMSFields();
+
+		// Tell the CMS what URL the preview should show
+		$home = Director::absoluteBaseURL();
+		$fields->push(new HiddenField('PreviewURL', 'Preview URL', $home));
+
+		// Added in-line to the form, but plucked into different view by LeftAndMain.Preview.js upon load
+		/** @skipUpgrade */
+		$fields->push($navField = new LiteralField('SilverStripeNavigator', $this->getSilverStripeNavigator()));
+		$navField->setAllowHTML(true);
+
+		// Retrieve validator, if one has been setup (e.g. via data extensions).
+		if ($siteConfig->hasMethod("getCMSValidator")) {
+			$validator = $siteConfig->getCMSValidator();
+		} else {
+			$validator = null;
+		}
+
+		$actions = $siteConfig->getCMSActions();
+		$negotiator = $this->getResponseNegotiator();
+		/** @var Form $form */
+		$form = Form::create(
+			$this,
+			'EditForm',
+			$fields,
+			$actions,
+			$validator
+		)->setHTMLID('Form_EditForm');
+		$form->setValidationResponseCallback(function (ValidationResult $errors) use ($negotiator, $form) {
+			$request = $this->getRequest();
+			if ($request->isAjax() && $negotiator) {
+				$result = $form->forTemplate();
+				return $negotiator->respond($request, array(
+					'CurrentForm' => function () use ($result) {
+						return $result;
+					}
+				));
+			}
+		});
+		$form->addExtraClass('flexbox-area-grow fill-height cms-content cms-edit-form');
+		$form->setAttribute('data-pjax-fragment', 'CurrentForm');
+
+		if ($form->Fields()->hasTabSet()) {
+			$form->Fields()->findOrMakeTab('Root')->setTemplate('SilverStripe\\Forms\\CMSTabSet');
+		}
+		$form->setHTMLID('Form_EditForm');
+		$form->loadDataFrom($siteConfig);
+		$form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));
+
+		// Use <button> to allow full jQuery UI styling
+		$actions = $actions->dataFields();
+		if ($actions) {
+			/** @var FormAction $action */
+			foreach ($actions as $action) {
+				$action->setUseButtonTag(true);
+			}
+		}
+
+		$this->extend('updateEditForm', $form);
+
+		return $form;
+	}
+
+	/**
+	 * Save the current sites {@link SiteConfig} into the database.
+	 *
+	 * @param array $data
+	 * @param Form $form
+	 * @return String
+	 */
+	public function save_siteconfig($data, $form)
+	{
+		$siteConfig = SiteConfig::current_site_config();
+		$form->saveInto($siteConfig);
+		$siteConfig->write();
+		$this->response->addHeader('X-Status', rawurlencode(_t('SilverStripe\\Admin\\LeftAndMain.SAVEDUP', 'Saved.')));
+		return $form->forTemplate();
+	}
+
+
+	public function Breadcrumbs($unlinked = false)
+	{
+		return new ArrayList(array(
+			new ArrayData(array(
+				'Title' => static::menu_title(),
+				'Link' => $this->Link()
+			))
+		));
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -99,12 +99,12 @@
             $actions,
             $validator
         )->setHTMLID('Form_EditForm');
-        $form->setValidationResponseCallback(function (ValidationResult $errors) use ($negotiator, $form) {
+        $form->setValidationResponseCallback(function(ValidationResult $errors) use ($negotiator, $form) {
             $request = $this->getRequest();
             if ($request->isAjax() && $negotiator) {
                 $result = $form->forTemplate();
                 return $negotiator->respond($request, array(
-                    'CurrentForm' => function () use ($result) {
+                    'CurrentForm' => function() use ($result) {
                         return $result;
                     }
                 ));

code/SiteConfigPagePermissions.php

Indentation +41 added lines, -41 removed lines

@@ -10,48 +10,48 @@
  */
 class SiteConfigPagePermissions implements DefaultPermissionChecker
 {
-    /**
-     * Can root be edited?
-     *
-     * @param Member $member
-     * @return bool
-     */
-    public function canEdit(Member $member = null)
-    {
-        return SiteConfig::current_site_config()->canEditPages($member);
-    }
+	/**
+	 * Can root be edited?
+	 *
+	 * @param Member $member
+	 * @return bool
+	 */
+	public function canEdit(Member $member = null)
+	{
+		return SiteConfig::current_site_config()->canEditPages($member);
+	}
 
-    /**
-     * Can root be viewed?
-     *
-     * @param Member $member
-     * @return bool
-     */
-    public function canView(Member $member = null)
-    {
-        return SiteConfig::current_site_config()->canViewPages($member);
-    }
+	/**
+	 * Can root be viewed?
+	 *
+	 * @param Member $member
+	 * @return bool
+	 */
+	public function canView(Member $member = null)
+	{
+		return SiteConfig::current_site_config()->canViewPages($member);
+	}
 
-    /**
-     * Can root be deleted?
-     *
-     * @param Member $member
-     * @return bool
-     */
-    public function canDelete(Member $member = null)
-    {
-        // Same as canEdit
-        return $this->canEdit($member);
-    }
+	/**
+	 * Can root be deleted?
+	 *
+	 * @param Member $member
+	 * @return bool
+	 */
+	public function canDelete(Member $member = null)
+	{
+		// Same as canEdit
+		return $this->canEdit($member);
+	}
 
-    /**
-     * Can root objects be created?
-     *
-     * @param Member $member
-     * @return bool
-     */
-    public function canCreate(Member $member = null)
-    {
-        return SiteConfig::current_site_config()->canCreateTopLevel();
-    }
+	/**
+	 * Can root objects be created?
+	 *
+	 * @param Member $member
+	 * @return bool
+	 */
+	public function canCreate(Member $member = null)
+	{
+		return SiteConfig::current_site_config()->canCreateTopLevel();
+	}
 }

tests/bootstrap/mysite.php

Indentation +1 added lines, -1 removed lines

@@ -1,7 +1,7 @@
 <?php
 
 if (!defined('BASE_PATH')) {
-    define('BASE_PATH', getcwd());
+	define('BASE_PATH', getcwd());
 }
 
 require_once BASE_PATH . '/cms/tests/bootstrap/mysite.php';

Spacing +2 added lines, -2 removed lines

@@ -4,6 +4,6 @@
     define('BASE_PATH', getcwd());
 }
 
-require_once BASE_PATH . '/cms/tests/bootstrap/mysite.php';
+require_once BASE_PATH.'/cms/tests/bootstrap/mysite.php';
 
-copy(__DIR__ . '/fixtures/theme.yml.fixture', $projectPath . '/_config/dummytheme.yml');
+copy(__DIR__.'/fixtures/theme.yml.fixture', $projectPath.'/_config/dummytheme.yml');

tests/php/SiteConfigTest.php

Indentation +44 added lines, -44 removed lines

@@ -12,59 +12,59 @@
  */
 class SiteConfigTest extends SapphireTest
 {
-    protected static $fixture_file = 'SiteConfigTest.yml';
+	protected static $fixture_file = 'SiteConfigTest.yml';
 
-    protected static $illegal_extensions = array(
-        SiteTree::class => array('SiteTreeSubsites'),
-    );
+	protected static $illegal_extensions = array(
+		SiteTree::class => array('SiteTreeSubsites'),
+	);
 
-    public function testCanCreateRootPages()
-    {
-        /** @var SiteConfig $config */
-        $config = $this->objFromFixture(SiteConfig::class, 'default');
+	public function testCanCreateRootPages()
+	{
+		/** @var SiteConfig $config */
+		$config = $this->objFromFixture(SiteConfig::class, 'default');
 
-        // Log in without pages admin access
-        $this->logInWithPermission('CMS_ACCESS_AssetAdmin');
-        $this->assertFalse($config->canCreateTopLevel());
+		// Log in without pages admin access
+		$this->logInWithPermission('CMS_ACCESS_AssetAdmin');
+		$this->assertFalse($config->canCreateTopLevel());
 
-        // Login with necessary edit permission
-        $perms = SiteConfig::config()->get('required_permission');
-        $this->logInWithPermission(reset($perms));
-        $this->assertTrue($config->canCreateTopLevel());
-    }
+		// Login with necessary edit permission
+		$perms = SiteConfig::config()->get('required_permission');
+		$this->logInWithPermission(reset($perms));
+		$this->assertTrue($config->canCreateTopLevel());
+	}
 
-    public function testCanViewPages()
-    {
-        /** @var SiteConfig $config */
-        $config = $this->objFromFixture(SiteConfig::class, 'default');
-        $this->assertTrue($config->canViewPages());
-    }
+	public function testCanViewPages()
+	{
+		/** @var SiteConfig $config */
+		$config = $this->objFromFixture(SiteConfig::class, 'default');
+		$this->assertTrue($config->canViewPages());
+	}
 
-    public function testCanEdit()
-    {
-        $config = $this->objFromFixture(SiteConfig::class, 'default');
+	public function testCanEdit()
+	{
+		$config = $this->objFromFixture(SiteConfig::class, 'default');
 
-        // Unrelated permissions don't allow siteconfig
-        $this->logInWithPermission('CMS_ACCESS_AssetAdmin');
-        $this->assertFalse($config->canEdit());
+		// Unrelated permissions don't allow siteconfig
+		$this->logInWithPermission('CMS_ACCESS_AssetAdmin');
+		$this->assertFalse($config->canEdit());
 
-        // Only those with edit permission can do this
-        $this->logInWithPermission('EDIT_SITECONFIG');
-        $this->assertTrue($config->canEdit());
-    }
+		// Only those with edit permission can do this
+		$this->logInWithPermission('EDIT_SITECONFIG');
+		$this->assertTrue($config->canEdit());
+	}
 
-    public function testCanEditPages()
-    {
-        /** @var SiteConfig $config */
-        $config = $this->objFromFixture(SiteConfig::class, 'default');
+	public function testCanEditPages()
+	{
+		/** @var SiteConfig $config */
+		$config = $this->objFromFixture(SiteConfig::class, 'default');
 
-        // Log in without pages admin access
-        $this->logInWithPermission('CMS_ACCESS_AssetAdmin');
-        $this->assertFalse($config->canEditPages());
+		// Log in without pages admin access
+		$this->logInWithPermission('CMS_ACCESS_AssetAdmin');
+		$this->assertFalse($config->canEditPages());
 
-        // Login with necessary edit permission
-        $perms = SiteConfig::config()->get('required_permission');
-        $this->logInWithPermission(reset($perms));
-        $this->assertTrue($config->canEditPages());
-    }
+		// Login with necessary edit permission
+		$perms = SiteConfig::config()->get('required_permission');
+		$this->logInWithPermission(reset($perms));
+		$this->assertTrue($config->canEditPages());
+	}
 }