Ubuntu
javaScriptTagManagerLoader = $javaScriptTagManagerLoader;
}
public function getId()
{
return self::ID;
}
public function getName()
{
return Piwik::translate('TagManager_ContextWeb');
}
public function getOrder()
{
return 5;
}
public function generate($container)
{
$filesCreated = array();
$hasPreviewRelease = \false;
$environments = Request::processRequest('TagManager.getAvailableEnvironments');
$generatedEnvironments = array();
foreach ($container['releases'] as $release) {
$generatedEnvironments[] = $release['environment'];
if ($release['environment'] === Environment::ENVIRONMENT_PREVIEW) {
$hasPreviewRelease = \true;
break;
}
}
if (!$hasPreviewRelease) {
// we make sure to remove the preview file in case preview mode is no longer enabled to not expose any
// possible upcoming events, changes, etc
$previewFileToDelete = $this->getJsTargetPath($container['idsite'], $container['idcontainer'], Environment::ENVIRONMENT_PREVIEW, $container['created_date']);
$this->storage->delete(PIWIK_DOCUMENT_ROOT . $previewFileToDelete);
}
$baseJs = $this->javaScriptTagManagerLoader->getJavaScriptContent();
$preconfiguredVariablesResponse = $this->getPreConfiguredVariablesJSCodeResponse(self::ID);
foreach ($environments as $environment) {
$environmentId = $environment['id'] ?? \false;
// we make sure to have files even for containers that don't have a release yet, this way they can embed it
// already nicely into the page and activate it later through the UI
if ($environmentId && !in_array($environmentId, $generatedEnvironments, \true)) {
$isPreviewRelease = $environmentId === Environment::ENVIRONMENT_PREVIEW;
if ($isPreviewRelease) {
$hasPreviewRelease = \true;
}
$js = $this->addPreviewCode($baseJs, $hasPreviewRelease, $isPreviewRelease, $container);
$path = $this->getJsTargetPath($container['idsite'], $container['idcontainer'], $environmentId, $container['created_date']);
$filesCreated[$path] = $js;
$this->storage->save(PIWIK_DOCUMENT_ROOT . $path, $js);
}
}
foreach ($container['releases'] as $release) {
$this->templateLocator = StaticContainer::getContainer()->make('Piwik\\Plugins\\TagManager\\Context\\BaseContext\\TemplateLocator');
$isPreviewRelease = $release['environment'] === Environment::ENVIRONMENT_PREVIEW;
if ($isPreviewRelease) {
$hasPreviewRelease = \true;
}
$containerJs = $this->generatePublicContainer($container, $release);
$replaceMacros = array();
$variableTemplates = ['keys' => [], 'values' => []];
foreach ($containerJs['tags'] as &$tag) {
$tag['Tag'] = $this->templateLocator->loadTagTemplate($tag, self::ID);
$tag['parameters'] = $this->addVariableTemplateToParameters($tag['parameters']);
if (!$isPreviewRelease) {
$tag['name'] = md5($tag['name']);
// actual name is needed for session/lifetime feature
} else {
$tag['name'] = Common::unsanitizeInputValue($tag['name']);
}
}
foreach ($containerJs['triggers'] as &$trigger) {
$trigger['Trigger'] = $this->templateLocator->loadTriggerTemplate($trigger, self::ID);
$trigger['parameters'] = $this->addVariableTemplateToParameters($trigger['parameters']);
foreach ($trigger['conditions'] as &$condition) {
if (!empty($condition['actual']['type'])) {
$condition['actual']['Variable'] = $this->templateLocator->loadVariableTemplate($condition['actual'], self::ID);
}
}
if (!$isPreviewRelease) {
$trigger['name'] = $trigger['type'];
} else {
$trigger['name'] = Common::unsanitizeInputValue($trigger['name']);
}
}
foreach ($containerJs['variables'] as $variableKey => &$variable) {
$variable['Variable'] = $this->templateLocator->loadVariableTemplate($variable, self::ID);
$variable['parameters'] = $this->addVariableTemplateToParameters($variable['parameters']);
if (!empty($variable['parameters'])) {
$variableTemplates['keys'][] = '{{' . $variable['name'] . '}}';
$variableTemplates['values'][] = 'TagManager._buildVariable(' . json_encode($variable) . ", parameters.get('container')).get()";
}
if (!empty($variable['parameters']['jsFunction']) && strpos($variable['parameters']['jsFunction'], '{{') !== \false) {
$replaceMacros[] = ['key' => $variableKey, 'methodName' => $variable['Variable']];
}
if (!$isPreviewRelease) {
$variable['name'] = $variable['type'];
} else {
$variable['name'] = Common::unsanitizeInputValue($variable['name']);
}
}
if (!empty($replaceMacros)) {
$mergedKeys = array_merge($preconfiguredVariablesResponse['keys'], $variableTemplates['keys']);
$mergedValues = array_merge($preconfiguredVariablesResponse['values'], $variableTemplates['values']);
foreach ($replaceMacros as $replaceValues) {
if (!empty($containerJs['variables'][$replaceValues['key']]['parameters']['jsFunction'])) {
$containerJs['variables'][$replaceValues['key']]['parameters']['jsFunction'] = str_replace($mergedKeys, $mergedValues, $containerJs['variables'][$replaceValues['key']]['parameters']['jsFunction']);
$this->templateLocator->updateVariableTemplate($replaceValues['methodName'], str_replace($mergedKeys, $mergedValues, $this->templateLocator->getVariableTemplate($replaceValues['methodName'])));
}
}
}
$jsonOptions = 0;
if (Development::isEnabled()) {
$jsonOptions = \JSON_PRETTY_PRINT;
}
$initContainer = '(function(){';
$initContainer .= "\nvar Templates = {};\n";
foreach ($this->templateLocator->getLoadedTemplates() as $methodName => $template) {
$initContainer .= sprintf("Templates['%s'] = %s \n", $methodName, $template);
}
$initContainer .= 'window.MatomoTagManager.addContainer(' . json_encode($containerJs, $jsonOptions) . ', Templates);})()';
$js = $this->addPreviewCode($baseJs, $hasPreviewRelease, $isPreviewRelease, $container);
$js = str_replace(array('/*!! initContainerHook */', '/*!!! initContainerHook */'), $initContainer, $js);
$ignoreGtmDataLayer = isset($container['ignoreGtmDataLayer']) && $container['ignoreGtmDataLayer'] == 1 ? 'true' : 'false';
$activelySyncGtmDataLayer = isset($container['activelySyncGtmDataLayer']) && $container['activelySyncGtmDataLayer'] == 1 ? 'true' : 'false';
$windowLevelSettingsJs = "var ignoreGtmDataLayer = {$ignoreGtmDataLayer}; var activelySyncGtmDataLayer = {$activelySyncGtmDataLayer};";
$js = str_replace(array('/*!! windowLevelSettingsHook */', '/*!!! windowLevelSettingsHook */'), $windowLevelSettingsJs, $js);
$path = $this->getJsTargetPath($container['idsite'], $container['idcontainer'], $release['environment'], $container['created_date']);
$filesCreated[$path] = $js;
$this->storage->save(PIWIK_DOCUMENT_ROOT . $path, $js);
}
return $filesCreated;
}
private function addPreviewCode($baseJs, $hasPreviewRelease, $isPreviewRelease, $container)
{
if ($isPreviewRelease) {
$execPreview = $this->javaScriptTagManagerLoader->getPreviewJsContent();
$baseJs = str_replace(array('/*!! previewModeHook */', '/*!!! previewModeHook */'), $execPreview, $baseJs);
} elseif ($hasPreviewRelease) {
$previewUrl = $this->getWebPathForRelease($container['idsite'], $container['idcontainer'], Environment::ENVIRONMENT_PREVIEW, $container['created_date']);
$execPreview = $this->javaScriptTagManagerLoader->getDetectPreviewModeContent($previewUrl, $container['idsite'], $container['idcontainer']);
$baseJs = str_replace(array('/*!! previewModeHook */', '/*!!! previewModeHook */'), $execPreview, $baseJs);
}
return $baseJs;
}
private function addVariableTemplateToParameters($parameters)
{
if (!empty($parameters) && is_array($parameters)) {
foreach ($parameters as $parameterName => &$textOrVariable) {
$parameters[$parameterName] = $this->addVariableTemplateIfNeeded($textOrVariable);
}
}
return $parameters;
}
private function addVariableTemplateIfNeeded($part)
{
if (is_array($part) && !empty($part['joinedVariable'])) {
// it is a multi variable
foreach ($part['joinedVariable'] as $key => $partInner) {
$part['joinedVariable'][$key] = $this->addVariableTemplateIfNeeded($partInner);
}
} elseif (is_array($part) && !empty($part['type'])) {
// this is a regular variable
$part['Variable'] = $this->templateLocator->loadVariableTemplate($part, self::ID);
$part['parameters'] = $this->addVariableTemplateToParameters($part['parameters']);
} elseif (is_array($part)) {
// a regular array which each could have potentially a variable
foreach ($part as $subkey => $subvalue) {
$part[$subkey] = $this->addVariableTemplateIfNeeded($subvalue);
}
}
return $part;
}
public function getJsTargetPath($idSite, $idContainer, $environment, $containerCreatedDate)
{
return parent::getJsTargetPath($idSite, $idContainer, $environment, $containerCreatedDate) . '.js';
}
private function getWebPathForRelease($idSite, $idContainer, $environment, $containerCreatedDate)
{
$domain = SettingsPiwik::getPiwikUrl();
if (Common::stringEndsWith($domain, '/')) {
$domain = Common::mb_substr($domain, 0, -1);
}
$path = $this->getJsTargetPath($idSite, $idContainer, $environment, $containerCreatedDate);
$storagePath = StaticContainer::get('TagManagerContainerStorageDir') . '/';
$webPath = StaticContainer::get('TagManagerContainerWebDir') . '/';
$path = str_replace($storagePath, $webPath, $path);
return $domain . $path;
}
public function getInstallInstructions($container, $environment)
{
$path = $this->getWebPathForRelease($container['idsite'], $container['idcontainer'], $environment, $container['created_date']);
$embedCode = <<
INST;
return [['description' => Piwik::translate('TagManager_ContextWebInstallInstructions', array('')), 'embedCode' => $embedCode, 'helpUrl' => Url::addCampaignParametersToMatomoLink('https://developer.matomo.org/guides/tagmanager/embedding', null, null, 'App.TagManager.getInstallInstructions')]];
}
public function getInstallInstructionsReact($container, $environment)
{
$path = $this->getWebPathForRelease($container['idsite'], $container['idcontainer'], $environment, $container['created_date']);
$embedCode = << {
var _mtm = window._mtm = window._mtm || [];
_mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src='{$path}'; s.parentNode.insertBefore(g,s);
}, [])
return (
Hello World
)
}
INST;
return [['description' => Piwik::translate('TagManager_ContextWebInstallInstructions', array('')), 'embedCode' => $embedCode, 'helpUrl' => Url::addCampaignParametersToMatomoLink('https://developer.matomo.org/guides/tagmanager/embedding', null, null, 'App.TagManager.getInstallInstructionsReact'), 'pageViewTriggerEditUrl' => $this->getPageViewTriggerEditUrl($container['idsite'], $container['idcontainer'])]];
}
private function getPageViewTriggerEditUrl($idSite, $idContainer)
{
$url = '';
$settings = new SystemSettings();
$validator = new AccessValidator($settings);
if (!$validator->hasWriteCapability($idSite)) {
return $url;
}
$container = Request::processRequest('TagManager.getContainer', ['idSite' => $idSite, 'idContainer' => $idContainer]);
if (!empty($container['draft']['idcontainerversion'])) {
$triggers = Request::processRequest('TagManager.getContainerTriggers', ['idSite' => $idSite, 'idContainer' => $idContainer, 'idContainerVersion' => $container['draft']['idcontainerversion']]);
if (!empty($triggers)) {
foreach ($triggers as $trigger) {
if (!empty($trigger['type']) && $trigger['type'] == PageViewTrigger::ID) {
$url = SettingsPiwik::getPiwikUrl() . 'index.php?' . Url::getQueryStringFromParameters(['module' => 'TagManager', 'action' => 'manageTriggers', 'idSite' => $idSite, 'idContainer' => $idContainer]) . '#idTrigger=' . $trigger['idtrigger'];
break;
}
}
}
}
return $url;
}
}