ReportRenderer.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.13.0

matomo / app / core / ReportRenderer.php

matomo / app / core Last commit date

API 4 days ago Access 1 month ago Application 1 month ago Archive 1 month ago ArchiveProcessor 4 days ago Archiver 2 years ago AssetManager 1 month ago Auth 1 month ago Category 1 month ago Changes 3 months ago CliMulti 1 month ago Columns 4 days ago Concurrency 1 month ago Config 1 month ago Container 3 months ago CronArchive 1 month ago DataAccess 4 days ago DataFiles 2 years ago DataTable 1 month ago Db 4 days ago DeviceDetector 1 year ago Email 2 years ago Exception 6 months ago Http 4 days ago Intl 5 months ago Log 2 years ago Mail 1 year ago Measurable 8 months ago Menu 1 month ago Metrics 1 month ago Notification 8 months ago Period 1 month ago Plugin 4 days ago Policy 3 months ago ProfessionalServices 1 year ago Report 1 year ago ReportRenderer 4 days ago Request 1 month ago Scheduler 1 month ago Segment 1 month ago Session 4 days ago Settings 4 days ago Tracker 4 days ago Translation 3 months ago Twig 1 year ago UpdateCheck 5 months ago Updater 1 month ago Updates 2 months ago Validators 1 year ago View 3 months ago ViewDataTable 4 days ago Visualization 4 days ago Widget 1 month ago .htaccess 2 years ago Access.php 1 month ago Archive.php 3 months ago ArchiveProcessor.php 4 days ago AssetManager.php 1 month ago Auth.php 8 months ago AuthResult.php 8 months ago BaseFactory.php 2 years ago Cache.php 1 month ago CacheId.php 6 months ago CliMulti.php 1 month ago Common.php 1 month ago Config.php 1 month ago Console.php 5 months ago Context.php 2 years ago Cookie.php 1 month ago CronArchive.php 1 month ago DI.php 5 months ago DataArray.php 1 month ago DataTable.php 4 days ago Date.php 3 months ago Db.php 3 months ago DbHelper.php 1 month ago Development.php 1 month ago ErrorHandler.php 8 months ago EventDispatcher.php 3 months ago ExceptionHandler.php 6 months ago FileIntegrity.php 1 month ago Filechecks.php 1 year ago Filesystem.php 4 days ago FrontController.php 1 month ago Http.php 4 days ago IP.php 1 year ago Log.php 5 months ago LogDeleter.php 1 month ago Mail.php 1 year ago Metrics.php 3 months ago NoAccessException.php 2 years ago Nonce.php 8 months ago Notification.php 3 months ago NumberFormatter.php 1 month ago Option.php 1 month ago Period.php 1 month ago Piwik.php 1 month ago Plugin.php 3 months ago Process.php 3 months ago Profiler.php 1 month ago ProxyHeaders.php 6 months ago ProxyHttp.php 1 month ago QuickForm2.php 5 months ago RankingQuery.php 3 months ago ReportRenderer.php 4 days ago Request.php 3 months ago Segment.php 4 days ago Sequence.php 1 month ago Session.php 2 months ago SettingsPiwik.php 1 month ago SettingsServer.php 1 month ago Singleton.php 2 years ago Site.php 3 months ago SiteContentDetector.php 4 days ago SupportedBrowser.php 2 years ago TCPDF.php 1 year ago Theme.php 1 month ago Timer.php 1 month ago Tracker.php 1 month ago Twig.php 4 days ago Unzip.php 1 year ago UpdateCheck.php 3 months ago Updater.php 1 month ago UpdaterErrorException.php 2 years ago Updates.php 1 month ago Url.php 1 month ago UrlHelper.php 3 months ago Version.php 4 days ago View.php 1 month ago bootstrap.php 1 year ago dispatch.php 2 years ago testMinimumPhpVersion.php 8 months ago

ReportRenderer.php

258 lines

1	<?php
2
3	/**
4	* Matomo - free/libre analytics platform
5	*
6	* @link https://matomo.org
7	* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
8	*/
9	namespace Piwik;
10
11	use Exception;
12	use Piwik\API\Request;
13	use Piwik\Container\StaticContainer;
14	use Piwik\DataTable\Row;
15	use Piwik\DataTable\Simple;
16	use Piwik\Plugins\ImageGraph\API;
17	/**
18	* A Report Renderer produces user friendly renderings of any given Piwik report.
19	* All new Renderers must be copied in ReportRenderer and added to the $availableReportRenderers.
20	*/
21	abstract class ReportRenderer extends \Piwik\BaseFactory
22	{
23	public const DEFAULT_REPORT_FONT_FAMILY = 'dejavusans';
24	public const REPORT_TEXT_COLOR = "13,13,13";
25	public const REPORT_TITLE_TEXT_COLOR = "13,13,13";
26	public const TABLE_HEADER_BG_COLOR = "255,255,255";
27	public const TABLE_HEADER_TEXT_COLOR = "13,13,13";
28	public const TABLE_HEADER_TEXT_TRANSFORM = "uppercase";
29	public const TABLE_HEADER_TEXT_WEIGHT = "normal";
30	public const TABLE_CELL_BORDER_COLOR = "217,217,217";
31	public const TABLE_BG_COLOR = "242,242,242";
32	public const HTML_FORMAT = 'html';
33	public const PDF_FORMAT = 'pdf';
34	public const CSV_FORMAT = 'csv';
35	public const TSV_FORMAT = 'tsv';
36	protected $idSite = 'all';
37	protected $report;
38	private static $availableReportRenderers = [self::PDF_FORMAT, self::HTML_FORMAT, self::CSV_FORMAT, self::TSV_FORMAT];
39	/**
40	* Sets the site id
41	*
42	* @param int $idSite
43	*/
44	public function setIdSite($idSite)
45	{
46	$this->idSite = $idSite;
47	}
48	public function setReport($report)
49	{
50	$this->report = $report;
51	}
52	protected static function getClassNameFromClassId($rendererType)
53	{
54	return 'Piwik\\ReportRenderer\\' . self::normalizeRendererType($rendererType);
55	}
56	protected static function getInvalidClassIdExceptionMessage($rendererType)
57	{
58	return \Piwik\Piwik::translate('General_ExceptionInvalidReportRendererFormat', [self::normalizeRendererType($rendererType), implode(', ', self::$availableReportRenderers)]);
59	}
60	protected static function normalizeRendererType($rendererType)
61	{
62	return ucfirst(strtolower($rendererType));
63	}
64	/**
65	* Initialize locale settings.
66	* If not called, locale settings defaults to 'en'
67	*
68	* @param string $locale
69	*/
70	public abstract function setLocale($locale);
71	/**
72	* Save rendering to disk
73	*
74	* @param string $filename without path & without format extension
75	* @return string path of file
76	*/
77	public abstract function sendToDisk($filename);
78	/**
79	* Send rendering to browser with a 'download file' prompt
80	*
81	* @param string $filename without path & without format extension
82	*/
83	public abstract function sendToBrowserDownload($filename);
84	/**
85	* Output rendering to browser
86	*
87	* @param string $filename without path & without format extension
88	*/
89	public abstract function sendToBrowserInline($filename);
90	/**
91	* Get rendered report
92	*
93	* @return string
94	*/
95	public abstract function getRenderedReport();
96	/**
97	* Generate the first page.
98	*
99	* @param string $reportTitle
100	* @param string $prettyDate formatted date
101	* @param string $description
102	* @param array $reportMetadata metadata for all reports
103	* @param array $segment segment applied to all reports
104	*/
105	public abstract function renderFrontPage($reportTitle, $prettyDate, $description, $reportMetadata, $segment);
106	/**
107	* Render the provided report.
108	* Multiple calls to this method before calling getRenderedReport appends each report content.
109	*
110	* @param array $processedReport @see API::getProcessedReport()
111	*/
112	public abstract function renderReport($processedReport);
113	/**
114	* Get report attachments, ex. graph images
115	*
116	* @param $report
117	* @param $processedReports
118	* @param $prettyDate
119	* @return array
120	*/
121	public abstract function getAttachments($report, $processedReports, $prettyDate);
122	/**
123	* Append $extension to $filename
124	*
125	* @static
126	* @param string $filename
127	* @param string $extension
128	* @return string filename with extension
129	*/
130	protected static function makeFilenameWithExtension($filename, $extension)
131	{
132	// the filename can be used in HTTP headers, remove new lines to prevent HTTP header injection
133	$filename = str_replace(["\n", "\t"], " ", $filename);
134	return $filename . "." . $extension;
135	}
136	/**
137	* Return $filename with temp directory and delete file
138	*
139	* @static
140	* @param $filename
141	* @return string path of file in temp directory
142	*/
143	protected static function getOutputPath($filename)
144	{
145	$baseAssetsDir = StaticContainer::get('path.tmp') . '/assets/';
146	$outputFilename = $baseAssetsDir . $filename;
147	if (!is_dir($baseAssetsDir)) {
148	\Piwik\Filesystem::mkdir($baseAssetsDir);
149	}
150	@chmod($outputFilename, 0600);
151	if (file_exists($outputFilename)) {
152	@unlink($outputFilename);
153	}
154	return $outputFilename;
155	}
156	protected static function writeFile($filename, $extension, $content)
157	{
158	$filename = self::makeFilenameWithExtension($filename, $extension);
159	$outputFilename = self::getOutputPath($filename);
160	$bytesWritten = file_put_contents($outputFilename, $content);
161	if ($bytesWritten === \false) {
162	throw new Exception("ReportRenderer: Could not write to file '" . $outputFilename . "'.");
163	}
164	return $outputFilename;
165	}
166	/**
167	* Streaming a report writes response headers and body directly, so it is reserved for the
168	* top-level request. A report generated as a nested API sub-request must be returned to the
169	* calling request instead.
170	*
171	* @throws Exception
172	*/
173	public static function checkStreamingToBrowserIsAllowed() : void
174	{
175	if (Request::isCurrentApiRequestNestedInAnotherApiRequest()) {
176	throw new Exception('A report can only be sent to the browser by the top-level request.');
177	}
178	}
179	protected static function sendToBrowser($filename, $extension, $contentType, $content)
180	{
181	self::checkStreamingToBrowserIsAllowed();
182	$filename = \Piwik\ReportRenderer::makeFilenameWithExtension($filename, $extension);
183	\Piwik\ProxyHttp::overrideCacheControlHeaders();
184	\Piwik\Common::sendHeader('Content-Description: File Transfer');
185	\Piwik\Common::sendHeader('Content-Type: ' . $contentType);
186	\Piwik\Common::sendHeader('Content-Disposition: attachment; filename="' . str_replace('"', '\'', basename($filename)) . '";');
187	\Piwik\Common::sendHeader('Content-Length: ' . strlen($content));
188	echo $content;
189	}
190	protected static function inlineToBrowser($contentType, $content)
191	{
192	self::checkStreamingToBrowserIsAllowed();
193	\Piwik\Common::sendHeader('Content-Type: ' . $contentType);
194	echo $content;
195	}
196	/**
197	* Convert a dimension-less report to a multi-row two-column data table
198	*
199	* @static
200	* @param $reportMetadata array
201	* @param $report DataTable
202	* @param $reportColumns array
203	* @return array DataTable $report & array $columns
204	*/
205	protected static function processTableFormat($reportMetadata, $report, $reportColumns)
206	{
207	$finalReport = $report;
208	if (empty($reportMetadata['dimension'])) {
209	$simpleReportMetrics = $report->getFirstRow();
210	if ($simpleReportMetrics) {
211	$finalReport = new Simple();
212	foreach ($simpleReportMetrics->getColumns() as $metricId => $metric) {
213	$newRow = new Row();
214	$newRow->addColumn("label", $reportColumns[$metricId]);
215	$newRow->addColumn("value", $metric);
216	$finalReport->addRow($newRow);
217	}
218	}
219	$reportColumns = ['label' => \Piwik\Piwik::translate('General_Name'), 'value' => \Piwik\Piwik::translate('General_Value')];
220	}
221	return [$finalReport, $reportColumns];
222	}
223	public static function getStaticGraph($reportMetadata, $width, $height, $evolution, $segment)
224	{
225	$imageGraphUrl = $reportMetadata['imageGraphUrl'];
226	if ($evolution && !empty($reportMetadata['imageGraphEvolutionUrl'])) {
227	$imageGraphUrl = $reportMetadata['imageGraphEvolutionUrl'];
228	}
229	$queryString = \Piwik\Url::getQueryStringFromUrl($imageGraphUrl);
230	if (!is_string($queryString) \|\| $queryString === '') {
231	$queryString = $imageGraphUrl;
232	}
233	$requestGraph = \Piwik\UrlHelper::getArrayFromQueryString($queryString);
234	$requestGraph['outputType'] = API::GRAPH_OUTPUT_PHP;
235	$requestGraph['format'] = 'original';
236	$requestGraph['serialize'] = 0;
237	$requestGraph['filter_truncate'] = '';
238	$requestGraph['width'] = $width;
239	$requestGraph['height'] = $height;
240	if ($segment != null) {
241	$requestGraph['segment'] = urlencode($segment['definition']);
242	}
243	$request = new Request($requestGraph);
244	try {
245	$imageGraph = $request->process();
246	// Get image data as string
247	ob_start();
248	imagepng($imageGraph);
249	$imageGraphData = ob_get_contents();
250	ob_end_clean();
251	imagedestroy($imageGraph);
252	return $imageGraphData;
253	} catch (Exception $e) {
254	throw new Exception("ImageGraph API returned an error: " . $e->getMessage() . "\n");
255	}
256	}
257	}
258