1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Widgetize;
use Piwik\API\Request;
use Piwik\Request\AuthenticationToken;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\FrontController;
use Piwik\Piwik;
use Piwik\Url;
use Piwik\View;
/**
*
*/
class Controller extends \Piwik\Plugin\Controller
{
public function index()
{
$view = new View('@Widgetize/index');
$this->setGeneralVariablesView($view);
return $view->render();
}
public function iframe()
{
// also called by FrontController, we call it explicitly as a safety measure in case something changes in the future
if (StaticContainer::get(AuthenticationToken::class)->getAuthToken()) {
Request::checkTokenAuthIsNotLimited('Widgetize', 'iframe');
}
$this->init();
$controllerName = Common::getRequestVar('moduleToWidgetize');
$actionName = Common::getRequestVar('actionToWidgetize');
if ($controllerName == 'API') {
throw new \Exception("Widgetizing API requests is not supported for security reasons. Please change query parameter 'moduleToWidgetize'.");
}
if ($controllerName == 'Widgetize') {
throw new \Exception("Please set 'moduleToWidgetize' to a valid value.");
}
if ($controllerName == 'CoreHome' && $actionName == 'index') {
$message = 'CoreHome cannot be widgetized. ' .
'You can enable it to be embedded directly into an iframe (passing module=CoreHome instead of module=Widgetize) ' .
'instead by enabling the \'enable_framed_pages\' setting in your config. ' .
'See ' . Url::addCampaignParametersToMatomoLink('https://matomo.org/faq/how-to/faq_193/') . ' for more info.';
throw new \Exception($message);
}
$shouldEmbedEmpty = false;
/**
* Triggered to detect whether a widgetized report should be wrapped in the widgetized HTML or whether only
* the rendered output of the controller/action should be printed. Set `$shouldEmbedEmpty` to `true` if
* your widget renders the full HTML itself.
*
* **Example**
*
* public function embedIframeEmpty(&$shouldEmbedEmpty, $controllerName, $actionName)
* {
* if ($controllerName == 'Dashboard' && $actionName == 'index') {
* $shouldEmbedEmpty = true;
* }
* }
*
* @param string &$shouldEmbedEmpty Defines whether the iframe should be embedded empty or wrapped within the widgetized html.
* @param string $controllerName The name of the controller that will be executed.
* @param string $actionName The name of the action within the controller that will be executed.
*/
Piwik::postEvent('Widgetize.shouldEmbedIframeEmpty', array(&$shouldEmbedEmpty, $controllerName, $actionName));
if ($shouldEmbedEmpty) {
$view = new View('@Widgetize/iframe_empty');
} else {
$view = new View('@Widgetize/iframe');
}
$this->setGeneralVariablesView($view);
$view->setXFrameOptions('allow');
$view->content = FrontController::getInstance()->fetchDispatch($controllerName, $actionName);
return $view->render();
}
}
|
