Nexcessnet_Turpentine_EsiController::_getRequestSourceUrl() - Code Metrics - Inspection of "Don't use HTTP_REFERER for Dummy_Request to preven..." - nexcess/magento-turpentine - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1233)

unknown

created 2016-07-20 16:30 UTC

_getRequestSourceUrl() A

↳ Parent: Nexcessnet_Turpentine_EsiController

Complexity

Conditions	4
Paths	4

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
rs	9.2
cc	4
eloc	7
nc	4
nop	0

<?php

/**
 * Nexcess.net Turpentine Extension for Magento
 * Copyright (C) 2012  Nexcess.net L.L.C.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

class Nexcessnet_Turpentine_EsiController extends Mage_Core_Controller_Front_Action {
namespace YourVendor;

class YourClass { }
    /**
     * It seems this has to exist so we just make it redirect to the base URL
     * for lack of anything better to do.
     *
     * @return null
     */
    public function indexAction() {
        $this->getResponse()->setRedirect(Mage::getBaseUrl());
    }

    /**
     * Spit out the form key for this session
     *
     * @return null
     */
    public function getFormKeyAction() {
        $resp = $this->getResponse();
        $resp->setBody(
            Mage::getSingleton('core/session')->real_getFormKey() );
        $resp->setHeader('X-Turpentine-Cache', '1');
        $resp->setHeader('X-Turpentine-Flush-Events',
            implode(',', Mage::helper('turpentine/esi')
                ->getDefaultCacheClearEvents()));
        $resp->setHeader('X-Turpentine-Block', 'form_key');
        Mage::register('turpentine_nocache_flag', false, true);

        Mage::helper('turpentine/debug')->logDebug('Generated form_key: %s',
            $resp->getBody());
    }

    /**
     * Spit out the rendered block from the URL-encoded data
     *
     * @return null
     */
    public function getBlockAction() {
        $resp = $this->getResponse();
        $cacheFlag = false;
        if (Mage::helper('turpentine/esi')->shouldResponseUseEsi()) {
            $req = $this->getRequest();
            $esiHelper = Mage::helper('turpentine/esi');
            $dataHelper = Mage::helper('turpentine/data');
            $debugHelper = Mage::helper('turpentine/debug');
            $esiDataHmac = $req->getParam($esiHelper->getEsiHmacParam());
            $esiDataParamValue = $req->getParam($esiHelper->getEsiDataParam());
            if ($esiDataHmac !== ($hmac = $dataHelper->getHmac($esiDataParamValue))) {
                $debugHelper->logWarn('ESI data HMAC mismatch, expected (%s) but received (%s)',
                    $hmac, $esiDataHmac);
                $resp->setHttpResponseCode(500);
                $resp->setBody('ESI data is not valid');
            } elseif ( ! ($esiDataArray = $dataHelper->thaw($esiDataParamValue))) {
                $debugHelper->logWarn('Invalid ESI data in URL: %s',
                    $esiDataParamValue);
                $resp->setHttpResponseCode(500);
                $resp->setBody('ESI data is not valid');
            } elseif ( ! $esiHelper->getEsiDebugEnabled() &&
                    $esiDataArray['esi_method'] !==
                    $req->getParam($esiHelper->getEsiMethodParam())) {
                $resp->setHttpResponseCode(403);
                $resp->setBody('ESI method mismatch');
                $debugHelper->logWarn('Blocking change of ESI method: %s -> %s',
                    $esiDataArray['esi_method'],
                    $req->getParam($esiHelper->getEsiMethodParam()));
            } else {
                $esiData = new Varien_Object($esiDataArray);
                $origRequest = Mage::app()->getRequest();
                Mage::app()->setCurrentStore(
                    Mage::app()->getStore($esiData->getStoreId()) );
                $appShim = Mage::getModel('turpentine/shim_mage_core_app');
                $dummyRequest = Mage::helper('turpentine/esi')->getDummyRequest($this->_getRequestSourceUrl());
                $appShim->shim_setRequest($dummyRequest);
                $block = $this->_getEsiBlock($esiData);
                if ($block) {
                    $blockEsiOptions = $block->getEsiOptions();
                    $block->setEsiOptions(false);
                    $resp->setBody($block->toHtml());
                    if ((int) $req->getParam($esiHelper->getEsiTtlParam()) > 0) {
                        $cacheFlag = true;
                        if (isset($blockEsiOptions['only_cache_if'])) {
                            switch ($blockEsiOptions['only_cache_if']) {
                                case 'empty':
                                    $cacheFlag = ('' === $resp->getBody());
                                    break;
                                case 'no_text':
                                    $cacheFlag = ('' === trim(strip_tags($resp->getBody())));
                                    break;
                                default:
                                    $cacheFlag = false;
                            }
                        }
                    }
                    if ($esiData->getEsiMethod() == 'ajax') {
                        $resp->setHeader('Access-Control-Allow-Origin',
                            $esiHelper->getCorsOrigin());
                    }
                    if ( ! is_null($flushEvents = $esiData->getFlushEvents())) {
                        $resp->setHeader('X-Turpentine-Flush-Events',
                            implode(',', $flushEvents));
                    }
                    if ($esiHelper->getEsiDebugEnabled()) {
                        $resp->setHeader('X-Turpentine-Block',
                            $block->getNameInLayout());
                    }
                } else {
                    $resp->setHttpResponseCode(404);
                    $resp->setBody('ESI block not found');
                }
                $appShim->shim_setRequest($origRequest);
            }
        } else {
            $resp->setHttpResponseCode(403);
            $resp->setBody('ESI includes are not enabled');
        }
        Mage::register('turpentine_nocache_flag', ! $cacheFlag, true);
    }

    /**
     * Need to disable this flag to prevent setting the last URL but we
     * don't want to completely break sessions.
     *
     * see Mage_Core_Controller_Front_Action::postDispatch
     *
     * @return null
     */
    public function postDispatch() {
        $flag = $this->getFlag('', self::FLAG_NO_START_SESSION);
        $this->setFlag('', self::FLAG_NO_START_SESSION, true);
        parent::postDispatch();
        $this->setFlag('', self::FLAG_NO_START_SESSION, $flag);
    }

    /**
     * Generate the ESI block
     *
     * @param  Varien_Object $esiData
     * @return Mage_Core_Block_Template|null
     */
    protected function _getEsiBlock($esiData) {
        $block = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        Varien_Profiler::start('turpentine::controller::esi::_getEsiBlock');
        foreach ($esiData->getSimpleRegistry() as $key => $value) {
            Mage::register($key, $value, true);
        }
        foreach ($esiData->getComplexRegistry() as $key => $data) {
            $value = Mage::getModel($data['model']);
            if ( ! is_object($value)) {
                Mage::helper('turpentine/debug')->logWarn(
                    'Failed to register key/model: %s as %s(%s)',
                    $key, $data['model'], $data['id'] );
                continue;
            } else {
                $value->load($data['id']);
                Mage::register($key, $value, true);
            }
        }
        $layout = Mage::getSingleton('core/layout');

        // dispatch event for adding handles to layout update
        Mage::dispatchEvent(
            'controller_action_layout_load_before',
            array('action'=>$this, 'layout'=>$layout)
        );

        $layoutUpdate = $layout->getUpdate();
        $layoutUpdate->load($this->_swapCustomerHandles(
            $esiData->getLayoutHandles() ));
        foreach ($esiData->getDummyBlocks() as $blockName) {
            $layout->createBlock('Mage_Core_Block_Template', $blockName);
        }

        if ( ! $this->getFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT)) {
            Mage::dispatchEvent(
                'controller_action_layout_generate_xml_before',
                array('action'=>$this, 'layout'=>$layout)
            );
        }
        $layout->generateXml();

        /** @var Nexcessnet_Turpentine_Helper_Data $turpentineHelper */
        $turpentineHelper = Mage::helper('turpentine/data')
            ->setLayout($layout);

        $blockNode = current($layout->getNode()->xpath(
                sprintf('//block[@name=\'%s\']', $esiData->getNameInLayout())
            ));

        if ( ! ($blockNode instanceof Mage_Core_Model_Layout_Element)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            Mage::helper('turpentine/debug')->logWarn(
                            'No block node found with @name="%s"',
                            $esiData->getNameInLayout() );
            return null;
        }

        $nodesToGenerate = $turpentineHelper->getChildBlockNames($blockNode);
        Mage::getModel('turpentine/shim_mage_core_layout')
            ->shim_generateFullBlock($blockNode);

        //find addional blocks that aren't defined in the <block/> but via <reference name="%s">
        $referenceNodes = $layout->getNode()->xpath(sprintf(
            '//reference[@name=\'%s\']',
            $esiData->getNameInLayout() ));
        if ($referenceNodes) {
            foreach ($referenceNodes as $referenceNode) {
                if ($referenceNode instanceof Mage_Core_Model_Layout_Element) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                    $referencesToGenerate = $turpentineHelper
                        ->getChildBlockNames($referenceNode);
                    $nodesToGenerate =
                        array_merge($nodesToGenerate, $referencesToGenerate);
                }
            }
        }

        // dispatch event for adding xml layout elements
        if ( ! $this->getFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT)) {
            Mage::dispatchEvent(
                'controller_action_layout_generate_blocks_before',
                array('action'=>$this, 'layout'=>$layout)
            );
        }

        foreach (array_unique($nodesToGenerate) as $nodeName) {
            foreach ($layout->getNode()->xpath(sprintf(
                    '//reference[@name=\'%s\']', $nodeName )) as $node) {
                $layout->generateBlocks($node);
            }
        }
        $block = $layout->getBlock($esiData->getNameInLayout());

        if ( ! $this->getFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT)) {
            Mage::dispatchEvent(
                'controller_action_layout_generate_blocks_after',
                array('action'=>$this, 'layout'=>$layout)
            );
        }

        $this->_isLayoutLoaded = true;
        Varien_Profiler::stop('turpentine::controller::esi::_getEsiBlock');
        return $block;
    }

    /**
     * Swap customer_logged_in and customer_logged_out cached handles based on
     * actual customer login status. Fixes stale Login/Logout links (and
     * probably other things).
     *
     * This is definitely a hack, need a more general solution to this problem.
     *
     * @param  array $handles
     * @return array
     */
    protected function _swapCustomerHandles($handles) {
        if (Mage::helper('customer')->isLoggedIn()) {
            $replacement = array('customer_logged_out', 'customer_logged_in');
        } else {
            $replacement = array('customer_logged_in', 'customer_logged_out');
        }
        if (($pos = array_search($replacement[0], $handles)) !== false) {
            $handles[$pos] = $replacement[1];
        }
        return $handles;
    }
    /**
     * Only rely on r64-param for DummyRequest-Url.
     *
     * Don't use the referrer (which may be bad encoded) as the DummyRequest-Url. So it is empty for any global
     * ESI-Block, as they shouldn't depend on the current url.
     *
     * @return string
     */
    protected function _getRequestSourceUrl()
    {
        $requestUrl = null;
        if ($url = $this->getRequest()->getParam(self::PARAM_NAME_BASE64_URL)) {
            $requestUrl = Mage::helper('core')->urlDecodeAndEscape($url);
        }

        if ($requestUrl && !$this->_isUrlInternal($requestUrl)) {
            $requestUrl = Mage::app()->getStore()->getBaseUrl();
        }
        return $requestUrl;
    }
}


Pull Request — master (#1233)

_getRequestSourceUrl() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			/**
4			* Nexcess.net Turpentine Extension for Magento
5			* Copyright (C) 2012 Nexcess.net L.L.C.
6			*
7			* This program is free software; you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 2 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License along
18			* with this program; if not, write to the Free Software Foundation, Inc.,
19			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20			*/
21
22			class Nexcessnet_Turpentine_EsiController extends Mage_Core_Controller_Front_Action {
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-25 14:59 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
23			/**
24			* It seems this has to exist so we just make it redirect to the base URL
25			* for lack of anything better to do.
26			*
27			* @return null
28			*/
29			public function indexAction() {
30			$this->getResponse()->setRedirect(Mage::getBaseUrl());
31			}
32
33			/**
34			* Spit out the form key for this session
35			*
36			* @return null
37			*/
38			public function getFormKeyAction() {
39			$resp = $this->getResponse();
40			$resp->setBody(
41			Mage::getSingleton('core/session')->real_getFormKey() );
42			$resp->setHeader('X-Turpentine-Cache', '1');
43			$resp->setHeader('X-Turpentine-Flush-Events',
44			implode(',', Mage::helper('turpentine/esi')
45			->getDefaultCacheClearEvents()));
46			$resp->setHeader('X-Turpentine-Block', 'form_key');
47			Mage::register('turpentine_nocache_flag', false, true);
48
49			Mage::helper('turpentine/debug')->logDebug('Generated form_key: %s',
50			$resp->getBody());
51			}
52
53			/**
54			* Spit out the rendered block from the URL-encoded data
55			*
56			* @return null
57			*/
58			public function getBlockAction() {
59			$resp = $this->getResponse();
60			$cacheFlag = false;
61			if (Mage::helper('turpentine/esi')->shouldResponseUseEsi()) {
62			$req = $this->getRequest();
63			$esiHelper = Mage::helper('turpentine/esi');
64			$dataHelper = Mage::helper('turpentine/data');
65			$debugHelper = Mage::helper('turpentine/debug');
66			$esiDataHmac = $req->getParam($esiHelper->getEsiHmacParam());
67			$esiDataParamValue = $req->getParam($esiHelper->getEsiDataParam());
68			if ($esiDataHmac !== ($hmac = $dataHelper->getHmac($esiDataParamValue))) {
69			$debugHelper->logWarn('ESI data HMAC mismatch, expected (%s) but received (%s)',
70			$hmac, $esiDataHmac);
71			$resp->setHttpResponseCode(500);
72			$resp->setBody('ESI data is not valid');
73			} elseif ( ! ($esiDataArray = $dataHelper->thaw($esiDataParamValue))) {
74			$debugHelper->logWarn('Invalid ESI data in URL: %s',
75			$esiDataParamValue);
76			$resp->setHttpResponseCode(500);
77			$resp->setBody('ESI data is not valid');
78			} elseif ( ! $esiHelper->getEsiDebugEnabled() &&
79			$esiDataArray['esi_method'] !==
80			$req->getParam($esiHelper->getEsiMethodParam())) {
81			$resp->setHttpResponseCode(403);
82			$resp->setBody('ESI method mismatch');
83			$debugHelper->logWarn('Blocking change of ESI method: %s -> %s',
84			$esiDataArray['esi_method'],
85			$req->getParam($esiHelper->getEsiMethodParam()));
86			} else {
87			$esiData = new Varien_Object($esiDataArray);
88			$origRequest = Mage::app()->getRequest();
89			Mage::app()->setCurrentStore(
90			Mage::app()->getStore($esiData->getStoreId()) );
91			$appShim = Mage::getModel('turpentine/shim_mage_core_app');
92			$dummyRequest = Mage::helper('turpentine/esi')->getDummyRequest($this->_getRequestSourceUrl());
93			$appShim->shim_setRequest($dummyRequest);
94			$block = $this->_getEsiBlock($esiData);
95			if ($block) {
96			$blockEsiOptions = $block->getEsiOptions();
97			$block->setEsiOptions(false);
98			$resp->setBody($block->toHtml());
99			if ((int) $req->getParam($esiHelper->getEsiTtlParam()) > 0) {
100			$cacheFlag = true;
101			if (isset($blockEsiOptions['only_cache_if'])) {
102			switch ($blockEsiOptions['only_cache_if']) {
103			case 'empty':
104			$cacheFlag = ('' === $resp->getBody());
105			break;
106			case 'no_text':
107			$cacheFlag = ('' === trim(strip_tags($resp->getBody())));
108			break;
109			default:
110			$cacheFlag = false;
111			}
112			}
113			}
114			if ($esiData->getEsiMethod() == 'ajax') {
115			$resp->setHeader('Access-Control-Allow-Origin',
116			$esiHelper->getCorsOrigin());
117			}
118			if ( ! is_null($flushEvents = $esiData->getFlushEvents())) {
119			$resp->setHeader('X-Turpentine-Flush-Events',
120			implode(',', $flushEvents));
121			}
122			if ($esiHelper->getEsiDebugEnabled()) {
123			$resp->setHeader('X-Turpentine-Block',
124			$block->getNameInLayout());
125			}
126			} else {
127			$resp->setHttpResponseCode(404);
128			$resp->setBody('ESI block not found');
129			}
130			$appShim->shim_setRequest($origRequest);
131			}
132			} else {
133			$resp->setHttpResponseCode(403);
134			$resp->setBody('ESI includes are not enabled');
135			}
136			Mage::register('turpentine_nocache_flag', ! $cacheFlag, true);
137			}
138
139			/**
140			* Need to disable this flag to prevent setting the last URL but we
141			* don't want to completely break sessions.
142			*
143			* see Mage_Core_Controller_Front_Action::postDispatch
144			*
145			* @return null
146			*/
147			public function postDispatch() {
148			$flag = $this->getFlag('', self::FLAG_NO_START_SESSION);
149			$this->setFlag('', self::FLAG_NO_START_SESSION, true);
150			parent::postDispatch();
151			$this->setFlag('', self::FLAG_NO_START_SESSION, $flag);
152			}
153
154			/**
155			* Generate the ESI block
156			*
157			* @param Varien_Object $esiData
158			* @return Mage_Core_Block_Template\|null
159			*/
160			protected function _getEsiBlock($esiData) {
161			$block = null;
			0 ignored issues – show Unused Code introduced 2015-11-25 14:59 UTC by Report Bug Copy Issue Report `$block` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
162			Varien_Profiler::start('turpentine::controller::esi::_getEsiBlock');
163			foreach ($esiData->getSimpleRegistry() as $key => $value) {
164			Mage::register($key, $value, true);
165			}
166			foreach ($esiData->getComplexRegistry() as $key => $data) {
167			$value = Mage::getModel($data['model']);
168			if ( ! is_object($value)) {
169			Mage::helper('turpentine/debug')->logWarn(
170			'Failed to register key/model: %s as %s(%s)',
171			$key, $data['model'], $data['id'] );
172			continue;
173			} else {
174			$value->load($data['id']);
175			Mage::register($key, $value, true);
176			}
177			}
178			$layout = Mage::getSingleton('core/layout');
179
180			// dispatch event for adding handles to layout update
181			Mage::dispatchEvent(
182			'controller_action_layout_load_before',
183			array('action'=>$this, 'layout'=>$layout)
184			);
185
186			$layoutUpdate = $layout->getUpdate();
187			$layoutUpdate->load($this->_swapCustomerHandles(
188			$esiData->getLayoutHandles() ));
189			foreach ($esiData->getDummyBlocks() as $blockName) {
190			$layout->createBlock('Mage_Core_Block_Template', $blockName);
191			}
192
193			if ( ! $this->getFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT)) {
194			Mage::dispatchEvent(
195			'controller_action_layout_generate_xml_before',
196			array('action'=>$this, 'layout'=>$layout)
197			);
198			}
199			$layout->generateXml();
200
201			/** @var Nexcessnet_Turpentine_Helper_Data $turpentineHelper */
202			$turpentineHelper = Mage::helper('turpentine/data')
203			->setLayout($layout);
204
205			$blockNode = current($layout->getNode()->xpath(
206			sprintf('//block[@name=\'%s\']', $esiData->getNameInLayout())
207			));
208
209			if ( ! ($blockNode instanceof Mage_Core_Model_Layout_Element)) {
			0 ignored issues – show Bug introduced 2015-11-25 14:59 UTC by Report Bug Copy Issue Report The class `Mage_Core_Model_Layout_Element` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
210			Mage::helper('turpentine/debug')->logWarn(
211			'No block node found with @name="%s"',
212			$esiData->getNameInLayout() );
213			return null;
214			}
215
216			$nodesToGenerate = $turpentineHelper->getChildBlockNames($blockNode);
217			Mage::getModel('turpentine/shim_mage_core_layout')
218			->shim_generateFullBlock($blockNode);
219
220			//find addional blocks that aren't defined in the <block/> but via <reference name="%s">
221			$referenceNodes = $layout->getNode()->xpath(sprintf(
222			'//reference[@name=\'%s\']',
223			$esiData->getNameInLayout() ));
224			if ($referenceNodes) {
225			foreach ($referenceNodes as $referenceNode) {
226			if ($referenceNode instanceof Mage_Core_Model_Layout_Element) {
			0 ignored issues – show Bug introduced 2015-11-25 14:59 UTC by Report Bug Copy Issue Report The class `Mage_Core_Model_Layout_Element` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
227			$referencesToGenerate = $turpentineHelper
228			->getChildBlockNames($referenceNode);
229			$nodesToGenerate =
230			array_merge($nodesToGenerate, $referencesToGenerate);
231			}
232			}
233			}
234
235			// dispatch event for adding xml layout elements
236			if ( ! $this->getFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT)) {
237			Mage::dispatchEvent(
238			'controller_action_layout_generate_blocks_before',
239			array('action'=>$this, 'layout'=>$layout)
240			);
241			}
242
243			foreach (array_unique($nodesToGenerate) as $nodeName) {
244			foreach ($layout->getNode()->xpath(sprintf(
245			'//reference[@name=\'%s\']', $nodeName )) as $node) {
246			$layout->generateBlocks($node);
247			}
248			}
249			$block = $layout->getBlock($esiData->getNameInLayout());
250
251			if ( ! $this->getFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT)) {
252			Mage::dispatchEvent(
253			'controller_action_layout_generate_blocks_after',
254			array('action'=>$this, 'layout'=>$layout)
255			);
256			}
257
258			$this->_isLayoutLoaded = true;
259			Varien_Profiler::stop('turpentine::controller::esi::_getEsiBlock');
260			return $block;
261			}
262
263			/**
264			* Swap customer_logged_in and customer_logged_out cached handles based on
265			* actual customer login status. Fixes stale Login/Logout links (and
266			* probably other things).
267			*
268			* This is definitely a hack, need a more general solution to this problem.
269			*
270			* @param array $handles
271			* @return array
272			*/
273			protected function _swapCustomerHandles($handles) {
274			if (Mage::helper('customer')->isLoggedIn()) {
275			$replacement = array('customer_logged_out', 'customer_logged_in');
276			} else {
277			$replacement = array('customer_logged_in', 'customer_logged_out');
278			}
279			if (($pos = array_search($replacement[0], $handles)) !== false) {
280			$handles[$pos] = $replacement[1];
281			}
282			return $handles;
283			}
284			/**
285			* Only rely on r64-param for DummyRequest-Url.
286			*
287			* Don't use the referrer (which may be bad encoded) as the DummyRequest-Url. So it is empty for any global
288			* ESI-Block, as they shouldn't depend on the current url.
289			*
290			* @return string
291			*/
292			protected function _getRequestSourceUrl()
293			{
294			$requestUrl = null;
295			if ($url = $this->getRequest()->getParam(self::PARAM_NAME_BASE64_URL)) {
296			$requestUrl = Mage::helper('core')->urlDecodeAndEscape($url);
297			}
298
299			if ($requestUrl && !$this->_isUrlInternal($requestUrl)) {
300			$requestUrl = Mage::app()->getStore()->getBaseUrl();
301			}
302			return $requestUrl;
303			}
304			}
305

nexcess / magento-turpentine

Pull Request — master (#1233)

_getRequestSourceUrl() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like