tonyair/silverstripe-subsites
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-subsites synced 2024-10-22 09:05:55 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #220 from tractorcow/psr-2

Browse Source 
Reformat for psr-2
This commit is contained in:
Daniel Hensby 2015-11-24 09:50:28 +00:00
commit a4c925b625
30 changed files with 3602 additions and 3290 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_config.php
View File

@ -25,4 +25,3 @@ CMSMain::add_extension('SubsiteMenuExtension');
CMSPagesController::add_extension('SubsiteMenuExtension');
SubsiteAdmin::add_extension('SubsiteMenuExtension');
CMSSettingsController::add_extension('SubsiteMenuExtension');

8
code/SubsiteAdmin.php
View File

@ -4,8 +4,8 @@
*
* @package subsites
*/
class SubsiteAdmin extends ModelAdmin {
class SubsiteAdmin extends ModelAdmin
{
private static $managed_models = array('Subsite');
private static $url_segment = 'subsites';
@ -18,7 +18,8 @@ class SubsiteAdmin extends ModelAdmin {
private static $tree_class = 'Subsite';
public function getEditForm($id = null, $fields = null) {
public function getEditForm($id = null, $fields = null)
{
$form = parent::getEditForm($id, $fields);
$grid=$form->Fields()->dataFieldByName('Subsite');
@ -29,5 +30,4 @@ class SubsiteAdmin extends ModelAdmin {
return $form;
}
}

16
code/SubsiteReportWrapper.php
View File

@ -4,11 +4,13 @@
* Creates a subsite-aware version of another report.
* Pass another report (or its classname) into the constructor.
*/
class SubsiteReportWrapper extends SS_ReportWrapper {
class SubsiteReportWrapper extends SS_ReportWrapper
{
///////////////////////////////////////////////////////////////////////////////////////////
// Filtering
function parameterFields() {
public function parameterFields()
{
$subsites = Subsite::accessible_sites('CMS_ACCESS_CMSMain', true);
$options = $subsites->toDropdownMap('ID', 'Title');
@ -36,7 +38,8 @@ class SubsiteReportWrapper extends SS_ReportWrapper {
///////////////////////////////////////////////////////////////////////////////////////////
// Columns
function columns() {
public function columns()
{
$columns = parent::columns();
$columns['Subsite.Title'] = "Subsite";
return $columns;
@ -45,7 +48,8 @@ class SubsiteReportWrapper extends SS_ReportWrapper {
///////////////////////////////////////////////////////////////////////////////////////////
// Querying
function beforeQuery($params) {
public function beforeQuery($params)
{
// The user has select a few specific sites
if (!empty($params['Subsites'])) {
Subsite::$force_subsite = $params['Subsites'];
@ -57,9 +61,9 @@ class SubsiteReportWrapper extends SS_ReportWrapper {
Subsite::$force_subsite = join(',', array_keys($options));
}
}
function afterQuery() {
public function afterQuery()
{
// Manually manage the subsite filtering
Subsite::$force_subsite = null;
}
}

29
code/SubsiteXHRController.php
View File

@ -3,15 +3,20 @@
/**
* Section-agnostic PJAX controller.
*/
class SubsiteXHRController extends LeftAndMain {
class SubsiteXHRController extends LeftAndMain
{
/**
* Relax the access permissions, so anyone who has access to any CMS subsite can access this controller.
*/
public function canView($member = null) {
if (parent::canView()) return true;
public function canView($member = null)
{
if (parent::canView()) {
return true;
}
if (Subsite::all_accessible_sites()->count()>0) return true;
if (Subsite::all_accessible_sites()->count()>0) {
return true;
}
return false;
}
@ -19,11 +24,15 @@ class SubsiteXHRController extends LeftAndMain {
/**
* Similar as above, but for the LeftAndMainSubsites - allow access if user allowed into the CMS at all.
*/
public function canAccess() {
if (Subsite::all_accessible_sites()->count()>0) return true;
public function canAccess()
{
if (Subsite::all_accessible_sites()->count()>0) {
return true;
}
}
public function getResponseNegotiator() {
public function getResponseNegotiator()
{
$negotiator = parent::getResponseNegotiator();
$self = $this;
@ -38,8 +47,8 @@ class SubsiteXHRController extends LeftAndMain {
/**
* Provide the list of available subsites as a cms-section-agnostic PJAX handler.
*/
public function SubsiteList() {
public function SubsiteList()
{
return $this->renderWith('SubsiteList');
}
}

69
code/SubsitesVirtualPage.php
View File

@ -1,6 +1,6 @@
<?php
class SubsitesVirtualPage extends VirtualPage {
class SubsitesVirtualPage extends VirtualPage
{
private static $description = 'Displays the content of a page on another subsite';
private static $db = array(
@ -10,7 +10,8 @@ class SubsitesVirtualPage extends VirtualPage {
'CustomExtraMeta' => 'HTMLText'
);
public function getCMSFields() {
public function getCMSFields()
{
$fields = parent::getCMSFields();
$subsites = DataObject::get('Subsite');
@ -100,7 +101,8 @@ class SubsitesVirtualPage extends VirtualPage {
return $fields;
}
public function fieldLabels($includerelations = true) {
public function fieldLabels($includerelations = true)
{
$labels = parent::fieldLabels($includerelations);
$labels['CustomMetaTitle'] = _t('Subsite.CustomMetaTitle', 'Title');
$labels['CustomMetaKeywords'] = _t('Subsite.CustomMetaKeywords', 'Keywords');
@ -110,50 +112,67 @@ class SubsitesVirtualPage extends VirtualPage {
return $labels;
}
public function getCopyContentFromID_SubsiteID() {
public function getCopyContentFromID_SubsiteID()
{
return ($this->CopyContentFromID) ? (int)$this->CopyContentFrom()->SubsiteID : (int)Session::get('SubsiteID');
}
public function getVirtualFields() {
public function getVirtualFields()
{
$fields = parent::getVirtualFields();
foreach ($fields as $k => $v) {
if($v == 'SubsiteID') unset($fields[$k]);
if ($v == 'SubsiteID') {
unset($fields[$k]);
}
}
foreach(self::$db as $field => $type) if (in_array($field, $fields)) unset($fields[array_search($field, $fields)]);
foreach (self::$db as $field => $type) {
if (in_array($field, $fields)) {
unset($fields[array_search($field, $fields)]);
}
}
return $fields;
}
public function syncLinkTracking() {
public function syncLinkTracking()
{
$oldState = Subsite::$disable_subsite_filter;
Subsite::$disable_subsite_filter = true;
if ($this->CopyContentFromID) $this->HasBrokenLink = DataObject::get_by_id('SiteTree', $this->CopyContentFromID) ? false : true;
if ($this->CopyContentFromID) {
$this->HasBrokenLink = DataObject::get_by_id('SiteTree', $this->CopyContentFromID) ? false : true;
}
Subsite::$disable_subsite_filter = $oldState;
}
public function onBeforeWrite() {
public function onBeforeWrite()
{
parent::onBeforeWrite();
if($this->CustomMetaTitle) $this->MetaTitle = $this->CustomMetaTitle;
else {
if ($this->CustomMetaTitle) {
$this->MetaTitle = $this->CustomMetaTitle;
} else {
$this->MetaTitle = $this->ContentSource()->MetaTitle ? $this->ContentSource()->MetaTitle : $this->MetaTitle;
}
if($this->CustomMetaKeywords) $this->MetaKeywords = $this->CustomMetaKeywords;
else {
if ($this->CustomMetaKeywords) {
$this->MetaKeywords = $this->CustomMetaKeywords;
} else {
$this->MetaKeywords = $this->ContentSource()->MetaKeywords ? $this->ContentSource()->MetaKeywords : $this->MetaKeywords;
}
if($this->CustomMetaDescription) $this->MetaDescription = $this->CustomMetaDescription;
else {
if ($this->CustomMetaDescription) {
$this->MetaDescription = $this->CustomMetaDescription;
} else {
$this->MetaDescription = $this->ContentSource()->MetaDescription ? $this->ContentSource()->MetaDescription : $this->MetaDescription;
}
if($this->CustomExtraMeta) $this->ExtraMeta = $this->CustomExtraMeta;
else {
if ($this->CustomExtraMeta) {
$this->ExtraMeta = $this->CustomExtraMeta;
} else {
$this->ExtraMeta = $this->ContentSource()->ExtraMeta ? $this->ContentSource()->ExtraMeta : $this->ExtraMeta;
}
}
public function validURLSegment() {
public function validURLSegment()
{
$isValid = parent::validURLSegment();
// Veto the validation rules if its false. In this case, some logic
@ -193,15 +212,17 @@ class SubsitesVirtualPage extends VirtualPage {
}
}
class SubsitesVirtualPage_Controller extends VirtualPage_Controller {
public function reloadContent() {
class SubsitesVirtualPage_Controller extends VirtualPage_Controller
{
public function reloadContent()
{
$this->failover->copyFrom($this->failover->CopyContentFrom());
$this->failover->write();
return;
}
public function init(){
public function init()
{
$origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
Subsite::$disable_subsite_filter = true;

8
code/extensions/CMSPageAddControllerExtension.php
View File

@ -1,8 +1,8 @@
<?php
class CMSPageAddControllerExtension extends Extension {
function updatePageOptions(&$fields) {
class CMSPageAddControllerExtension extends Extension
{
public function updatePageOptions(&$fields)
{
$fields->push(new HiddenField('SubsiteID', 'SubsiteID', Subsite::currentSubsiteID()));
}
}

14
code/extensions/ControllerSubsites.php
View File

@ -2,19 +2,21 @@
/**
* @package subsites
*/
class ControllerSubsites extends Extension {
function controllerAugmentInit(){
class ControllerSubsites extends Extension
{
public function controllerAugmentInit()
{
if ($subsite = Subsite::currentSubsite()) {
if($theme = $subsite->Theme)
if ($theme = $subsite->Theme) {
SSViewer::set_theme($theme);
}
}
}
function CurrentSubsite(){
public function CurrentSubsite()
{
if ($subsite = Subsite::currentSubsite()) {
return $subsite;
}
}
}
?>

15
code/extensions/ErrorPageSubsite.php
View File

@ -1,6 +1,6 @@
<?php
class ErrorPageSubsite extends DataExtension {
class ErrorPageSubsite extends DataExtension
{
/**
* Alter file path to generated a static (static) error page file to handle error page template on different sub-sites
*
@ -9,7 +9,8 @@ class ErrorPageSubsite extends DataExtension {
* FIXME since {@link Subsite::currentSubsite()} partly relies on Session, viewing other sub-site (including main site) between
* opening ErrorPage in the CMS and publish ErrorPage causes static error page to get generated incorrectly.
*/
function alternateFilepathForErrorcode($statusCode, $locale = null) {
public function alternateFilepathForErrorcode($statusCode, $locale = null)
{
$static_filepath = Config::inst()->get($this->owner->ClassName, 'static_filepath');
$subdomainPart = "";
@ -19,8 +20,11 @@ class ErrorPageSubsite extends DataExtension {
// since this function is called from Page class before the controller is created, we have to get subsite from domain instead
if (!$subsite) {
$subsiteID = Subsite::getSubsiteIDForDomain();
if($subsiteID != 0) $subsite = DataObject::get_by_id("Subsite", $subsiteID);
else $subsite = null;
if ($subsiteID != 0) {
$subsite = DataObject::get_by_id("Subsite", $subsiteID);
} else {
$subsite = null;
}
}
if ($subsite) {
@ -36,5 +40,4 @@ class ErrorPageSubsite extends DataExtension {
return $filepath;
}
}

44
code/extensions/FileSubsites.php
View File

@ -4,11 +4,11 @@
*
* @package subsites
*/
class FileSubsites extends DataExtension {
class FileSubsites extends DataExtension
{
// If this is set to true, all folders created will be default be
// considered 'global', unless set otherwise
static $default_root_folders_global = false;
public static $default_root_folders_global = false;
private static $has_one=array(
'Subsite' => 'Subsite',
@ -18,15 +18,20 @@ class FileSubsites extends DataExtension {
* Amends the CMS tree title for folders in the Files & Images section.
* Prefixes a '* ' to the folders that are accessible from all subsites.
*/
function alternateTreeTitle() {
if($this->owner->SubsiteID == 0) return " * " . $this->owner->Title;
else return $this->owner->Title;
public function alternateTreeTitle()
{
if ($this->owner->SubsiteID == 0) {
return " * " . $this->owner->Title;
} else {
return $this->owner->Title;
}
}
/**
* Add subsites-specific fields to the folder editor.
*/
function updateCMSFields(FieldList $fields) {
public function updateCMSFields(FieldList $fields)
{
if ($this->owner instanceof Folder) {
$sites = Subsite::accessible_sites('CMS_ACCESS_AssetAdmin');
$values = array();
@ -57,14 +62,19 @@ class FileSubsites extends DataExtension {
/**
* Update any requests to limit the results to the current site
*/
public function augmentSQL(SQLQuery &$query) {
if(Subsite::$disable_subsite_filter) return;
public function augmentSQL(SQLQuery &$query)
{
if (Subsite::$disable_subsite_filter) {
return;
}
// If you're querying by ID, ignore the sub-site - this is a bit ugly... (but it was WAYYYYYYYYY worse)
//@TODO I don't think excluding if SiteTree_ImageTracking is a good idea however because of the SS 3.0 api and ManyManyList::removeAll() changing the from table after this function is called there isn't much of a choice
$from = $query->getFrom();
if(isset($from['SiteTree_ImageTracking']) || $query->filtersOnID()) return;
if (isset($from['SiteTree_ImageTracking']) || $query->filtersOnID()) {
return;
}
$subsiteID = (int) Subsite::currentSubsiteID();
@ -84,7 +94,8 @@ class FileSubsites extends DataExtension {
}
}
function onBeforeWrite() {
public function onBeforeWrite()
{
if (!$this->owner->ID && !$this->owner->SubsiteID) {
if (self::$default_root_folders_global) {
$this->owner->SubsiteID = 0;
@ -94,7 +105,8 @@ class FileSubsites extends DataExtension {
}
}
function onAfterUpload() {
public function onAfterUpload()
{
// If we have a parent, use it's subsite as our subsite
if ($this->owner->Parent()) {
$this->owner->SubsiteID = $this->owner->Parent()->SubsiteID;
@ -104,7 +116,8 @@ class FileSubsites extends DataExtension {
$this->owner->write();
}
function canEdit($member = null) {
public function canEdit($member = null)
{
// Check the CMS_ACCESS_SecurityAdmin privileges on the subsite that owns this group
$subsiteID = Session::get('SubsiteID');
if ($subsiteID&&$subsiteID == $this->owner->SubsiteID) {
@ -121,9 +134,8 @@ class FileSubsites extends DataExtension {
/**
* Return a piece of text to keep DataObject cache keys appropriately specific
*/
function cacheKeyComponent() {
public function cacheKeyComponent()
{
return 'subsite-'.Subsite::currentSubsiteID();
}
}

41
code/extensions/GroupSubsites.php
View File

@ -4,8 +4,8 @@
*
* @package subsites
*/
class GroupSubsites extends DataExtension implements PermissionProvider {
class GroupSubsites extends DataExtension implements PermissionProvider
{
private static $db = array(
'AccessAllSubsites' => 'Boolean'
);
@ -21,7 +21,8 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
/**
* Migrations for GroupSubsites data.
*/
function requireDefaultRecords() {
public function requireDefaultRecords()
{
// Migration for Group.SubsiteID data from when Groups only had a single subsite
$groupFields = DB::field_list('Group');
@ -43,12 +44,12 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
LEFT JOIN "Group_Subsites" ON "Group_Subsites"."GroupID" = "Group"."ID" AND "Group_Subsites"."SubsiteID" > 0
WHERE "AccessAllSubsites" = 1
OR "Group_Subsites"."GroupID" IS NOT NULL ')->value()) {
DB::query('UPDATE "Group" SET "AccessAllSubsites" = 1');
}
}
function updateCMSFields(FieldList $fields) {
public function updateCMSFields(FieldList $fields)
{
if ($this->owner->canEdit()) {
// i18n tab
$fields->findOrMakeTab('Root.Subsites', _t('GroupSubsites.SECURITYTABTITLE', 'Subsites'));
@ -73,7 +74,6 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
unset($subsiteMap[0]);
$fields->addFieldToTab("Root.Subsites", new CheckboxSetField("Subsites", "",
$subsiteMap));
} else {
if (sizeof($subsiteMap) <= 1) {
$fields->addFieldToTab("Root.Subsites", new ReadonlyField("SubsitesHuman",
@ -94,7 +94,8 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
* to make it easy to distinguish in the tree-view
* of the security admin interface.
*/
function alternateTreeTitle() {
public function alternateTreeTitle()
{
if ($this->owner->AccessAllSubsites) {
$title = _t('GroupSubsites.GlobalGroup', 'global group');
return htmlspecialchars($this->owner->Title, ENT_QUOTES) . ' <i>(' . $title . ')</i>';
@ -107,9 +108,14 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
/**
* Update any requests to limit the results to the current site
*/
public function augmentSQL(SQLQuery &$query) {
if(Subsite::$disable_subsite_filter) return;
if(Cookie::get('noSubsiteFilter') == 'true') return;
public function augmentSQL(SQLQuery &$query)
{
if (Subsite::$disable_subsite_filter) {
return;
}
if (Cookie::get('noSubsiteFilter') == 'true') {
return;
}
// If you're querying by ID, ignore the sub-site - this is a bit ugly...
if (!$query->filtersOnID()) {
@ -145,7 +151,8 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
}
}
function onBeforeWrite() {
public function onBeforeWrite()
{
// New record test approximated by checking whether the ID has changed.
// Note also that the after write test is only used when we're *not* on a subsite
if ($this->owner->isChanged('ID') && !Subsite::currentSubsiteID()) {
@ -153,7 +160,8 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
}
}
function onAfterWrite() {
public function onAfterWrite()
{
// New record test approximated by checking whether the ID has changed.
// Note also that the after write test is only used when we're on a subsite
if ($this->owner->isChanged('ID') && $currentSubsiteID = Subsite::currentSubsiteID()) {
@ -162,7 +170,8 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
}
}
function alternateCanEdit() {
public function alternateCanEdit()
{
// Find the sites that this group belongs to and the sites where we have appropriate perm.
$accessibleSites = Subsite::accessible_sites('CMS_ACCESS_SecurityAdmin')->column('ID');
$linkedSites = $this->owner->Subsites()->column('ID');
@ -172,7 +181,8 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
return (bool)array_intersect($accessibleSites, $linkedSites);
}
function providePermissions() {
public function providePermissions()
{
return array(
'SECURITY_SUBSITE_GROUP' => array(
'name' => _t('GroupSubsites.MANAGE_SUBSITES', 'Manage subsites for groups'),
@ -182,7 +192,4 @@ class GroupSubsites extends DataExtension implements PermissionProvider {
)
);
}
}
?>

82
code/extensions/LeftAndMainSubsites.php
View File

@ -4,8 +4,8 @@
*
* @package subsites
*/
class LeftAndMainSubsites extends Extension {
class LeftAndMainSubsites extends Extension
{
private static $allowed_actions = array('CopyToSubsite');
/**
@ -15,7 +15,8 @@ class LeftAndMainSubsites extends Extension {
*/
private static $treats_subsite_0_as_global = false;
function init() {
public function init()
{
Requirements::css('subsites/css/LeftAndMain_Subsites.css');
Requirements::javascript('subsites/javascript/LeftAndMain_Subsites.js');
Requirements::javascript('subsites/javascript/VirtualPage_Subsites.js');
@ -24,12 +25,14 @@ class LeftAndMainSubsites extends Extension {
/**
* Set the title of the CMS tree
*/
function getCMSTreeTitle() {
public function getCMSTreeTitle()
{
$subsite = Subsite::currentSubSite();
return $subsite ? Convert::raw2xml($subsite->Title) : _t('LeftAndMain.SITECONTENTLEFT');
}
function updatePageOptions(&$fields) {
public function updatePageOptions(&$fields)
{
$fields->push(new HiddenField('SubsiteID', 'SubsiteID', Subsite::currentSubsiteID()));
}
@ -38,23 +41,33 @@ class LeftAndMainSubsites extends Extension {
*
* @return ArrayList of {@link Subsite} instances.
*/
function sectionSites($includeMainSite = true, $mainSiteTitle = "Main site", $member = null) {
public function sectionSites($includeMainSite = true, $mainSiteTitle = "Main site", $member = null)
{
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)) $member = DataObject::get_by_id('Member', $member);
if (!$member) {
$member = Member::currentUser();
}
if (!$member) {
return new ArrayList();
}
if (!is_object($member)) {
$member = DataObject::get_by_id('Member', $member);
}
// 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 = array();
$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}";
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();
@ -89,7 +102,8 @@ class LeftAndMainSubsites extends Extension {
* 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() {
public function Subsites()
{
return Subsite::all_accessible_sites();
}
@ -99,7 +113,8 @@ class LeftAndMainSubsites extends Extension {
* @return ArrayList
*/
public function ListSubsites(){
public function ListSubsites()
{
$list = $this->Subsites();
$currentSubsiteID = Subsite::currentSubsiteID();
@ -124,7 +139,8 @@ class LeftAndMainSubsites extends Extension {
return $output;
}
public function alternateMenuDisplayCheck($controllerName) {
public function alternateMenuDisplayCheck($controllerName)
{
if (!class_exists($controllerName)) {
return false;
}
@ -146,23 +162,30 @@ class LeftAndMainSubsites extends Extension {
return false;
}
public function CanAddSubsites() {
public function CanAddSubsites()
{
return Permission::check("ADMIN", "any", null, "all");
}
/**
* Helper for testing if the subsite should be adjusted.
*/
public function shouldChangeSubsite($adminClass, $recordSubsiteID, $currentSubsiteID) {
if (Config::inst()->get($adminClass, 'treats_subsite_0_as_global') && $recordSubsiteID==0) return false;
if ($recordSubsiteID!=$currentSubsiteID) return true;
public function shouldChangeSubsite($adminClass, $recordSubsiteID, $currentSubsiteID)
{
if (Config::inst()->get($adminClass, 'treats_subsite_0_as_global') && $recordSubsiteID==0) {
return false;
}
if ($recordSubsiteID!=$currentSubsiteID) {
return true;
}
return false;
}
/**
* Check if the current controller is accessible for this user on this subsite.
*/
function canAccess() {
public function canAccess()
{
// Admin can access everything, no point in checking.
$member = Member::currentUser();
if ($member &&
@ -187,7 +210,8 @@ class LeftAndMainSubsites extends Extension {
* Prevent accessing disallowed resources. This happens after onBeforeInit has executed,
* so all redirections should've already taken place.
*/
public function alternateAccessCheck() {
public function alternateAccessCheck()
{
return $this->owner->canAccess();
}
@ -201,7 +225,8 @@ class LeftAndMainSubsites extends Extension {
* fully re-synchronised with the internal session. This is better than risking some panels
* showing data from another subsite.
*/
public function onBeforeInit() {
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;
@ -230,7 +255,6 @@ class LeftAndMainSubsites extends Extension {
// 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) && is_numeric($record->SubsiteID) && isset($this->owner->urlParams['ID'])) {
if ($this->shouldChangeSubsite($this->owner->class, $record->SubsiteID, Subsite::currentSubsiteID())) {
// Update current subsite in session
Subsite::changeSubsite($record->SubsiteID);
@ -242,20 +266,17 @@ class LeftAndMainSubsites extends Extension {
//Redirect to the default CMS section
return $this->owner->redirect('admin/');
}
}
// 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) {
$accessibleSites = singleton($candidate->controller)->sectionSites(true, 'Main site', $member);
if ($accessibleSites->count() && $accessibleSites->find('ID', Subsite::currentSubsiteID())) {
// Section is accessible, redirect there.
@ -277,24 +298,26 @@ class LeftAndMainSubsites extends Extension {
// 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;
}
function augmentNewSiteTreeItem(&$item) {
public function augmentNewSiteTreeItem(&$item)
{
$item->SubsiteID = isset($_POST['SubsiteID']) ? $_POST['SubsiteID'] : Subsite::currentSubsiteID();
}
function onAfterSave($record) {
public function onAfterSave($record)
{
if ($record->hasMethod('NormalRelated') && ($record->NormalRelated() || $record->ReverseRelated())) {
$this->owner->response->addHeader('X-Status', rawurlencode(_t('LeftAndMainSubsites.Saved', 'Saved, please update related pages.')));
}
}
function copytosubsite($data, $form) {
public function copytosubsite($data, $form)
{
$page = DataObject::get_by_id('SiteTree', $data['ID']);
$subsite = DataObject::get_by_id('Subsite', $data['CopyToSubsiteID']);
$newPage = $page->duplicateToSubsite($subsite->ID, true);
@ -302,5 +325,4 @@ class LeftAndMainSubsites extends Extension {
$response->addHeader('X-Reload', true);
return $this->owner->redirect(Controller::join_links($this->owner->Link('show'), $newPage->ID));
}
}

36
code/extensions/SiteConfigSubsites.php
View File

@ -3,8 +3,8 @@
/**
* Extension for the SiteConfig object to add subsites support
*/
class SiteConfigSubsites extends DataExtension {
class SiteConfigSubsites extends DataExtension
{
private static $has_one = array(
'Subsite' => 'Subsite', // The subsite that this page belongs to
);
@ -12,14 +12,21 @@ class SiteConfigSubsites extends DataExtension {
/**
* Update any requests to limit the results to the current site
*/
public function augmentSQL(SQLQuery &$query) {
if(Subsite::$disable_subsite_filter) return;
public function augmentSQL(SQLQuery &$query)
{
if (Subsite::$disable_subsite_filter) {
return;
}
// If you're querying by ID, ignore the sub-site - this is a bit ugly...
if($query->filtersOnID()) return;
if ($query->filtersOnID()) {
return;
}
$regexp = '/^(.*\.)?("|`)?SubsiteID("|`)?\s?=/';
foreach ($query->getWhereParameterised($parameters) as $predicate) {
if(preg_match($regexp, $predicate)) return;
if (preg_match($regexp, $predicate)) {
return;
}
}
/*if($context = DataObject::context_obj()) $subsiteID = (int)$context->SubsiteID;
@ -28,22 +35,29 @@ class SiteConfigSubsites extends DataExtension {
$froms=$query->getFrom();
$froms=array_keys($froms);
$tableName = array_shift($froms);
if($tableName != 'SiteConfig') return;
if ($tableName != 'SiteConfig') {
return;
}
$query->addWhere("\"$tableName\".\"SubsiteID\" IN ($subsiteID)");
}
function onBeforeWrite() {
if((!is_numeric($this->owner->ID) || !$this->owner->ID) && !$this->owner->SubsiteID) $this->owner->SubsiteID = Subsite::currentSubsiteID();
public function onBeforeWrite()
{
if ((!is_numeric($this->owner->ID) || !$this->owner->ID) && !$this->owner->SubsiteID) {
$this->owner->SubsiteID = Subsite::currentSubsiteID();
}
}
/**
* Return a piece of text to keep DataObject cache keys appropriately specific
*/
function cacheKeyComponent() {
public function cacheKeyComponent()
{
return 'subsite-'.Subsite::currentSubsiteID();
}
function updateCMSFields(FieldList $fields) {
public function updateCMSFields(FieldList $fields)
{
$fields->push(new HiddenField('SubsiteID', 'SubsiteID', Subsite::currentSubsiteID()));
}
}

125
code/extensions/SiteTreeSubsites.php
View File

@ -3,8 +3,8 @@
/**
* Extension for the SiteTree object to add subsites support
*/
class SiteTreeSubsites extends DataExtension {
class SiteTreeSubsites extends DataExtension
{
private static $has_one = array(
'Subsite' => 'Subsite', // The subsite that this page belongs to
);
@ -17,24 +17,35 @@ class SiteTreeSubsites extends DataExtension {
"CrossSubsiteLinkTracking" => array("FieldName" => "Varchar")
);
function isMainSite() {
if($this->owner->SubsiteID == 0) return true;
public function isMainSite()
{
if ($this->owner->SubsiteID == 0) {
return true;
}
return false;
}
/**
* Update any requests to limit the results to the current site
*/
public function augmentSQL(SQLQuery &$query, DataQuery &$dataQuery = null) {
if(Subsite::$disable_subsite_filter) return;
if($dataQuery->getQueryParam('Subsite.filter') === false) return;
public function augmentSQL(SQLQuery &$query, DataQuery &$dataQuery = null)
{
if (Subsite::$disable_subsite_filter) {
return;
}
if ($dataQuery->getQueryParam('Subsite.filter') === false) {
return;
}
// If you're querying by ID, ignore the sub-site - this is a bit ugly...
// if(!$query->where || (strpos($query->where[0], ".\"ID\" = ") === false && strpos($query->where[0], ".`ID` = ") === false && strpos($query->where[0], ".ID = ") === false && strpos($query->where[0], "ID = ") !== 0)) {
if($query->filtersOnID()) return;
if ($query->filtersOnID()) {
return;
}
if (Subsite::$force_subsite) $subsiteID = Subsite::$force_subsite;
else {
if (Subsite::$force_subsite) {
$subsiteID = Subsite::$force_subsite;
} else {
/*if($context = DataObject::context_obj()) $subsiteID = (int)$context->SubsiteID;
else */$subsiteID = (int)Subsite::currentSubsiteID();
}
@ -42,19 +53,25 @@ class SiteTreeSubsites extends DataExtension {
// The foreach is an ugly way of getting the first key :-)
foreach ($query->getFrom() as $tableName => $info) {
// The tableName should be SiteTree or SiteTree_Live...
if(strpos($tableName,'SiteTree') === false) break;
if (strpos($tableName, 'SiteTree') === false) {
break;
}
$query->addWhere("\"$tableName\".\"SubsiteID\" IN ($subsiteID)");
break;
}
}
function onBeforeWrite() {
if(!$this->owner->ID && !$this->owner->SubsiteID) $this->owner->SubsiteID = Subsite::currentSubsiteID();
public function onBeforeWrite()
{
if (!$this->owner->ID && !$this->owner->SubsiteID) {
$this->owner->SubsiteID = Subsite::currentSubsiteID();
}
parent::onBeforeWrite();
}
function updateCMSFields(FieldList $fields) {
public function updateCMSFields(FieldList $fields)
{
$subsites = Subsite::accessible_sites("CMS_ACCESS_CMSMain");
$subsitesMap = array();
if ($subsites && $subsites->Count()) {
@ -99,8 +116,11 @@ class SiteTreeSubsites extends DataExtension {
}
}
function alternateSiteConfig() {
if(!$this->owner->SubsiteID) return false;
public function alternateSiteConfig()
{
if (!$this->owner->SubsiteID) {
return false;
}
$sc = DataObject::get_one('SiteConfig', '"SubsiteID" = ' . $this->owner->SubsiteID);
if (!$sc) {
$sc = new SiteConfig();
@ -119,9 +139,11 @@ class SiteTreeSubsites extends DataExtension {
*
* @return boolean
*/
function canEdit($member = null) {
if(!$member) $member = Member::currentUser();
public function canEdit($member = null)
{
if (!$member) {
$member = Member::currentUser();
}
// Find the sites that this user has access to
$goodSites = Subsite::accessible_sites('CMS_ACCESS_CMSMain', true, 'all', $member)->column('ID');
@ -138,14 +160,19 @@ class SiteTreeSubsites extends DataExtension {
}
// Return true if they have access to this object's site
if(!(in_array(0, $goodSites) || in_array($subsiteID, $goodSites))) return false;
if (!(in_array(0, $goodSites) || in_array($subsiteID, $goodSites))) {
return false;
}
}
/**
* @return boolean
*/
function canDelete($member = null) {
if(!$member && $member !== FALSE) $member = Member::currentUser();
public function canDelete($member = null)
{
if (!$member && $member !== false) {
$member = Member::currentUser();
}
return $this->canEdit($member);
}
@ -153,8 +180,11 @@ class SiteTreeSubsites extends DataExtension {
/**
* @return boolean
*/
function canAddChildren($member = null) {
if(!$member && $member !== FALSE) $member = Member::currentUser();
public function canAddChildren($member = null)
{
if (!$member && $member !== false) {
$member = Member::currentUser();
}
return $this->canEdit($member);
}
@ -162,8 +192,11 @@ class SiteTreeSubsites extends DataExtension {
/**
* @return boolean
*/
function canPublish($member = null) {
if(!$member && $member !== FALSE) $member = Member::currentUser();
public function canPublish($member = null)
{
if (!$member && $member !== false) {
$member = Member::currentUser();
}
return $this->canEdit($member);
}
@ -172,11 +205,14 @@ class SiteTreeSubsites extends DataExtension {
* Create a duplicate of this page and save it to another subsite
* @param $subsiteID int|Subsite The Subsite to copy to, or its ID
*/
public function duplicateToSubsite($subsiteID = null) {
public function duplicateToSubsite($subsiteID = null)
{
if (is_object($subsiteID)) {
$subsite = $subsiteID;
$subsiteID = $subsite->ID;
} else $subsite = DataObject::get_by_id('Subsite', $subsiteID);
} else {
$subsite = DataObject::get_by_id('Subsite', $subsiteID);
}
$oldSubsite=Subsite::currentSubsiteID();
if ($subsiteID) {
@ -203,7 +239,8 @@ class SiteTreeSubsites extends DataExtension {
/**
* Called by ContentController::init();
*/
static function contentcontrollerInit($controller) {
public static function contentcontrollerInit($controller)
{
$subsite = Subsite::currentSubsite();
if ($subsite && $subsite->Theme) {
@ -211,7 +248,8 @@ class SiteTreeSubsites extends DataExtension {
}
}
function alternateAbsoluteLink() {
public function alternateAbsoluteLink()
{
// Generate the existing absolute URL and replace the domain with the subsite domain.
// This helps deal with Link() returning an absolute URL.
$url = Director::absoluteURL($this->owner->Link());
@ -225,7 +263,8 @@ class SiteTreeSubsites extends DataExtension {
* Use the CMS domain for iframed CMS previews to prevent single-origin violations
* and SSL cert problems.
*/
function alternatePreviewLink($action = null) {
public function alternatePreviewLink($action = null)
{
$url = Director::absoluteURL($this->owner->Link());
if ($this->owner->SubsiteID) {
$url = HTTP::setGetVar('SubsiteID', $this->owner->SubsiteID, $url);
@ -236,7 +275,8 @@ class SiteTreeSubsites extends DataExtension {
/**
* Inject the subsite ID into the content so it can be used by frontend scripts.
*/
function MetaTags(&$tags) {
public function MetaTags(&$tags)
{
if ($this->owner->SubsiteID) {
$tags .= "<meta name=\"x-subsite-id\" content=\"" . $this->owner->SubsiteID . "\" />\n";
}
@ -244,12 +284,14 @@ class SiteTreeSubsites extends DataExtension {
return $tags;
}
function augmentSyncLinkTracking() {
public function augmentSyncLinkTracking()
{
// Set LinkTracking appropriately
$links = HTTP::getLinksIn($this->owner->Content);
$linkedPages = array();
if($links) foreach($links as $link) {
if ($links) {
foreach ($links as $link) {
if (substr($link, 0, strlen('http://')) == 'http://') {
$withoutHttp = substr($link, strlen('http://'));
if (strpos($withoutHttp, '/') && strpos($withoutHttp, '/') < strlen($withoutHttp)) {
@ -257,7 +299,9 @@ class SiteTreeSubsites extends DataExtension {
$rest = substr($withoutHttp, strpos($withoutHttp, '/') + 1);
$subsiteID = Subsite::getSubsiteIDForDomain($domain);
if($subsiteID == 0) continue; // We have no idea what the domain for the main site is, so cant track links to it
if ($subsiteID == 0) {
continue;
} // We have no idea what the domain for the main site is, so cant track links to it
$origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
Subsite::disable_subsite_filter(true);
@ -272,6 +316,7 @@ class SiteTreeSubsites extends DataExtension {
}
}
}
}
$this->owner->CrossSubsiteLinkTracking()->setByIDList($linkedPages);
}
@ -279,7 +324,8 @@ class SiteTreeSubsites extends DataExtension {
/**
* Return a piece of text to keep DataObject cache keys appropriately specific
*/
function cacheKeyComponent() {
public function cacheKeyComponent()
{
return 'subsite-'.Subsite::currentSubsiteID();
}
@ -287,13 +333,16 @@ class SiteTreeSubsites extends DataExtension {
* @param Member
* @return boolean|null
*/
function canCreate($member = null) {
public function canCreate($member = null)
{
// Typically called on a singleton, so we're not using the Subsite() relation
$subsite = Subsite::currentSubsite();
if ($subsite && $subsite->exists() && $subsite->PageTypeBlacklist) {
$blacklisted = explode(',', $subsite->PageTypeBlacklist);
// All subclasses need to be listed explicitly
if(in_array($this->owner->class, $blacklisted)) return false;
if (in_array($this->owner->class, $blacklisted)) {
return false;
}
}
}
}

8
code/extensions/SubsiteMenuExtension.php
View File

@ -10,10 +10,10 @@
* Or you can include the subsiteCMSShowInMenu function in your admin class and have it return true
*/
class SubsiteMenuExtension extends Extension{
public function subsiteCMSShowInMenu(){
class SubsiteMenuExtension extends Extension
{
public function subsiteCMSShowInMenu()
{
return true;
}
}

13
code/forms/GridFieldSubsiteDetailForm.php
View File

@ -1,10 +1,11 @@
<?php
class GridFieldSubsiteDetailForm extends GridFieldDetailForm {
class GridFieldSubsiteDetailForm extends GridFieldDetailForm
{
protected $itemRequestClass='GridFieldSubsiteDetailForm_ItemRequest';
}
class GridFieldSubsiteDetailForm_ItemRequest extends GridFieldDetailForm_ItemRequest {
class GridFieldSubsiteDetailForm_ItemRequest extends GridFieldDetailForm_ItemRequest
{
private static $allowed_actions = array(
'ItemEditForm',
);
@ -20,7 +21,8 @@ class GridFieldSubsiteDetailForm_ItemRequest extends GridFieldDetailForm_ItemReq
* @return Form
* @see GridFieldDetailForm_ItemRequest::ItemEditForm()
*/
function ItemEditForm() {
public function ItemEditForm()
{
$form=parent::ItemEditForm();
if ($this->record->ID == 0) {
@ -38,7 +40,8 @@ class GridFieldSubsiteDetailForm_ItemRequest extends GridFieldDetailForm_ItemReq
return $form;
}
function doSave($data, $form) {
public function doSave($data, $form)
{
$new_record = $this->record->ID == 0;
if ($new_record && isset($data['TemplateID']) && !empty($data['TemplateID'])) {
$template = Subsite::get()->byID(intval($data['TemplateID']));

16
code/forms/SubsitesTreeDropdownField.php
View File

@ -5,8 +5,8 @@
*
* @package subsites
*/
class SubsitesTreeDropdownField extends TreeDropdownField {
class SubsitesTreeDropdownField extends TreeDropdownField
{
private static $allowed_actions = array(
'tree'
);
@ -15,7 +15,8 @@ class SubsitesTreeDropdownField extends TreeDropdownField {
protected $extraClasses = array('SubsitesTreeDropdownField');
function Field($properties = array()) {
public function Field($properties = array())
{
$html = parent::Field($properties);
Requirements::javascript('subsites/javascript/SubsitesTreeDropdownField.js');
@ -23,15 +24,18 @@ class SubsitesTreeDropdownField extends TreeDropdownField {
return $html;
}
function setSubsiteID($id) {
public function setSubsiteID($id)
{
$this->subsiteID = $id;
}
function getSubsiteID() {
public function getSubsiteID()
{
return $this->subsiteID;
}
function tree(SS_HTTPRequest $request) {
public function tree(SS_HTTPRequest $request)
{
$oldSubsiteID = Session::get('SubsiteID');
Session::set('SubsiteID', $this->subsiteID);

208
code/model/Subsite.php
View File

@ -5,8 +5,8 @@
*
* @package subsites
*/
class Subsite extends DataObject {
class Subsite extends DataObject
{
/**
* @var $use_session_subsiteid Boolean Set to TRUE when using the CMS and FALSE
* when browsing the frontend of a website.
@ -72,7 +72,8 @@ class Subsite extends DataObject {
*
* @param array $themes - Numeric array of all themes which are allowed to be selected for all subsites.
*/
public static function set_allowed_themes($themes) {
public static function set_allowed_themes($themes)
{
self::$allowed_themes = $themes;
}
@ -82,7 +83,8 @@ class Subsite extends DataObject {
* @uses ControllerSubsites->controllerAugmentInit()
* @return Subsite
*/
public static function currentSubsite() {
public static function currentSubsite()
{
// get_by_id handles caching so we don't have to
return DataObject::get_by_id('Subsite', self::currentSubsiteID());
}
@ -100,8 +102,9 @@ class Subsite extends DataObject {
* @param boolean $cache
* @return int ID of the current subsite instance
*/
public static function currentSubsiteID() {
$id = NULL;
public static function currentSubsiteID()
{
$id = null;
if (isset($_GET['SubsiteID'])) {
$id = (int)$_GET['SubsiteID'];
@ -109,7 +112,7 @@ class Subsite extends DataObject {
$id = Session::get('SubsiteID');
}
if($id === NULL) {
if ($id === null) {
$id = self::getSubsiteIDForDomain();
}
@ -122,13 +125,19 @@ class Subsite extends DataObject {
*
* @param int|Subsite $subsite Either the ID of the subsite, or the subsite object itself
*/
public static function changeSubsite($subsite) {
public static function changeSubsite($subsite)
{
// Session subsite change only meaningful if the session is active.
// Otherwise we risk setting it to wrong value, e.g. if we rely on currentSubsiteID.
if (!Subsite::$use_session_subsiteid) return;
if (!Subsite::$use_session_subsiteid) {
return;
}
if(is_object($subsite)) $subsiteID = $subsite->ID;
else $subsiteID = $subsite;
if (is_object($subsite)) {
$subsiteID = $subsite->ID;
} else {
$subsiteID = $subsite;
}
Session::set('SubsiteID', (int)$subsiteID);
@ -152,7 +161,8 @@ class Subsite extends DataObject {
* @param $host The host to find the subsite for. If not specified, $_SERVER['HTTP_HOST'] is used.
* @return int Subsite ID
*/
public static function getSubsiteIDForDomain($host = null, $checkPermissions = true) {
public static function getSubsiteIDForDomain($host = null, $checkPermissions = true)
{
if ($host == null && isset($_SERVER['HTTP_HOST'])) {
$host = $_SERVER['HTTP_HOST'];
}
@ -160,10 +170,14 @@ class Subsite extends DataObject {
$matchingDomains = null;
$cacheKey = null;
if ($host) {
if(!self::$strict_subdomain_matching) $host = preg_replace('/^www\./', '', $host);
if (!self::$strict_subdomain_matching) {
$host = preg_replace('/^www\./', '', $host);
}
$cacheKey = implode('_', array($host, Member::currentUserID(), self::$check_is_public));
if(isset(self::$_cache_subsite_for_domain[$cacheKey])) return self::$_cache_subsite_for_domain[$cacheKey];
if (isset(self::$_cache_subsite_for_domain[$cacheKey])) {
return self::$_cache_subsite_for_domain[$cacheKey];
}
$SQL_host = Convert::raw2sql($host);
$matchingDomains = DataObject::get(
@ -209,7 +223,8 @@ class Subsite extends DataObject {
* @param string $limit
* @return DataList
*/
public static function get_from_all_subsites($className, $filter = "", $sort = "", $join = "", $limit = "") {
public static function get_from_all_subsites($className, $filter = "", $sort = "", $join = "", $limit = "")
{
$result = DataObject::get($className, $filter, $sort, $join, $limit);
$result = $result->setDataQueryParam('Subsite.filter', false);
return $result;
@ -218,14 +233,16 @@ class Subsite extends DataObject {
/**
* Disable the sub-site filtering; queries will select from all subsites
*/
public static function disable_subsite_filter($disabled = true) {
public static function disable_subsite_filter($disabled = true)
{
self::$disable_subsite_filter = $disabled;
}
/**
* Flush caches on database reset
*/
public static function on_db_reset() {
public static function on_db_reset()
{
self::$_cache_accessible_sites = array();
self::$_cache_subsite_for_domain = array();
}
@ -235,7 +252,8 @@ class Subsite extends DataObject {
*
* @return SS_List List of {@link Subsite} objects (DataList or ArrayList).
*/
public static function all_sites($includeMainSite = true, $mainSiteTitle = "Main site") {
public static function all_sites($includeMainSite = true, $mainSiteTitle = "Main site")
{
$subsites = Subsite::get();
if ($includeMainSite) {
@ -257,11 +275,18 @@ class Subsite extends DataObject {
*
* @return ArrayList of {@link Subsite} instances.
*/
public static function all_accessible_sites($includeMainSite = true, $mainSiteTitle = "Main site", $member = null) {
public static function all_accessible_sites($includeMainSite = true, $mainSiteTitle = "Main site", $member = null)
{
// Rationalise member arguments
if(!$member) $member = Member::currentUser();
if(!$member) return new ArrayList();
if(!is_object($member)) $member = DataObject::get_by_id('Member', $member);
if (!$member) {
$member = Member::currentUser();
}
if (!$member) {
return new ArrayList();
}
if (!is_object($member)) {
$member = DataObject::get_by_id('Member', $member);
}
$subsites = new ArrayList();
@ -295,15 +320,25 @@ class Subsite extends DataObject {
* @param $member
* @return DataList of {@link Subsite} instances
*/
public static function accessible_sites($permCode, $includeMainSite = true, $mainSiteTitle = "Main site", $member = null) {
public static function accessible_sites($permCode, $includeMainSite = true, $mainSiteTitle = "Main site", $member = null)
{
// Rationalise member arguments
if(!$member) $member = Member::currentUser();
if(!$member) return new ArrayList();
if(!is_object($member)) $member = DataObject::get_by_id('Member', $member);
if (!$member) {
$member = Member::currentUser();
}
if (!$member) {
return new ArrayList();
}
if (!is_object($member)) {
$member = DataObject::get_by_id('Member', $member);
}
// Rationalise permCode argument
if(is_array($permCode)) $SQL_codes = "'" . implode("', '", Convert::raw2sql($permCode)) . "'";
else $SQL_codes = "'" . Convert::raw2sql($permCode) . "'";
if (is_array($permCode)) {
$SQL_codes = "'" . implode("', '", Convert::raw2sql($permCode)) . "'";
} else {
$SQL_codes = "'" . Convert::raw2sql($permCode) . "'";
}
// Cache handling
$cacheKey = $SQL_codes . '-' . $member->ID . '-' . $includeMainSite . '-' . $mainSiteTitle;
@ -318,7 +353,9 @@ class Subsite extends DataObject {
->innerJoin('Group_Members', "\"Group_Members\".\"GroupID\"=\"Group\".\"ID\" AND \"Group_Members\".\"MemberID\" = $member->ID")
->innerJoin('Permission', "\"Group\".\"ID\"=\"Permission\".\"GroupID\" AND \"Permission\".\"Code\" IN ($SQL_codes, 'CMS_ACCESS_LeftAndMain', 'ADMIN')");
if(!$subsites) $subsites = new ArrayList();
if (!$subsites) {
$subsites = new ArrayList();
}
$rolesSubsites = DataList::create('Subsite')
->where("\"Subsite\".\"Title\" != ''")
@ -329,18 +366,24 @@ class Subsite extends DataObject {
->innerJoin('PermissionRole', "\"Group_Roles\".\"PermissionRoleID\"=\"PermissionRole\".\"ID\"")
->innerJoin('PermissionRoleCode', "\"PermissionRole\".\"ID\"=\"PermissionRoleCode\".\"RoleID\" AND \"PermissionRoleCode\".\"Code\" IN ($SQL_codes, 'CMS_ACCESS_LeftAndMain', 'ADMIN')");
if(!$subsites && $rolesSubsites) return $rolesSubsites;
if (!$subsites && $rolesSubsites) {
return $rolesSubsites;
}
$subsites = new ArrayList($subsites->toArray());
if($rolesSubsites) foreach($rolesSubsites as $subsite) {
if ($rolesSubsites) {
foreach ($rolesSubsites as $subsite) {
if (!$subsites->find('ID', $subsite->ID)) {
$subsites->push($subsite);
}
}
}
if ($includeMainSite) {
if(!is_array($permCode)) $permCode = array($permCode);
if (!is_array($permCode)) {
$permCode = array($permCode);
}
if (self::hasMainSitePermission($member, $permCode)) {
$subsites=$subsites->toArray();
@ -364,22 +407,35 @@ class Subsite extends DataObject {
* @param string $file - filepath of the host map to be written
* @return void
*/
public static function writeHostMap($file = null) {
if (!self::$write_hostmap) return;
public static function writeHostMap($file = null)
{
if (!self::$write_hostmap) {
return;
}
if (!$file) $file = Director::baseFolder().'/subsites/host-map.php';
if (!$file) {
$file = Director::baseFolder().'/subsites/host-map.php';
}
$hostmap = array();
$subsites = DataObject::get('Subsite');
if ($subsites) foreach($subsites as $subsite) {
if ($subsites) {
foreach ($subsites as $subsite) {
$domains = $subsite->Domains();
if ($domains) foreach($domains as $domain) {
if ($domains) {
foreach ($domains as $domain) {
$domainStr = $domain->Domain;
if(!self::$strict_subdomain_matching) $domainStr = preg_replace('/^www\./', '', $domainStr);
if (!self::$strict_subdomain_matching) {
$domainStr = preg_replace('/^www\./', '', $domainStr);
}
$hostmap[$domainStr] = $subsite->domain();
}
if ($subsite->DefaultSite) $hostmap['default'] = $subsite->domain();
}
if ($subsite->DefaultSite) {
$hostmap['default'] = $subsite->domain();
}
}
}
$data = "<?php \n";
@ -404,15 +460,23 @@ class Subsite extends DataObject {
* @param Array Permission code strings. Defaults to "ADMIN".
* @return boolean
*/
public static function hasMainSitePermission($member = null, $permissionCodes = array('ADMIN')) {
if(!is_array($permissionCodes))
public static function hasMainSitePermission($member = null, $permissionCodes = array('ADMIN'))
{
if (!is_array($permissionCodes)) {
user_error('Permissions must be passed to Subsite::hasMainSitePermission as an array', E_USER_ERROR);
}
if(!$member && $member !== FALSE) $member = Member::currentUser();
if (!$member && $member !== false) {
$member = Member::currentUser();
}
if(!$member) return false;
if (!$member) {
return false;
}
if(!in_array("ADMIN", $permissionCodes)) $permissionCodes[] = "ADMIN";
if (!in_array("ADMIN", $permissionCodes)) {
$permissionCodes[] = "ADMIN";
}
$SQLa_perm = Convert::raw2sql($permissionCodes);
$SQL_perms = join("','", $SQLa_perm);
@ -508,7 +572,8 @@ class Subsite extends DataObject {
* @todo Possible security issue, don't grant edit permissions to everybody.
* @return boolean
*/
public function canEdit($member = false) {
public function canEdit($member = false)
{
return true;
}
@ -517,7 +582,8 @@ class Subsite extends DataObject {
*
* @return FieldList
*/
public function getCMSFields() {
public function getCMSFields()
{
if ($this->ID!=0) {
$domainTable = new GridField(
"Domains",
@ -594,7 +660,8 @@ class Subsite extends DataObject {
* @param boolean $includerelations
* @return array
*/
public function fieldLabels($includerelations = true) {
public function fieldLabels($includerelations = true)
{
$labels = parent::fieldLabels($includerelations);
$labels['Title'] = _t('Subsites.TitleFieldLabel', 'Subsite Name');
$labels['RedirectURL'] = _t('Subsites.RedirectURLFieldLabel', 'Redirect URL');
@ -613,7 +680,8 @@ class Subsite extends DataObject {
*
* @return array
*/
public function summaryFields() {
public function summaryFields()
{
return array(
'Title' => $this->fieldLabel('Title'),
'PrimaryDomain' => $this->fieldLabel('PrimaryDomain'),
@ -626,14 +694,17 @@ class Subsite extends DataObject {
*
* @return array
*/
public function allowedThemes() {
public function allowedThemes()
{
if ($themes = $this->stat('allowed_themes')) {
return ArrayLib::valuekey($themes);
} else {
$themes = array();
if (is_dir('../themes/')) {
foreach (scandir('../themes/') as $theme) {
if($theme[0] == '.') continue;
if ($theme[0] == '.') {
continue;
}
$theme = strtok($theme, '_');
$themes[$theme] = $theme;
}
@ -646,7 +717,8 @@ class Subsite extends DataObject {
/**
* @return string Current locale of the subsite
*/
public function getLanguage() {
public function getLanguage()
{
if ($this->getField('Language')) {
return $this->getField('Language');
} else {
@ -658,7 +730,8 @@ class Subsite extends DataObject {
*
* @return ValidationResult
*/
public function validate() {
public function validate()
{
$result = parent::validate();
if (!$this->Title) {
$result->error(_t('Subsite.ValidateTitle', 'Please add a "Title"'));
@ -671,7 +744,8 @@ class Subsite extends DataObject {
*
* @return void
*/
public function onAfterWrite() {
public function onAfterWrite()
{
Subsite::writeHostMap();
parent::onAfterWrite();
}
@ -682,7 +756,8 @@ class Subsite extends DataObject {
*
* @return string The full domain name of this subsite (without protocol prefix)
*/
public function domain() {
public function domain()
{
if ($this->ID) {
$domains = DataObject::get("SubsiteDomain", "\"SubsiteID\" = $this->ID", "\"IsPrimary\" DESC", "", 1);
if ($domains && $domains->Count()>0) {
@ -709,7 +784,8 @@ class Subsite extends DataObject {
*
* @return string - The full domain name of this subsite (without protocol prefix)
*/
public function getPrimaryDomain() {
public function getPrimaryDomain()
{
return $this->domain();
}
@ -717,14 +793,16 @@ class Subsite extends DataObject {
*
* @return string
*/
public function absoluteBaseURL() {
public function absoluteBaseURL()
{
return "http://" . $this->domain() . Director::baseURL();
}
/**
* @todo getClassName is redundant, already stored as a database field?
*/
public function getClassName() {
public function getClassName()
{
return $this->class;
}
@ -733,7 +811,8 @@ class Subsite extends DataObject {
*
* @return string - javascript
*/
public function adminDuplicate() {
public function adminDuplicate()
{
$newItem = $this->duplicate();
$message = _t(
'Subsite.CopyMessage',
@ -750,7 +829,8 @@ JS;
/**
* Make this subsite the current one
*/
public function activate() {
public function activate()
{
Subsite::changeSubsite($this);
}
@ -759,9 +839,11 @@ JS;
* @param array $permissionCodes
* @return DataList
*/
public function getMembersByPermission($permissionCodes = array('ADMIN')){
if(!is_array($permissionCodes))
public function getMembersByPermission($permissionCodes = array('ADMIN'))
{
if (!is_array($permissionCodes)) {
user_error('Permissions must be passed to Subsite::getMembersByPermission as an array', E_USER_ERROR);
}
$SQL_permissionCodes = Convert::raw2sql($permissionCodes);
$SQL_permissionCodes = join("','", $SQL_permissionCodes);
@ -774,13 +856,13 @@ JS;
LEFT JOIN \"Group\" ON \"Group\".\"ID\" = \"Group_Members\".\"GroupID\"
LEFT JOIN \"Permission\" ON \"Permission\".\"GroupID\" = \"Group\".\"ID\""
);
}
/**
* Duplicate this subsite
*/
public function duplicate($doWrite = true) {
public function duplicate($doWrite = true)
{
$duplicate = parent::duplicate($doWrite);
$oldSubsiteID = Session::get('SubsiteID');

16
code/model/SubsiteDomain.php
View File

@ -4,8 +4,8 @@
* @property text Domain domain name of this subsite. Do not include the URL scheme here
* @property bool IsPrimary Is this the primary subdomain?
*/
class SubsiteDomain extends DataObject {
class SubsiteDomain extends DataObject
{
/**
*
* @var array
@ -37,7 +37,8 @@ class SubsiteDomain extends DataObject {
*
* @return void
*/
public function onAfterWrite() {
public function onAfterWrite()
{
Subsite::writeHostMap();
}
@ -45,7 +46,8 @@ class SubsiteDomain extends DataObject {
*
* @return \FieldList
*/
public function getCMSFields() {
public function getCMSFields()
{
$fields = new FieldList(
new TextField('Domain', $this->fieldLabel('Domain'), null, 255),
new CheckboxField('IsPrimary', $this->fieldLabel('IsPrimary'))
@ -60,7 +62,8 @@ class SubsiteDomain extends DataObject {
* @param bool $includerelations
* @return array
*/
public function fieldLabels($includerelations = true) {
public function fieldLabels($includerelations = true)
{
$labels = parent::fieldLabels($includerelations);
$labels['Domain'] = _t('SubsiteDomain.DOMAIN', 'Domain');
$labels['IsPrimary'] = _t('SubsiteDomain.IS_PRIMARY', 'Is Primary Domain');
@ -72,7 +75,8 @@ class SubsiteDomain extends DataObject {
* Before writing the Subsite Domain, strip out any HTML the user has entered.
* @return void
*/
public function onBeforeWrite() {
public function onBeforeWrite()
{
parent::onBeforeWrite();
//strip out any HTML to avoid XSS attacks

26
code/tasks/SubsiteCopyPagesTask.php
View File

@ -6,22 +6,31 @@
*
* Example: sake dev/tasks/SubsiteCopyPagesTask from=<subsite-source> to=<subsite-target>
*/
class SubsiteCopyPagesTask extends BuildTask {
class SubsiteCopyPagesTask extends BuildTask
{
protected $title = 'Copy pages to different subsite';
protected $description = '';
function run($request) {
public function run($request)
{
$subsiteFromId = $request->getVar('from');
if(!is_numeric($subsiteFromId)) throw new InvalidArgumentException('Missing "from" parameter');
if (!is_numeric($subsiteFromId)) {
throw new InvalidArgumentException('Missing "from" parameter');
}
$subsiteFrom = DataObject::get_by_id('Subsite', $subsiteFromId);
if(!$subsiteFrom) throw new InvalidArgumentException('Subsite not found');
if (!$subsiteFrom) {
throw new InvalidArgumentException('Subsite not found');
}
$subsiteToId = $request->getVar('to');
if(!is_numeric($subsiteToId)) throw new InvalidArgumentException('Missing "to" parameter');
if (!is_numeric($subsiteToId)) {
throw new InvalidArgumentException('Missing "to" parameter');
}
$subsiteTo = DataObject::get_by_id('Subsite', $subsiteToId);
if(!$subsiteTo) throw new InvalidArgumentException('Subsite not found');
if (!$subsiteTo) {
throw new InvalidArgumentException('Subsite not found');
}
$useVirtualPages = (bool)$request->getVar('virtual');
@ -61,7 +70,8 @@ class SubsiteCopyPagesTask extends BuildTask {
}
}
function log($msg) {
public function log($msg)
{
echo $msg . "\n";
}
}

14
tests/BaseSubsiteTest.php
View File

@ -1,7 +1,8 @@
<?php
class BaseSubsiteTest extends SapphireTest {
function setUp() {
class BaseSubsiteTest extends SapphireTest
{
public function setUp()
{
parent::setUp();
Subsite::$use_session_subsiteid = true;
@ -10,7 +11,8 @@ class BaseSubsiteTest extends SapphireTest {
/**
* Avoid subsites filtering on fixture fetching.
*/
function objFromFixture($class, $id) {
public function objFromFixture($class, $id)
{
Subsite::disable_subsite_filter(true);
$obj = parent::objFromFixture($class, $id);
Subsite::disable_subsite_filter(false);
@ -21,8 +23,8 @@ class BaseSubsiteTest extends SapphireTest {
/**
* Tests the initial state of disable_subsite_filter
*/
function testDisableSubsiteFilter() {
public function testDisableSubsiteFilter()
{
$this->assertFalse(Subsite::$disable_subsite_filter);
}
}

15
tests/FileSubsitesTest.php
View File

@ -1,9 +1,11 @@
<?php
class FileSubsitesTest extends BaseSubsiteTest {
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
class FileSubsitesTest extends BaseSubsiteTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
function testTrivialFeatures() {
public function testTrivialFeatures()
{
$this->assertTrue(is_array(singleton('FileSubsites')->extraStatics()));
$file = new File();
$file->Name = 'FileTitle';
@ -16,7 +18,8 @@ class FileSubsitesTest extends BaseSubsiteTest {
$this->assertEquals($file->cacheKeyComponent(), 'subsite-1');
}
function testWritingSubsiteID() {
public function testWritingSubsiteID()
{
$this->objFromFixture('Member', 'admin')->logIn();
$subsite = $this->objFromFixture('Subsite', 'domaintest1');
@ -54,7 +57,8 @@ class FileSubsitesTest extends BaseSubsiteTest {
$this->assertEquals($folder->SubsiteID, $file->SubsiteID);
}
function testSubsitesFolderDropdown() {
public function testSubsitesFolderDropdown()
{
$this->objFromFixture('Member', 'admin')->logIn();
$file = new Folder();
@ -72,5 +76,4 @@ class FileSubsitesTest extends BaseSubsiteTest {
'Test 3'
), $source);
}
}

11
tests/GroupSubsitesTest.php
View File

@ -1,17 +1,20 @@
<?php
class GroupSubsitesTest extends BaseSubsiteTest {
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
class GroupSubsitesTest extends BaseSubsiteTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
protected $requireDefaultRecordsFrom = array('GroupSubsites');
function testTrivialFeatures() {
public function testTrivialFeatures()
{
$this->assertTrue(is_array(singleton('GroupSubsites')->extraStatics()));
$this->assertTrue(is_array(singleton('GroupSubsites')->providePermissions()));
$this->assertTrue(singleton('Group')->getCMSFields() instanceof FieldList);
}
function testAlternateTreeTitle() {
public function testAlternateTreeTitle()
{
$group = new Group();
$group->Title = 'The A Team';
$group->AccessAllSubsites = true;

20
tests/LeftAndMainSubsitesTest.php
View File

@ -1,13 +1,14 @@
<?php
class LeftAndMainSubsitesTest extends FunctionalTest {
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
class LeftAndMainSubsitesTest extends FunctionalTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
/**
* Avoid subsites filtering on fixture fetching.
*/
function objFromFixture($class, $id) {
public function objFromFixture($class, $id)
{
Subsite::disable_subsite_filter(true);
$obj = parent::objFromFixture($class, $id);
Subsite::disable_subsite_filter(false);
@ -15,7 +16,8 @@ class LeftAndMainSubsitesTest extends FunctionalTest {
return $obj;
}
function testSectionSites() {
public function testSectionSites()
{
$member = $this->objFromFixture('Member', 'subsite1member');
$cmsmain = singleton('CMSMain');
@ -37,7 +39,8 @@ class LeftAndMainSubsitesTest extends FunctionalTest {
), $subsites, 'Includes the main site for members who can access all sites.');
}
function testAccessChecksDontChangeCurrentSubsite() {
public function testAccessChecksDontChangeCurrentSubsite()
{
$admin = $this->objFromFixture("Member", "admin");
$this->loginAs($admin);
$ids = array();
@ -63,10 +66,10 @@ class LeftAndMainSubsitesTest extends FunctionalTest {
$this->assertEquals($id, Subsite::currentSubsiteID(),
"The current subsite has not been changed in the process of checking permissions for admin user.");
}
}
function testShouldChangeSubsite() {
public function testShouldChangeSubsite()
{
$l = new LeftAndMain();
Config::inst()->nest();
@ -84,5 +87,4 @@ class LeftAndMainSubsitesTest extends FunctionalTest {
Config::inst()->unnest();
}
}

9
tests/SiteConfigSubsitesTest.php
View File

@ -1,9 +1,11 @@
<?php
class SiteConfigSubsitesTest extends BaseSubsiteTest {
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
class SiteConfigSubsitesTest extends BaseSubsiteTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
function testEachSubsiteHasAUniqueSiteConfig() {
public function testEachSubsiteHasAUniqueSiteConfig()
{
$subsite1 = $this->objFromFixture('Subsite', 'domaintest1');
$subsite2 = $this->objFromFixture('Subsite', 'domaintest2');
@ -34,5 +36,4 @@ class SiteConfigSubsitesTest extends BaseSubsiteTest {
$keys = SiteConfig::current_site_config()->extend('cacheKeyComponent');
$this->assertContains('subsite-' . $subsite2->ID, $keys);
}
}

36
tests/SiteTreeSubsitesTest.php
View File

@ -1,8 +1,8 @@
<?php
class SiteTreeSubsitesTest extends BaseSubsiteTest {
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
class SiteTreeSubsitesTest extends BaseSubsiteTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
protected $extraDataObjects = array(
'SiteTreeSubsitesTest_ClassA',
@ -13,7 +13,8 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
'SiteTree' => array('Translatable')
);
function testPagesInDifferentSubsitesCanShareURLSegment() {
public function testPagesInDifferentSubsitesCanShareURLSegment()
{
$subsiteMain = $this->objFromFixture('Subsite', 'main');
$subsite1 = $this->objFromFixture('Subsite', 'subsite1');
@ -43,7 +44,8 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
);
}
function testBasicSanity() {
public function testBasicSanity()
{
$this->assertTrue(singleton('SiteTree')->getSiteConfig() instanceof SiteConfig);
// The following assert is breaking in Translatable.
$this->assertTrue(singleton('SiteTree')->getCMSFields() instanceof FieldList);
@ -51,7 +53,8 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
$this->assertTrue(is_array(singleton('SiteTreeSubsites')->extraStatics()));
}
function testErrorPageLocations() {
public function testErrorPageLocations()
{
$subsite1 = $this->objFromFixture('Subsite', 'domaintest1');
Subsite::changeSubsite($subsite1->ID);
@ -62,7 +65,8 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
$this->assertEquals($expected_path, $path);
}
function testCanEditSiteTree() {
public function testCanEditSiteTree()
{
$admin = $this->objFromFixture('Member', 'admin');
$subsite1member = $this->objFromFixture('Member', 'subsite1member');
$subsite2member = $this->objFromFixture('Member', 'subsite2member');
@ -105,7 +109,8 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
/**
* Similar to {@link SubsitesVirtualPageTest->testSubsiteVirtualPageCanHaveSameUrlsegmentAsOtherSubsite()}.
*/
function testTwoPagesWithSameURLOnDifferentSubsites() {
public function testTwoPagesWithSameURLOnDifferentSubsites()
{
// Set up a couple of pages with the same URL on different subsites
$s1 = $this->objFromFixture('Subsite', 'domaintest1');
$s2 = $this->objFromFixture('Subsite', 'domaintest2');
@ -132,7 +137,8 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
$this->assertEquals($p2->ID, SiteTree::get_by_link('test-page')->ID);
}
function testPageTypesBlacklistInClassDropdown() {
public function testPageTypesBlacklistInClassDropdown()
{
$editor = $this->objFromFixture('Member', 'editor');
Session::set("loggedInAs", $editor->ID);
@ -169,7 +175,8 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
);
}
function testPageTypesBlacklistInCMSMain() {
public function testPageTypesBlacklistInCMSMain()
{
$editor = $this->objFromFixture('Member', 'editor');
Session::set("loggedInAs", $editor->ID);
@ -195,9 +202,12 @@ class SiteTreeSubsitesTest extends BaseSubsiteTest {
$this->assertNotContains('SiteTreeSubsitesTest_ClassA', $classes);
$this->assertNotContains('SiteTreeSubsitesTest_ClassB', $classes);
}
}
class SiteTreeSubsitesTest_ClassA extends SiteTree implements TestOnly {}
class SiteTreeSubsitesTest_ClassA extends SiteTree implements TestOnly
{
}
class SiteTreeSubsitesTest_ClassB extends SiteTree implements TestOnly {}
class SiteTreeSubsitesTest_ClassB extends SiteTree implements TestOnly
{
}

25
tests/SubsiteAdminFunctionalTest.php
View File

@ -1,15 +1,17 @@
<?php
class SubsiteAdminFunctionalTest extends FunctionalTest {
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
static $use_draft_site = true;
class SubsiteAdminFunctionalTest extends FunctionalTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
public static $use_draft_site = true;
protected $autoFollowRedirection = false;
/**
* Helper: FunctionalTest is only able to follow redirection once, we want to go all the way.
*/
function getAndFollowAll($url) {
public function getAndFollowAll($url)
{
$response = $this->get($url);
while ($location = $response->getHeader('Location')) {
$response = $this->mainSession->followRedirection();
@ -22,7 +24,8 @@ class SubsiteAdminFunctionalTest extends FunctionalTest {
/**
* Anonymous user cannot access anything.
*/
function testAnonymousIsForbiddenAdminAccess() {
public function testAnonymousIsForbiddenAdminAccess()
{
$response = $this->getAndFollowAll('admin/pages/?SubsiteID=0');
$this->assertRegExp('#^Security/login.*#', $this->mainSession->lastUrl(), 'Admin is disallowed');
@ -38,7 +41,8 @@ class SubsiteAdminFunctionalTest extends FunctionalTest {
/**
* Admin should be able to access all subsites and the main site
*/
function testAdminCanAccessAllSubsites() {
public function testAdminCanAccessAllSubsites()
{
$member = $this->objFromFixture('Member', 'admin');
Session::set("loggedInAs", $member->ID);
@ -56,7 +60,8 @@ class SubsiteAdminFunctionalTest extends FunctionalTest {
'SubsiteXHRController is reachable');
}
function testAdminIsRedirectedToObjectsSubsite() {
public function testAdminIsRedirectedToObjectsSubsite()
{
$member = $this->objFromFixture('Member', 'admin');
Session::set("loggedInAs", $member->ID);
@ -88,7 +93,8 @@ class SubsiteAdminFunctionalTest extends FunctionalTest {
* User which has AccessAllSubsites set to 1 should be able to access all subsites and main site,
* even though he does not have the ADMIN permission.
*/
function testEditorCanAccessAllSubsites() {
public function testEditorCanAccessAllSubsites()
{
$member = $this->objFromFixture('Member', 'editor');
Session::set("loggedInAs", $member->ID);
@ -109,7 +115,8 @@ class SubsiteAdminFunctionalTest extends FunctionalTest {
/**
* Test a member who only has access to one subsite (subsite1) and only some sections (pages and security).
*/
function testSubsiteAdmin() {
public function testSubsiteAdmin()
{
$member = $this->objFromFixture('Member', 'subsite1member');
Session::set("loggedInAs", $member->ID);

17
tests/SubsiteAdminTest.php
View File

@ -1,9 +1,11 @@
<?php
class SubsiteAdminTest extends BaseSubsiteTest {
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
class SubsiteAdminTest extends BaseSubsiteTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
function adminLoggedInSession() {
public function adminLoggedInSession()
{
return new Session(array(
'loggedInAs' => $this->idFromFixture('Member', 'admin')
));
@ -12,7 +14,8 @@ class SubsiteAdminTest extends BaseSubsiteTest {
/**
* Test generation of the view
*/
function testBasicView() {
public function testBasicView()
{
Subsite::$write_hostmap = false;
$subsite1ID = $this->objFromFixture('Subsite', 'domaintest1')->ID;
@ -30,7 +33,8 @@ class SubsiteAdminTest extends BaseSubsiteTest {
* Test that the main-site user with ADMIN permissions can access all subsites, regardless
* of whether he is in a subsite-specific group or not.
*/
function testMainsiteAdminCanAccessAllSubsites() {
public function testMainsiteAdminCanAccessAllSubsites()
{
$member = $this->objFromFixture('Member', 'admin');
Session::set("loggedInAs", $member->ID);
@ -44,7 +48,4 @@ class SubsiteAdminTest extends BaseSubsiteTest {
$this->assertArrayHasKey($this->idFromFixture('Subsite', 'subsite1'), $ids, "Subsite1 Template inaccessible");
$this->assertArrayHasKey($this->idFromFixture('Subsite', 'subsite2'), $ids, "Subsite2 Template inaccessible");
}
}

60
tests/SubsiteTest.php
View File

@ -1,17 +1,19 @@
<?php
class SubsiteTest extends BaseSubsiteTest {
class SubsiteTest extends BaseSubsiteTest
{
public static $fixture_file = 'subsites/tests/SubsiteTest.yml';
static $fixture_file = 'subsites/tests/SubsiteTest.yml';
function setUp() {
public function setUp()
{
parent::setUp();
$this->origStrictSubdomainMatching = Subsite::$strict_subdomain_matching;
Subsite::$strict_subdomain_matching = false;
}
function tearDown() {
public function tearDown()
{
parent::tearDown();
Subsite::$strict_subdomain_matching = $this->origStrictSubdomainMatching;
@ -20,7 +22,8 @@ class SubsiteTest extends BaseSubsiteTest {
/**
* Create a new subsite from the template and verify that all the template's pages are copied
*/
function testSubsiteCreation() {
public function testSubsiteCreation()
{
Subsite::$write_hostmap = false;
// Create the instance
@ -60,10 +63,15 @@ class SubsiteTest extends BaseSubsiteTest {
/**
* Confirm that domain lookup is working
*/
function testDomainLookup() {
public function testDomainLookup()
{
// Clear existing fixtures
foreach(DataObject::get('Subsite') as $subsite) $subsite->delete();
foreach(DataObject::get('SubsiteDomain') as $domain) $domain->delete();
foreach (DataObject::get('Subsite') as $subsite) {
$subsite->delete();
}
foreach (DataObject::get('SubsiteDomain') as $domain) {
$domain->delete();
}
// Much more expressive than YML in this case
$subsite1 = $this->createSubsiteWithDomains(array(
@ -127,13 +135,17 @@ class SubsiteTest extends BaseSubsiteTest {
Subsite::getSubsiteIDForDomain('unknown.madeup.com'),
"Doesn't match unknown subsite"
);
}
function testStrictSubdomainMatching() {
public function testStrictSubdomainMatching()
{
// Clear existing fixtures
foreach(DataObject::get('Subsite') as $subsite) $subsite->delete();
foreach(DataObject::get('SubsiteDomain') as $domain) $domain->delete();
foreach (DataObject::get('Subsite') as $subsite) {
$subsite->delete();
}
foreach (DataObject::get('SubsiteDomain') as $domain) {
$domain->delete();
}
// Much more expressive than YML in this case
$subsite1 = $this->createSubsiteWithDomains(array(
@ -196,10 +208,10 @@ class SubsiteTest extends BaseSubsiteTest {
$failed,
'Fails on multiple matches with strict checking and wildcard vs. www'
);
}
protected function createSubsiteWithDomains($domains) {
protected function createSubsiteWithDomains($domains)
{
$subsite = new Subsite(array(
'Title' => 'My Subsite'
));
@ -219,7 +231,8 @@ class SubsiteTest extends BaseSubsiteTest {
/**
* Test the Subsite->domain() method
*/
function testDefaultDomain() {
public function testDefaultDomain()
{
$this->assertEquals('one.example.org',
$this->objFromFixture('Subsite', 'domaintest1')->domain());
@ -242,7 +255,8 @@ class SubsiteTest extends BaseSubsiteTest {
$_SERVER['HTTP_HOST'] = $originalHTTPHost;
}
function testAllSites() {
public function testAllSites()
{
$subsites = Subsite::all_sites();
$this->assertDOSEquals(array(
array('Title' =>'Main site'),
@ -255,7 +269,8 @@ class SubsiteTest extends BaseSubsiteTest {
), $subsites, 'Lists all subsites');
}
function testAllAccessibleSites() {
public function testAllAccessibleSites()
{
$member = $this->objFromFixture('Member', 'subsite1member');
$subsites = Subsite::all_accessible_sites(true, 'Main site', $member);
@ -267,7 +282,8 @@ class SubsiteTest extends BaseSubsiteTest {
/**
* Test Subsite::accessible_sites()
*/
function testAccessibleSites() {
public function testAccessibleSites()
{
$member1Sites = Subsite::accessible_sites("CMS_ACCESS_CMSMain", false, null,
$this->objFromFixture('Member', 'subsite1member'));
$member1SiteTitles = $member1Sites->column("Title");
@ -294,7 +310,8 @@ class SubsiteTest extends BaseSubsiteTest {
$this->assertEquals('Subsite1 Template', $member2SiteTitles[0], 'Member can get to subsite via a group role');
}
function testhasMainSitePermission() {
public function testhasMainSitePermission()
{
$admin = $this->objFromFixture('Member', 'admin');
$subsite1member = $this->objFromFixture('Member', 'subsite1member');
$subsite1admin = $this->objFromFixture('Member', 'subsite1admin');
@ -334,7 +351,8 @@ class SubsiteTest extends BaseSubsiteTest {
);
}
function testDuplicateSubsite() {
public function testDuplicateSubsite()
{
// get subsite1 & create page
$subsite1 = $this->objFromFixture('Subsite', 'domaintest1');
$subsite1->activate();

40
tests/SubsitesVirtualPageTest.php
View File

@ -1,12 +1,14 @@
<?php
class SubsitesVirtualPageTest extends BaseSubsiteTest {
static $fixture_file = array(
class SubsitesVirtualPageTest extends BaseSubsiteTest
{
public static $fixture_file = array(
'subsites/tests/SubsiteTest.yml',
'subsites/tests/SubsitesVirtualPageTest.yml',
);
function setUp() {
public function setUp()
{
parent::setUp();
$this->logInWithPermission('ADMIN');
@ -15,7 +17,8 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
fclose($fh);
}
function tearDown() {
public function tearDown()
{
parent::tearDown();
$testFiles = array(
'/assets/testscript-test-file.pdf',
@ -23,12 +26,15 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
'/assets/renamed-test-file-second-time.pdf',
);
foreach ($testFiles as $file) {
if(file_exists(Director::baseFolder().$file)) unlink(Director::baseFolder().$file);
if (file_exists(Director::baseFolder().$file)) {
unlink(Director::baseFolder().$file);
}
}
}
// Attempt to bring main:linky to subsite2:linky
function testVirtualPageFromAnotherSubsite() {
public function testVirtualPageFromAnotherSubsite()
{
Subsite::$write_hostmap = false;
$subsite = $this->objFromFixture('Subsite', 'subsite2');
@ -49,7 +55,8 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
$this->assertEquals($svp->Title, $linky->Title);
}
function testFileLinkRewritingOnVirtualPages() {
public function testFileLinkRewritingOnVirtualPages()
{
// File setup
$this->logInWithPermission('ADMIN');
touch(Director::baseFolder() . '/assets/testscript-test-file.pdf');
@ -81,11 +88,14 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
'/assets/renamed-test-file.pdf',
);
foreach ($testFiles as $file) {
if(file_exists(Director::baseFolder().$file)) unlink(Director::baseFolder().$file);
if (file_exists(Director::baseFolder().$file)) {
unlink(Director::baseFolder().$file);
}
}
}
function testSubsiteVirtualPagesArentInappropriatelyPublished() {
public function testSubsiteVirtualPagesArentInappropriatelyPublished()
{
// Fixture
$p = new Page();
$p->Content = "test content";
@ -143,7 +153,7 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
* is in a different subsite to the page you are editing and republishing,
* otherwise the test will pass falsely due to current subsite ID being the same.
*/
function testPublishedSubsiteVirtualPagesUpdateIfTargetPageUpdates()
public function testPublishedSubsiteVirtualPagesUpdateIfTargetPageUpdates()
{
// create page
$p = new Page();
@ -185,7 +195,8 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
$this->assertEquals($svpdb->Title, $p->Title);
}
function testUnpublishingParentPageUnpublishesSubsiteVirtualPages() {
public function testUnpublishingParentPageUnpublishesSubsiteVirtualPages()
{
Config::inst()->update('StaticPublisher', 'disable_realtime', true);
// Go to main site, get parent page
@ -228,7 +239,8 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
* Similar to {@link SiteTreeSubsitesTest->testTwoPagesWithSameURLOnDifferentSubsites()}
* and {@link SiteTreeSubsitesTest->testPagesInDifferentSubsitesCanShareURLSegment()}.
*/
function testSubsiteVirtualPageCanHaveSameUrlsegmentAsOtherSubsite() {
public function testSubsiteVirtualPageCanHaveSameUrlsegmentAsOtherSubsite()
{
Subsite::$write_hostmap = false;
$subsite1 = $this->objFromFixture('Subsite', 'subsite1');
$subsite2 = $this->objFromFixture('Subsite', 'subsite2');
@ -265,12 +277,12 @@ class SubsitesVirtualPageTest extends BaseSubsiteTest {
);
}
function fixVersionNumberCache($page) {
public function fixVersionNumberCache($page)
{
$pages = func_get_args();
foreach ($pages as $p) {
Versioned::prepopulate_versionnumber_cache('SiteTree', 'Stage', array($p->ID));
Versioned::prepopulate_versionnumber_cache('SiteTree', 'Live', array($p->ID));
}
}
}

38
tests/behat/features/bootstrap/Context/FeatureContext.php
View File

@ -2,15 +2,17 @@
namespace Subsites\Test\Behaviour;
if(!class_exists('SilverStripe\BehatExtension\Context\SilverStripeContext')) return;
if (!class_exists('SilverStripe\BehatExtension\Context\SilverStripeContext')) {
return;
}
use SilverStripe\BehatExtension\Context\SilverStripeContext,
SilverStripe\BehatExtension\Context\BasicContext,
SilverStripe\BehatExtension\Context\LoginContext,
SilverStripe\BehatExtension\Context\FixtureContext,
SilverStripe\Framework\Test\Behaviour\CmsFormsContext,
SilverStripe\Framework\Test\Behaviour\CmsUiContext,
SilverStripe\Cms\Test\Behaviour;
use SilverStripe\BehatExtension\Context\SilverStripeContext;
use SilverStripe\BehatExtension\Context\BasicContext;
use SilverStripe\BehatExtension\Context\LoginContext;
use SilverStripe\BehatExtension\Context\FixtureContext;
use SilverStripe\Framework\Test\Behaviour\CmsFormsContext;
use SilverStripe\Framework\Test\Behaviour\CmsUiContext;
use SilverStripe\Cms\Test\Behaviour;
// PHPUnit
require_once 'PHPUnit/Autoload.php';
@ -22,8 +24,8 @@ require_once 'PHPUnit/Framework/Assert/Functions.php';
* Context automatically loaded by Behat.
* Uses subcontexts to extend functionality.
*/
class FeatureContext extends SilverStripeContext {
class FeatureContext extends SilverStripeContext
{
/**
* @var FixtureFactory
*/
@ -35,7 +37,8 @@ class FeatureContext extends SilverStripeContext {
*
* @param array $parameters context parameters (set them up through behat.yml)
*/
public function __construct(array $parameters) {
public function __construct(array $parameters)
{
parent::__construct($parameters);
$this->useContext('BasicContext', new BasicContext($parameters));
@ -51,7 +54,9 @@ class FeatureContext extends SilverStripeContext {
$factory = $fixtureContext->getFixtureFactory();
$blueprint = \Injector::inst()->create('FixtureBlueprint', 'Member');
$blueprint->addCallback('beforeCreate', function ($identifier, &$data, &$fixtures) {
if(!isset($data['FirstName'])) $data['FirstName'] = $identifier;
if (!isset($data['FirstName'])) {
$data['FirstName'] = $identifier;
}
});
$factory->define('Member', $blueprint);
@ -65,7 +70,8 @@ class FeatureContext extends SilverStripeContext {
}
}
public function setMinkParameters(array $parameters) {
public function setMinkParameters(array $parameters)
{
parent::setMinkParameters($parameters);
if (isset($parameters['files_path'])) {
@ -76,7 +82,8 @@ class FeatureContext extends SilverStripeContext {
/**
* @return FixtureFactory
*/
public function getFixtureFactory() {
public function getFixtureFactory()
{
if (!$this->fixtureFactory) {
$this->fixtureFactory = \Injector::inst()->create('BehatFixtureFactory');
}
@ -84,7 +91,8 @@ class FeatureContext extends SilverStripeContext {
return $this->fixtureFactory;
}
public function setFixtureFactory(FixtureFactory $factory) {
public function setFixtureFactory(FixtureFactory $factory)
{
$this->fixtureFactory = $factory;
}