|
public static getCurrentRoute ( ) : |
||
| return | ||
/**
*
*/
public function dispatchLoopShutdown()
{
if (!Tool::isHtmlResponse($this->getResponse())) {
return;
}
if (!Tool::useFrontendOutputFilters($this->getRequest()) && !$this->getRequest()->getParam("pimcore_preview")) {
return;
}
if (isset($_COOKIE["pimcore_admin_sid"])) {
try {
// we should not start a session here as this can break the functionality of the site if
// the website itself uses sessions, so we include the code, and check asynchronously if the user is logged in
// this is done by the embedded script
$body = $this->getResponse()->getBody();
$document = $this->getRequest()->getParam("document");
if ($document instanceof Model\Document && !Model\Staticroute::getCurrentRoute()) {
$documentId = $document->getId();
}
if (!isset($documentId) || !$documentId) {
$documentId = "null";
}
$code = '<script type="text/javascript" src="/admin/admin-button/script?documentId=' . $documentId . '"></script>';
// search for the end <head> tag, and insert the google analytics code before
// this method is much faster than using simple_html_dom and uses less memory
$bodyEndPosition = stripos($body, "</body>");
if ($bodyEndPosition !== false) {
$body = substr_replace($body, $code . "\n\n</body>\n", $bodyEndPosition, 7);
}
$this->getResponse()->setBody($body);
} catch (\Exception $e) {
\Logger::error($e);
}
}
}
/**
* Checks if Controller is available in Template and use it.
*
* @param \Zend_Controller_Request_Abstract $request
*/
public function routeShutdown(\Zend_Controller_Request_Abstract $request)
{
$gatewayRequest = clone $request;
if ($request->getModuleName() === 'Omnipay') {
$frontController = \Zend_Controller_Front::getInstance();
$route = Staticroute::getCurrentRoute();
if ($route) {
if ($route->getName() === "coreshop_omnipay_payment") {
$gateway = ucfirst($request->getParam("gateway"));
$gatewayRequest->setControllerName($gateway);
if ($frontController->getDispatcher()->isDispatchable($gatewayRequest)) {
$request->setControllerName($gateway);
}
}
}
}
}
/**
* @throws \Zend_Controller_Router_Exception
*/
public function init()
{
// this is only executed once per request (first request)
if (self::$isInitial) {
\Pimcore::getEventManager()->trigger("frontend.controller.preInit", $this);
}
parent::init();
// log exceptions if handled by error_handler
$this->checkForErrors();
// general definitions
if (self::$isInitial) {
\Pimcore::unsetAdminMode();
Document::setHideUnpublished(true);
Object\AbstractObject::setHideUnpublished(true);
Object\AbstractObject::setGetInheritedValues(true);
Object\Localizedfield::setGetFallbackValues(true);
}
// assign variables
$this->view->controller = $this;
// init website config
$config = Config::getWebsiteConfig();
$this->config = $config;
$this->view->config = $config;
$document = $this->getParam("document");
if (!$document instanceof Document) {
\Zend_Registry::set("pimcore_editmode", false);
$this->editmode = false;
$this->view->editmode = false;
self::$isInitial = false;
// check for a locale first, and set it if available
if ($this->getParam("pimcore_parentDocument")) {
// this is a special exception for renderlets in editmode (ajax request), because they depend on the locale of the parent document
// otherwise there'll be notices like: Notice: 'No translation for the language 'XX' available.'
if ($parentDocument = Document::getById($this->getParam("pimcore_parentDocument"))) {
if ($parentDocument->getProperty("language")) {
$this->setLocaleFromDocument($parentDocument->getProperty("language"));
}
}
}
// no document available, continue, ...
return;
} else {
$this->setDocument($document);
// register global locale if the document has the system property "language"
if ($this->getDocument()->getProperty("language")) {
$this->setLocaleFromDocument($this->getDocument()->getProperty("language"));
}
if (self::$isInitial) {
// append meta-data to the headMeta() view helper, if it is a document-request
if (!Model\Staticroute::getCurrentRoute() && $this->getDocument() instanceof Document\Page) {
if (is_array($this->getDocument()->getMetaData())) {
foreach ($this->getDocument()->getMetaData() as $meta) {
// only name
if (!empty($meta["idName"]) && !empty($meta["idValue"]) && !empty($meta["contentValue"])) {
$method = "append" . ucfirst($meta["idName"]);
$this->view->headMeta()->{$method}($meta["idValue"], $meta["contentValue"]);
}
}
}
}
}
}
// this is only executed once per request (first request)
if (self::$isInitial) {
// contains the logged in user if necessary
$user = null;
// default is to set the editmode to false, is enabled later if necessary
\Zend_Registry::set("pimcore_editmode", false);
if (Tool::isFrontentRequestByAdmin()) {
$this->disableBrowserCache();
// start admin session & get logged in user
$user = Authentication::authenticateSession();
}
if (\Pimcore::inDebugMode()) {
$this->disableBrowserCache();
}
if (!$this->document->isPublished()) {
if (Tool::isFrontentRequestByAdmin()) {
if (!$user) {
throw new \Zend_Controller_Router_Exception("access denied for " . $this->document->getFullPath());
}
} else {
throw new \Zend_Controller_Router_Exception("access denied for " . $this->document->getFullPath());
}
}
// logged in users only
if ($user) {
// set the user to registry so that it is available via \Pimcore\Tool\Admin::getCurrentUser();
\Zend_Registry::set("pimcore_admin_user", $user);
// document editmode
if ($this->getParam("pimcore_editmode")) {
\Zend_Registry::set("pimcore_editmode", true);
// check if there is the document in the session
$docKey = "document_" . $this->getDocument()->getId();
$docSession = Session::getReadOnly("pimcore_documents");
if ($docSession->{$docKey}) {
// if there is a document in the session use it
$this->setDocument($docSession->{$docKey});
} else {
// set the latest available version for editmode if there is no doc in the session
$latestVersion = $this->getDocument()->getLatestVersion();
if ($latestVersion) {
$latestDoc = $latestVersion->loadData();
if ($latestDoc instanceof Document\PageSnippet) {
$this->setDocument($latestDoc);
}
}
}
// register editmode plugin
$front = \Zend_Controller_Front::getInstance();
$front->registerPlugin(new \Pimcore\Controller\Plugin\Frontend\Editmode($this), 1000);
}
// document preview
if ($this->getParam("pimcore_preview")) {
// get document from session
$docKey = "document_" . $this->getParam("document")->getId();
$docSession = Session::getReadOnly("pimcore_documents");
if ($docSession->{$docKey}) {
$this->setDocument($docSession->{$docKey});
}
}
// object preview
if ($this->getParam("pimcore_object_preview")) {
$key = "object_" . $this->getParam("pimcore_object_preview");
$session = Session::getReadOnly("pimcore_objects");
if ($session->{$key}) {
$object = $session->{$key};
// add the object to the registry so every call to Object::getById() will return this object instead of the real one
\Zend_Registry::set("object_" . $object->getId(), $object);
}
}
// for version preview
if ($this->getParam("pimcore_version")) {
// only get version data at the first call || because of embedded Snippets ...
if (!\Zend_Registry::isRegistered("pimcore_version_active")) {
$version = Model\Version::getById($this->getParam("pimcore_version"));
$this->setDocument($version->getData());
\Zend_Registry::set("pimcore_version_active", true);
}
}
}
// for public versions
if ($this->getParam("v")) {
try {
$version = Model\Version::getById($this->getParam("v"));
if ($version->getPublic()) {
$this->setDocument($version->getData());
}
} catch (\Exception $e) {
}
}
// check for persona
if ($this->getDocument() instanceof Document\Page) {
$this->getDocument()->setUsePersona(null);
// reset because of preview and editmode (saved in session)
if ($this->getParam("_ptp") && self::$isInitial) {
$this->getDocument()->setUsePersona($this->getParam("_ptp"));
}
}
// check if document is a wrapped hardlink, if this is the case send a rel=canonical header to the source document
if ($this->getDocument() instanceof Document\Hardlink\Wrapper\WrapperInterface) {
// get the cononical (source) document
$hardlinkCanonicalSourceDocument = Document::getById($this->getDocument()->getId());
$request = $this->getRequest();
if (\Pimcore\Tool\Frontend::isDocumentInCurrentSite($hardlinkCanonicalSourceDocument)) {
$this->getResponse()->setHeader("Link", '<' . $request->getScheme() . "://" . $request->getHttpHost() . $hardlinkCanonicalSourceDocument->getFullPath() . '>; rel="canonical"');
}
}
\Pimcore::getEventManager()->trigger("frontend.controller.postInit", $this);
}
// set some parameters
$this->editmode = \Zend_Registry::get("pimcore_editmode");
$this->view->editmode = \Zend_Registry::get("pimcore_editmode");
self::$isInitial = false;
}
/**
*
*/
public function dispatchLoopShutdown()
{
if (!Tool::isHtmlResponse($this->getResponse())) {
return;
}
if ($this->enabled) {
$targets = array();
$personas = array();
$dataPush = array("personas" => $this->personas, "method" => strtolower($this->getRequest()->getMethod()));
if (count($this->events) > 0) {
$dataPush["events"] = $this->events;
}
if ($this->document instanceof Document\Page && !Model\Staticroute::getCurrentRoute()) {
$dataPush["document"] = $this->document->getId();
if ($this->document->getPersonas()) {
if ($_GET["_ptp"]) {
// if a special version is requested only return this id as target group for this page
$dataPush["personas"][] = (int) $_GET["_ptp"];
} else {
$docPersonas = explode(",", trim($this->document->getPersonas(), " ,"));
// cast the values to int
array_walk($docPersonas, function (&$value) {
$value = (int) trim($value);
});
$dataPush["personas"] = array_merge($dataPush["personas"], $docPersonas);
}
}
// check for persona specific variants of this page
$personaVariants = array();
foreach ($this->document->getElements() as $key => $tag) {
if (preg_match("/^persona_-([0-9]+)-_/", $key, $matches)) {
$id = (int) $matches[1];
if (Model\Tool\Targeting\Persona::isIdActive($id)) {
$personaVariants[] = $id;
}
}
}
if (!empty($personaVariants)) {
$personaVariants = array_values(array_unique($personaVariants));
$dataPush["personaPageVariants"] = $personaVariants;
}
}
// no duplicates
$dataPush["personas"] = array_unique($dataPush["personas"]);
$activePersonas = array();
foreach ($dataPush["personas"] as $id) {
if (Model\Tool\Targeting\Persona::isIdActive($id)) {
$activePersonas[] = $id;
}
}
$dataPush["personas"] = $activePersonas;
if ($this->document) {
// @TODO: cache this
$list = new Model\Tool\Targeting\Rule\Listing();
$list->setCondition("active = 1");
foreach ($list->load() as $target) {
$redirectUrl = $target->getActions()->getRedirectUrl();
if (is_numeric($redirectUrl)) {
$doc = \Document::getById($redirectUrl);
if ($doc instanceof \Document) {
$target->getActions()->redirectUrl = $doc->getFullPath();
}
}
$targets[] = $target;
}
$list = new Model\Tool\Targeting\Persona\Listing();
$list->setCondition("active = 1");
foreach ($list->load() as $persona) {
$personas[] = $persona;
}
}
$code = '<script type="text/javascript" src="/pimcore/static/js/frontend/geoip.js/"></script>';
$code .= '<script type="text/javascript">';
$code .= 'var pimcore = pimcore || {};';
$code .= 'pimcore["targeting"] = {};';
$code .= 'pimcore["targeting"]["dataPush"] = ' . \Zend_Json::encode($dataPush) . ';';
$code .= 'pimcore["targeting"]["targetingRules"] = ' . \Zend_Json::encode($targets) . ';';
$code .= 'pimcore["targeting"]["personas"] = ' . \Zend_Json::encode($personas) . ';';
$code .= '</script>';
$code .= '<script type="text/javascript" src="/pimcore/static/js/frontend/targeting.js"></script>';
$code .= "\n";
// analytics
$body = $this->getResponse()->getBody();
// search for the end <head> tag, and insert the google analytics code before
// this method is much faster than using simple_html_dom and uses less memory
$headEndPosition = stripos($body, "<head>");
if ($headEndPosition !== false) {
$body = substr_replace($body, "<head>\n" . $code, $headEndPosition, 7);
}
$this->getResponse()->setBody($body);
}
}
/**
* @param array $urlOptions
* @param null $name
* @param bool $reset
* @param bool $encode
* @return string|void
* @throws \Exception
*/
public function url(array $urlOptions = array(), $name = null, $reset = false, $encode = true)
{
if (!$urlOptions) {
$urlOptions = array();
}
// when using $name = false we don't use the default route (happens when $name = null / ZF default behavior)
// but just the query string generation using the given parameters
// eg. $this->url(["foo" => "bar"], false) => /?foo=bar
if ($name === null) {
if (Staticroute::getCurrentRoute() instanceof Staticroute) {
$name = Staticroute::getCurrentRoute()->getName();
}
}
$siteId = null;
if (Site::isSiteRequest()) {
$siteId = Site::getCurrentSite()->getId();
}
// check for a site in the options, if valid remove it from the options
$hostname = null;
if (isset($urlOptions["site"])) {
$config = Config::getSystemConfig();
$site = $urlOptions["site"];
if (!empty($site)) {
try {
$site = Site::getBy($site);
unset($urlOptions["site"]);
$hostname = $site->getMainDomain();
$siteId = $site->getId();
} catch (\Exception $e) {
\Logger::warn("passed site doesn't exists");
\Logger::warn($e);
}
} else {
if ($config->general->domain) {
$hostname = $config->general->domain;
}
}
}
if ($name && ($route = Staticroute::getByName($name, $siteId))) {
// assemble the route / url in Staticroute::assemble()
$url = $route->assemble($urlOptions, $reset, $encode);
// if there's a site, prepend the host to the generated URL
if ($hostname && !preg_match("/^http/i", $url)) {
$url = "//" . $hostname . $url;
}
if (Config::getSystemConfig()->documents->allowcapitals == 'no') {
$urlParts = parse_url($url);
$url = str_replace($urlParts["path"], strtolower($urlParts["path"]), $url);
}
return $url;
}
// this is to add support for arrays as values for the default \Zend_View_Helper_Url
$unset = array();
foreach ($urlOptions as $optionName => $optionValues) {
if (is_array($optionValues)) {
foreach ($optionValues as $key => $value) {
$urlOptions[$optionName . "[" . $key . "]"] = $value;
}
$unset[] = $optionName;
}
}
foreach ($unset as $optionName) {
unset($urlOptions[$optionName]);
}
try {
return parent::url($urlOptions, $name, $reset, $encode);
} catch (\Exception $e) {
if (Tool::isFrontentRequestByAdmin()) {
// routes can be site specific, so in editmode it's possible that we don't get
// the right route (sites are not registered in editmode), so we cannot throw exceptions there
return "ERROR_IN_YOUR_URL_CONFIGURATION:~ROUTE--" . $name . "--DOES_NOT_EXIST";
}
throw new \Exception("Route '" . $name . "' for building the URL not found");
}
}
/**
* @param array $urlOptions
* @param null $name
* @param bool $reset
* @param bool $encode
* @return string|void
* @throws \Exception
*/
public function url(array $urlOptions = array(), $name = null, $reset = false, $encode = true)
{
if (!$urlOptions) {
$urlOptions = array();
}
if (!$name) {
if (Staticroute::getCurrentRoute() instanceof Staticroute) {
$name = Staticroute::getCurrentRoute()->getName();
}
}
$siteId = null;
if (Site::isSiteRequest()) {
$siteId = Site::getCurrentSite()->getId();
}
// check for a site in the options, if valid remove it from the options
$hostname = null;
if (isset($urlOptions["site"])) {
$config = Config::getSystemConfig();
$site = $urlOptions["site"];
if (!empty($site)) {
try {
$site = Site::getBy($site);
unset($urlOptions["site"]);
$hostname = $site->getMainDomain();
$siteId = $site->getId();
} catch (\Exception $e) {
\Logger::warn("passed site doesn't exists");
\Logger::warn($e);
}
} else {
if ($config->general->domain) {
$hostname = $config->general->domain;
}
}
}
if ($name && ($route = Staticroute::getByName($name, $siteId))) {
// assemble the route / url in Staticroute::assemble()
$url = $route->assemble($urlOptions, $reset, $encode);
// if there's a site, prepend the host to the generated URL
if ($hostname && !preg_match("/^http/i", $url)) {
$url = "//" . $hostname . $url;
}
if (Config::getSystemConfig()->documents->allowcapitals == 'no') {
$urlParts = parse_url($url);
$url = str_replace($urlParts["path"], strtolower($urlParts["path"]), $url);
}
return $url;
}
// this is to add support for arrays as values for the default \Zend_View_Helper_Url
$unset = array();
foreach ($urlOptions as $optionName => $optionValues) {
if (is_array($optionValues)) {
foreach ($optionValues as $key => $value) {
$urlOptions[$optionName . "[" . $key . "]"] = $value;
}
$unset[] = $optionName;
}
}
foreach ($unset as $optionName) {
unset($urlOptions[$optionName]);
}
try {
return parent::url($urlOptions, $name, $reset, $encode);
} catch (\Exception $e) {
throw new \Exception("Route '" . $name . "' for building the URL not found");
}
}