silverstripe-subsites/code/extensions/LeftAndMainSubsites.php

380 lines
14 KiB
PHP
Raw Normal View History

<?php
2016-09-22 16:38:29 +02:00
namespace SilverStripe\Subsites\Extensions;
use SilverStripe\Admin\CMSMenu;
use SilverStripe\Admin\LeftAndMainExtension;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Config\Config;
2016-09-22 16:38:29 +02:00
use SilverStripe\Core\Convert;
use SilverStripe\Core\Manifest\ModuleLoader;
2016-09-22 16:38:29 +02:00
use SilverStripe\Forms\HiddenField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Member;
2016-09-22 16:38:29 +02:00
use SilverStripe\Security\Permission;
use SilverStripe\Security\Security;
use SilverStripe\Subsites\Controller\SubsiteXHRController;
use SilverStripe\Subsites\Model\Subsite;
use SilverStripe\Subsites\State\SubsiteState;
use SilverStripe\View\ArrayData;
use SilverStripe\View\Requirements;
/**
* Decorator designed to add subsites support to LeftAndMain
*
* @package subsites
*/
class LeftAndMainSubsites extends LeftAndMainExtension
2017-05-24 15:26:28 +02:00
{
private static $allowed_actions = ['CopyToSubsite'];
2017-05-24 15:26:28 +02:00
/**
* Normally SubsiteID=0 on a DataObject means it is only accessible from the special "main site".
* However in some situations SubsiteID=0 will be understood as a "globally accessible" object in which
* case this property is set to true (i.e. in AssetAdmin).
*/
private static $treats_subsite_0_as_global = false;
2017-05-29 13:42:42 +02:00
public function init()
2017-05-24 15:26:28 +02:00
{
$module = ModuleLoader::getModule('silverstripe/subsites');
Requirements::css($module->getRelativeResourcePath('css/LeftAndMain_Subsites.css'));
Requirements::javascript($module->getRelativeResourcePath('javascript/LeftAndMain_Subsites.js'));
Requirements::javascript($module->getRelativeResourcePath('javascript/VirtualPage_Subsites.js'));
2017-05-24 15:26:28 +02:00
}
/**
* Set the title of the CMS tree
*/
2017-05-29 13:42:42 +02:00
public function getCMSTreeTitle()
2017-05-24 15:26:28 +02:00
{
$subsite = Subsite::currentSubsite();
2017-05-24 15:26:28 +02:00
return $subsite ? Convert::raw2xml($subsite->Title) : _t('LeftAndMain.SITECONTENTLEFT');
}
2017-05-29 13:42:42 +02:00
public function updatePageOptions(&$fields)
2017-05-24 15:26:28 +02:00
{
$fields->push(HiddenField::create('SubsiteID', 'SubsiteID', SubsiteState::singleton()->getSubsiteId()));
2017-05-24 15:26:28 +02:00
}
/**
* Find all subsites accessible for current user on this controller.
*
2017-06-01 15:10:07 +02:00
* @param bool $includeMainSite
* @param string $mainSiteTitle
* @param null $member
* @return ArrayList of <a href='psi_element://Subsite'>Subsite</a> instances.
* instances.
2017-05-24 15:26:28 +02:00
*/
public function sectionSites($includeMainSite = true, $mainSiteTitle = 'Main site', $member = null)
2017-05-24 15:26:28 +02:00
{
if ($mainSiteTitle == 'Main site') {
$mainSiteTitle = _t('Subsites.MainSiteTitle', 'Main site');
}
// Rationalise member arguments
if (!$member) {
$member = Member::currentUser();
}
if (!$member) {
return new ArrayList();
}
if (!is_object($member)) {
2017-05-29 13:42:42 +02:00
$member = DataObject::get_by_id(Member::class, $member);
2017-05-24 15:26:28 +02:00
}
// Collect permissions - honour the LeftAndMain::required_permission_codes, current model requires
// us to check if the user satisfies ALL permissions. Code partly copied from LeftAndMain::canView.
$codes = [];
2017-05-24 15:26:28 +02:00
$extraCodes = Config::inst()->get($this->owner->class, 'required_permission_codes');
if ($extraCodes !== false) {
if ($extraCodes) {
$codes = array_merge($codes, (array)$extraCodes);
} else {
$codes[] = "CMS_ACCESS_{$this->owner->class}";
}
} else {
// Check overriden - all subsites accessible.
return Subsite::all_sites();
}
// Find subsites satisfying all permissions for the Member.
$codesPerSite = [];
$sitesArray = [];
2017-05-24 15:26:28 +02:00
foreach ($codes as $code) {
$sites = Subsite::accessible_sites($code, $includeMainSite, $mainSiteTitle, $member);
foreach ($sites as $site) {
// Build the structure for checking how many codes match.
$codesPerSite[$site->ID][$code] = true;
// Retain Subsite objects for later.
$sitesArray[$site->ID] = $site;
}
}
// Find sites that satisfy all codes conjuncitvely.
$accessibleSites = new ArrayList();
foreach ($codesPerSite as $siteID => $siteCodes) {
if (count($siteCodes) == count($codes)) {
2017-05-24 15:26:28 +02:00
$accessibleSites->push($sitesArray[$siteID]);
}
}
return $accessibleSites;
}
/*
* Returns a list of the subsites accessible to the current user.
* It's enough for any section to be accessible for the section to be included.
*/
public function Subsites()
{
return Subsite::all_accessible_sites();
}
/*
* Generates a list of subsites with the data needed to
* produce a dropdown site switcher
* @return ArrayList
*/
public function ListSubsites()
{
$list = $this->Subsites();
$currentSubsiteID = SubsiteState::singleton()->getSubsiteId();
2017-05-24 15:26:28 +02:00
if ($list == null || $list->count() == 1 && $list->first()->DefaultSite == true) {
2017-05-24 15:26:28 +02:00
return false;
}
$module = ModuleLoader::getModule('silverstripe/subsites');
Requirements::javascript($module->getRelativeResourcePath('javascript/LeftAndMain_Subsites.js'));
2017-05-24 15:26:28 +02:00
$output = new ArrayList();
foreach ($list as $subsite) {
$CurrentState = $subsite->ID == $currentSubsiteID ? 'selected' : '';
$output->push(new ArrayData([
2017-05-24 15:26:28 +02:00
'CurrentState' => $CurrentState,
'ID' => $subsite->ID,
'Title' => Convert::raw2xml($subsite->Title)
]));
2017-05-24 15:26:28 +02:00
}
return $output;
}
public function alternateMenuDisplayCheck($controllerName)
{
if (!class_exists($controllerName)) {
return false;
}
// Don't display SubsiteXHRController
if ($controllerName == SubsiteXHRController::class) {
return false;
}
2017-05-24 15:26:28 +02:00
// Check subsite support.
if (SubsiteState::singleton()->getSubsiteId() == 0) {
2017-05-24 15:26:28 +02:00
// Main site always supports everything.
return true;
}
2017-05-24 15:26:28 +02:00
// It's not necessary to check access permissions here. Framework calls canView on the controller,
// which in turn uses the Permission API which is augmented by our GroupSubsites.
$controller = singleton($controllerName);
return $controller->hasMethod('subsiteCMSShowInMenu') && $controller->subsiteCMSShowInMenu();
2017-05-24 15:26:28 +02:00
}
public function CanAddSubsites()
{
return Permission::check('ADMIN', 'any', null, 'all');
2017-05-24 15:26:28 +02:00
}
/**
* Helper for testing if the subsite should be adjusted.
* @param string $adminClass
* @param int $recordSubsiteID
* @param int $currentSubsiteID
2017-06-01 15:10:07 +02:00
* @return bool
2017-05-24 15:26:28 +02:00
*/
public function shouldChangeSubsite($adminClass, $recordSubsiteID, $currentSubsiteID)
{
if (Config::inst()->get($adminClass, 'treats_subsite_0_as_global') && $recordSubsiteID == 0) {
2017-05-24 15:26:28 +02:00
return false;
}
if ($recordSubsiteID != $currentSubsiteID) {
2017-05-24 15:26:28 +02:00
return true;
}
return false;
}
/**
* Check if the current controller is accessible for this user on this subsite.
*/
2017-05-29 13:42:42 +02:00
public function canAccess()
2017-05-24 15:26:28 +02:00
{
// Admin can access everything, no point in checking.
$member = Member::currentUser();
if ($member &&
2015-11-23 04:53:45 +01:00
(
Permission::checkMember($member, 'ADMIN') || // 'Full administrative rights' in SecurityAdmin
Permission::checkMember($member, 'CMS_ACCESS_LeftAndMain') // 'Access to all CMS sections' in SecurityAdmin
)) {
2017-05-24 15:26:28 +02:00
return true;
}
// Check if we have access to current section on the current subsite.
$accessibleSites = $this->owner->sectionSites(true, 'Main site', $member);
return $accessibleSites->count() && $accessibleSites->find('ID', SubsiteState::singleton()->getSubsiteId());
2017-05-24 15:26:28 +02:00
}
/**
* Prevent accessing disallowed resources. This happens after onBeforeInit has executed,
* so all redirections should've already taken place.
*/
public function alternateAccessCheck()
{
return $this->owner->canAccess();
}
/**
* Redirect the user to something accessible if the current section/subsite is forbidden.
*
* This is done via onBeforeInit as it needs to be done before the LeftAndMain::init has a
* chance to forbids access via alternateAccessCheck.
*
* If we need to change the subsite we force the redirection to /admin/ so the frontend is
* fully re-synchronised with the internal session. This is better than risking some panels
* showing data from another subsite.
*/
public function onBeforeInit()
{
// We are accessing the CMS, so we need to let Subsites know we will be using the session.
Subsite::$use_session_subsiteid = true;
$session = Controller::curr()->getRequest()->getSession();
2017-05-24 15:26:28 +02:00
// FIRST, check if we need to change subsites due to the URL.
// Catch forced subsite changes that need to cause CMS reloads.
if (isset($_GET['SubsiteID'])) {
// Clear current page when subsite changes (or is set for the first time)
if (!$session->get('SubsiteID') || $_GET['SubsiteID'] != $session->get('SubsiteID')) {
$session->clear("{$this->owner->class}.currentPage");
2017-05-24 15:26:28 +02:00
}
// Update current subsite in session
Subsite::changeSubsite($_GET['SubsiteID']);
//Redirect to clear the current page
if ($this->owner->canView(Member::currentUser())) {
//Redirect to clear the current page
return $this->owner->redirect($this->owner->Link());
}
//Redirect to the default CMS section
return $this->owner->redirect('admin/');
}
// Automatically redirect the session to appropriate subsite when requesting a record.
// This is needed to properly initialise the session in situations where someone opens the CMS via a link.
$record = $this->owner->currentPage();
if ($record
&& isset($record->SubsiteID, $this->owner->urlParams['ID'])
&& is_numeric($record->SubsiteID)
&& $this->shouldChangeSubsite(
$this->owner->class,
$record->SubsiteID,
SubsiteState::singleton()->getSubsiteId()
)
) {
// Update current subsite in session
Subsite::changeSubsite($record->SubsiteID);
if ($this->owner->canView(Member::currentUser())) {
//Redirect to clear the current page
return $this->owner->redirect($this->owner->Link());
2017-05-24 15:26:28 +02:00
}
//Redirect to the default CMS section
return $this->owner->redirect('admin/');
2017-05-24 15:26:28 +02:00
}
// SECOND, check if we need to change subsites due to lack of permissions.
if (!$this->owner->canAccess()) {
$member = Member::currentUser();
// Current section is not accessible, try at least to stick to the same subsite.
$menu = CMSMenu::get_menu_items();
foreach ($menu as $candidate) {
if ($candidate->controller && $candidate->controller != $this->owner->class) {
2017-05-24 15:26:28 +02:00
$accessibleSites = singleton($candidate->controller)->sectionSites(true, 'Main site', $member);
if ($accessibleSites->count()
&& $accessibleSites->find('ID', SubsiteState::singleton()->getSubsiteId())
) {
2017-05-24 15:26:28 +02:00
// Section is accessible, redirect there.
return $this->owner->redirect(singleton($candidate->controller)->Link());
}
}
}
// If no section is available, look for other accessible subsites.
foreach ($menu as $candidate) {
if ($candidate->controller) {
$accessibleSites = singleton($candidate->controller)->sectionSites(true, 'Main site', $member);
if ($accessibleSites->count()) {
Subsite::changeSubsite($accessibleSites->First()->ID);
return $this->owner->redirect(singleton($candidate->controller)->Link());
}
}
}
// We have not found any accessible section or subsite. User should be denied access.
return Security::permissionFailure($this->owner);
}
// Current site is accessible. Allow through.
return;
}
2017-05-29 13:42:42 +02:00
public function augmentNewSiteTreeItem(&$item)
2017-05-24 15:26:28 +02:00
{
$item->SubsiteID = isset($_POST['SubsiteID']) ? $_POST['SubsiteID'] : SubsiteState::singleton()->getSubsiteId();
2017-05-24 15:26:28 +02:00
}
2017-05-29 13:42:42 +02:00
public function onAfterSave($record)
2017-05-24 15:26:28 +02:00
{
if ($record->hasMethod('NormalRelated') && ($record->NormalRelated() || $record->ReverseRelated())) {
$this->owner->response->addHeader(
'X-Status',
rawurlencode(_t('LeftAndMainSubsites.Saved', 'Saved, please update related pages.'))
);
2017-05-24 15:26:28 +02:00
}
}
/**
* @param array $data
* @param Form $form
*/
2015-11-23 04:53:45 +01:00
public function copytosubsite($data, $form)
2017-05-24 15:26:28 +02:00
{
2015-11-23 04:53:45 +01:00
$page = DataObject::get_by_id('SiteTree', $data['ID']);
$subsite = DataObject::get_by_id('Subsite', $data['CopyToSubsiteID']);
$includeChildren = (isset($data['CopyToSubsiteWithChildren'])) ? $data['CopyToSubsiteWithChildren'] : false;
2017-05-29 13:42:42 +02:00
$newPage = $page->duplicateToSubsite($subsite->ID, $includeChildren);
2017-05-24 15:26:28 +02:00
$response = $this->owner->getResponse();
$response->addHeader('X-Reload', true);
2017-05-29 13:42:42 +02:00
return $this->owner->redirect(Controller::join_links(
$this->owner->Link('show'),
$newPage->ID
));
}
}