Source of file SiteTreeExtension.php
Size: 11,627 Bytes - Last Modified: 2021-12-23T10:04:53+00:00
/var/www/docs.ssmods.com/process/src/code/Extensions/SiteTreeExtension.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346 | <?php namespace AirNZ\SimpleSubsites\Extensions; use AirNZ\SimpleSubsites\Model\Subsite; use SilverStripe\CMS\Model\SiteTree; use SilverStripe\Control\Controller; use SilverStripe\Control\Director; use SilverStripe\Control\HTTP; use SilverStripe\Core\Config\Config; use SilverStripe\Core\Convert; use SilverStripe\Forms\DropdownField; use SilverStripe\Forms\FieldList; use SilverStripe\Forms\InlineFormAction; use SilverStripe\ORM\DataExtension; use SilverStripe\ORM\DataObject; use SilverStripe\ORM\DataQuery; use SilverStripe\ORM\Queries\SQLSelect; use SilverStripe\Security\Member; use SilverStripe\Security\Permission; use SilverStripe\Security\Security; use SilverStripe\SiteConfig\SiteConfig; /** * Extension for the SiteTree object to add subsites support */ class SiteTreeExtension extends DataExtension { private static $has_one = [ 'Subsite' => Subsite::class, // The subsite that this page belongs to ]; private static $many_many = [ 'CrossSubsiteLinkTracking' => SiteTree::class, // Stored separately, as the logic for URL rewriting is different ]; private static $many_many_extraFields = [ "CrossSubsiteLinkTracking" => ["FieldName" => "Varchar"] ]; private static $indexes = [ 'ClassNameSubsite' => ['ClassName', 'SubsiteID'], 'ParentSubsite' => ['ParentID', 'SubsiteID'], ]; /** * Update any requests to limit the results to the current site */ public function augmentSQL(SQLSelect $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 (Subsite::$force_subsite) { $subsiteID = Subsite::$force_subsite; } else { /*if ($context = DataObject::context_obj()) $subsiteID = (int)$context->SubsiteID; else */$subsiteID = (int)Subsite::currentSubsiteID(); } // 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... /** @skipUpgrade */ if (strpos($tableName, 'SiteTree') === false) { break; } $query->addWhere("\"$tableName\".\"SubsiteID\" IN ($subsiteID)"); break; } } public function onBeforeWrite() { if (!$this->owner->ID && !$this->owner->SubsiteID && Subsite::currentSubsiteID()) { $this->owner->SubsiteID = Subsite::currentSubsiteID(); } parent::onBeforeWrite(); } public function updateCMSFields(FieldList $fields) { // replace readonly link prefix $subsite = $this->owner->Subsite(); $nested_urls_enabled = Config::inst()->get('SilverStripe\\CMS\\Model\\SiteTree', 'nested_urls'); if ($subsite && $subsite->exists()) { // Use baseurl from domain $baseLink = $subsite->absoluteBaseURL(); // Add parent page if enabled if ($nested_urls_enabled && $this->owner->ParentID) { $baseLink = Controller::join_links( $baseLink, $this->owner->Parent()->RelativeLink(true) ); } $urlsegment = $fields->dataFieldByName('URLSegment'); if ($urlsegment) { $urlsegment->setURLPrefix($baseLink); } } } public function alternateSiteConfig() { if (!$this->owner->SubsiteID) { return false; } $sc = DataObject::get_one('SilverStripe\\SiteConfig\\SiteConfig', '"SubsiteID" = ' . $this->owner->SubsiteID); if (!$sc) { $sc = new SiteConfig(); $sc->SubsiteID = $this->owner->SubsiteID; $sc->Title = _t('Subsite.SiteConfigTitle', 'Your Site Name'); $sc->Tagline = _t('Subsite.SiteConfigSubtitle', 'Your tagline here'); $sc->write(); } return $sc; } /** * Only allow editing of a page if the member satisfies one of the following conditions: * - Is in a group which has access to the subsite this page belongs to * - Is in a group with edit permissions on the "main site" * * @return boolean */ public function canEdit($member = null) { if (Subsite::$disable_subsite_filter) { return; } if (!$member) { $member = Security::getCurrentUser(); } if (Permission::checkMember($member, "ADMIN")) { return; } if (!is_null($this->owner->SubsiteID)) { $subsiteID = $this->owner->SubsiteID; } else { // The relationships might not be available during the record creation when using a GridField. // In this case the related objects will have empty fields, and SubsiteID will not be available. // // We do the second best: fetch the likely SubsiteID from the session. The drawback is this might // make it possible to force relations to point to other (forbidden) subsites. $subsiteID = Subsite::currentSubsiteID(); } // Find the sites that this user has access to $goodSites = Subsite::accessible_sites_ids('SITETREE_EDIT_ALL', $member); // Return true if they have access to this object's site if (!(in_array(0, $goodSites) || in_array($subsiteID, $goodSites))) { return false; } } /** * @return boolean */ public function canCreate($member = null, $context = []) { if (!$member && $member !== false) { $member = Security::getCurrentUser(); } if ($this->canEdit($member) === false) { return false; } } /** * @return boolean */ public function canDelete($member = null) { if (!$member && $member !== false) { $member = Security::getCurrentUser(); } return $this->canEdit($member); } /** * @return boolean */ public function canAddChildren($member = null) { if (!$member && $member !== false) { $member = Security::getCurrentUser(); } return $this->canEdit($member); } /** * @return boolean */ public function canPublish($member = null) { if (!$member && $member !== false) { $member = Security::getCurrentUser(); } return $this->canEdit($member); } /** * Does the basic duplication, but doesn't write anything * this means we can subclass this easier and do more complex * relation duplication. */ public function duplicateToSubsitePrep($subsiteID) { if (is_object($subsiteID)) { $subsiteID = $subsiteID->ID; } $oldSubsite = Subsite::currentSubsiteID(); if ($subsiteID) { Subsite::changeSubsite($subsiteID); } else { $subsiteID = $oldSubsite; } // doesn't write as we need to reset the SubsiteID, ParentID etc $clone = $this->owner->duplicate(false); $clone->CheckedPublicationDifferences = $clone->AddedToStage = true; $subsiteID = ($subsiteID ? $subsiteID : $oldSubsite); $clone->SubsiteID = $subsiteID; // We have no idea what the parentID should be, so as a workaround use the url-segment and subsite ID if ($this->owner->Parent()) { $parentSeg = $this->owner->Parent()->URLSegment; $newParentPage = SiteTree::get()->filter('URLSegment', $parentSeg)->first(); if ($newParentPage) { $clone->ParentID = $newParentPage->ID; } else { // reset it to the top level, so the user can decide where to put it $clone->ParentID = 0; } } // MasterPageID is here for legacy purposes, to satisfy the subsites_relatedpages module $clone->MasterPageID = $this->owner->ID; return $clone; } /** * 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) { $clone = $this->owner->duplicateToSubsitePrep($subsiteID); $clone->invokeWithExtensions('onBeforeDuplicateToSubsite', $this->owner); $clone->write(); $clone->duplicateSubsiteRelations($this->owner); // new extension hooks which happens after write, // onAfterDuplicate isn't reliable due to // https://github.com/silverstripe/silverstripe-cms/issues/1253 $clone->invokeWithExtensions('onAfterDuplicateToSubsite', $this->owner); return $clone; } /** * Duplicate relations using a static property to define * which ones we want to duplicate * * It may be that some relations are not diostinct to sub site so can stay * whereas others may need to be duplicated * */ public function duplicateSubsiteRelations($originalPage) { $thisClass = $originalPage->ClassName; $relations = Config::inst()->get($thisClass, 'duplicate_to_subsite_relations'); if ($relations && !empty($relations)) { foreach ($relations as $relation) { $items = $originalPage->$relation(); foreach ($items as $item) { $duplicateItem = $item->duplicate(false); $duplicateItem->{$thisClass.'ID'} = $this->owner->ID; $duplicateItem->write(); } } } } 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()); if ($this->owner->SubsiteID) { $url = preg_replace('/\/\/[^\/]+\//', '//' . $this->owner->Subsite()->Domain . '/', $url); } return $url; } /** * Use the CMS domain for iframed CMS previews to prevent single-origin violations * and SSL cert problems. */ public function updatePreviewLink($link, $action = null) { $url = Director::absoluteURL($this->owner->Link()); if ($this->owner->SubsiteID) { $url = HTTP::setGetVar('SubsiteID', $this->owner->SubsiteID, $url); } return $url; } /** * Inject the subsite ID into the content so it can be used by frontend scripts. */ public function MetaTags(&$tags) { if ($this->owner->SubsiteID) { $tags .= "<meta name=\"x-subsite-id\" content=\"" . $this->owner->SubsiteID . "\" />\n"; } return $tags; } /** * Return a piece of text to keep DataObject cache keys appropriately specific */ public function cacheKeyComponent() { return 'subsite-'.Subsite::currentSubsiteID(true); } } |