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

matomo / app / core / ReportRenderer.php

matomo / app / core Last commit date

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

ReportRenderer.php

228 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	public abstract function getRenderedReport();
94	/**
95	* Generate the first page.
96	*
97	* @param string $reportTitle
98	* @param string $prettyDate formatted date
99	* @param string $description
100	* @param array $reportMetadata metadata for all reports
101	* @param array $segment segment applied to all reports
102	*/
103	public abstract function renderFrontPage($reportTitle, $prettyDate, $description, $reportMetadata, $segment);
104	/**
105	* Render the provided report.
106	* Multiple calls to this method before calling outputRendering appends each report content.
107	*
108	* @param array $processedReport @see API::getProcessedReport()
109	*/
110	public abstract function renderReport($processedReport);
111	/**
112	* Get report attachments, ex. graph images
113	*
114	* @param $report
115	* @param $processedReports
116	* @param $prettyDate
117	* @return array
118	*/
119	public abstract function getAttachments($report, $processedReports, $prettyDate);
120	/**
121	* Append $extension to $filename
122	*
123	* @static
124	* @param string $filename
125	* @param string $extension
126	* @return string filename with extension
127	*/
128	protected static function makeFilenameWithExtension($filename, $extension)
129	{
130	// the filename can be used in HTTP headers, remove new lines to prevent HTTP header injection
131	$filename = str_replace(["\n", "\t"], " ", $filename);
132	return $filename . "." . $extension;
133	}
134	/**
135	* Return $filename with temp directory and delete file
136	*
137	* @static
138	* @param $filename
139	* @return string path of file in temp directory
140	*/
141	protected static function getOutputPath($filename)
142	{
143	$baseAssetsDir = StaticContainer::get('path.tmp') . '/assets/';
144	$outputFilename = $baseAssetsDir . $filename;
145	if (!is_dir($baseAssetsDir)) {
146	\Piwik\Filesystem::mkdir($baseAssetsDir);
147	}
148	@chmod($outputFilename, 0600);
149	if (file_exists($outputFilename)) {
150	@unlink($outputFilename);
151	}
152	return $outputFilename;
153	}
154	protected static function writeFile($filename, $extension, $content)
155	{
156	$filename = self::makeFilenameWithExtension($filename, $extension);
157	$outputFilename = self::getOutputPath($filename);
158	$bytesWritten = file_put_contents($outputFilename, $content);
159	if ($bytesWritten === \false) {
160	throw new Exception("ReportRenderer: Could not write to file '" . $outputFilename . "'.");
161	}
162	return $outputFilename;
163	}
164	protected static function sendToBrowser($filename, $extension, $contentType, $content)
165	{
166	$filename = \Piwik\ReportRenderer::makeFilenameWithExtension($filename, $extension);
167	\Piwik\ProxyHttp::overrideCacheControlHeaders();
168	\Piwik\Common::sendHeader('Content-Description: File Transfer');
169	\Piwik\Common::sendHeader('Content-Type: ' . $contentType);
170	\Piwik\Common::sendHeader('Content-Disposition: attachment; filename="' . str_replace('"', '\'', basename($filename)) . '";');
171	\Piwik\Common::sendHeader('Content-Length: ' . strlen($content));
172	echo $content;
173	}
174	protected static function inlineToBrowser($contentType, $content)
175	{
176	\Piwik\Common::sendHeader('Content-Type: ' . $contentType);
177	echo $content;
178	}
179	/**
180	* Convert a dimension-less report to a multi-row two-column data table
181	*
182	* @static
183	* @param $reportMetadata array
184	* @param $report DataTable
185	* @param $reportColumns array
186	* @return array DataTable $report & array $columns
187	*/
188	protected static function processTableFormat($reportMetadata, $report, $reportColumns)
189	{
190	$finalReport = $report;
191	if (empty($reportMetadata['dimension'])) {
192	$simpleReportMetrics = $report->getFirstRow();
193	if ($simpleReportMetrics) {
194	$finalReport = new Simple();
195	foreach ($simpleReportMetrics->getColumns() as $metricId => $metric) {
196	$newRow = new Row();
197	$newRow->addColumn("label", $reportColumns[$metricId]);
198	$newRow->addColumn("value", $metric);
199	$finalReport->addRow($newRow);
200	}
201	}
202	$reportColumns = ['label' => \Piwik\Piwik::translate('General_Name'), 'value' => \Piwik\Piwik::translate('General_Value')];
203	}
204	return [$finalReport, $reportColumns];
205	}
206	public static function getStaticGraph($reportMetadata, $width, $height, $evolution, $segment)
207	{
208	$imageGraphUrl = $reportMetadata['imageGraphUrl'];
209	if ($evolution && !empty($reportMetadata['imageGraphEvolutionUrl'])) {
210	$imageGraphUrl = $reportMetadata['imageGraphEvolutionUrl'];
211	}
212	$requestGraph = $imageGraphUrl . '&outputType=' . API::GRAPH_OUTPUT_PHP . '&format=original&serialize=0' . '&filter_truncate=' . '&width=' . $width . '&height=' . $height . ($segment != null ? '&segment=' . urlencode($segment['definition']) : '');
213	$request = new Request($requestGraph);
214	try {
215	$imageGraph = $request->process();
216	// Get image data as string
217	ob_start();
218	imagepng($imageGraph);
219	$imageGraphData = ob_get_contents();
220	ob_end_clean();
221	imagedestroy($imageGraph);
222	return $imageGraphData;
223	} catch (Exception $e) {
224	throw new Exception("ImageGraph API returned an error: " . $e->getMessage() . "\n");
225	}
226	}
227	}
228