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

matomo / app / core / ReportRenderer.php

matomo / app / core Last commit date

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

ReportRenderer.php

243 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	protected static function sendToBrowser($filename, $extension, $contentType, $content)
167	{
168	$filename = \Piwik\ReportRenderer::makeFilenameWithExtension($filename, $extension);
169	\Piwik\ProxyHttp::overrideCacheControlHeaders();
170	\Piwik\Common::sendHeader('Content-Description: File Transfer');
171	\Piwik\Common::sendHeader('Content-Type: ' . $contentType);
172	\Piwik\Common::sendHeader('Content-Disposition: attachment; filename="' . str_replace('"', '\'', basename($filename)) . '";');
173	\Piwik\Common::sendHeader('Content-Length: ' . strlen($content));
174	echo $content;
175	}
176	protected static function inlineToBrowser($contentType, $content)
177	{
178	\Piwik\Common::sendHeader('Content-Type: ' . $contentType);
179	echo $content;
180	}
181	/**
182	* Convert a dimension-less report to a multi-row two-column data table
183	*
184	* @static
185	* @param $reportMetadata array
186	* @param $report DataTable
187	* @param $reportColumns array
188	* @return array DataTable $report & array $columns
189	*/
190	protected static function processTableFormat($reportMetadata, $report, $reportColumns)
191	{
192	$finalReport = $report;
193	if (empty($reportMetadata['dimension'])) {
194	$simpleReportMetrics = $report->getFirstRow();
195	if ($simpleReportMetrics) {
196	$finalReport = new Simple();
197	foreach ($simpleReportMetrics->getColumns() as $metricId => $metric) {
198	$newRow = new Row();
199	$newRow->addColumn("label", $reportColumns[$metricId]);
200	$newRow->addColumn("value", $metric);
201	$finalReport->addRow($newRow);
202	}
203	}
204	$reportColumns = ['label' => \Piwik\Piwik::translate('General_Name'), 'value' => \Piwik\Piwik::translate('General_Value')];
205	}
206	return [$finalReport, $reportColumns];
207	}
208	public static function getStaticGraph($reportMetadata, $width, $height, $evolution, $segment)
209	{
210	$imageGraphUrl = $reportMetadata['imageGraphUrl'];
211	if ($evolution && !empty($reportMetadata['imageGraphEvolutionUrl'])) {
212	$imageGraphUrl = $reportMetadata['imageGraphEvolutionUrl'];
213	}
214	$queryString = \Piwik\Url::getQueryStringFromUrl($imageGraphUrl);
215	if (!is_string($queryString) \|\| $queryString === '') {
216	$queryString = $imageGraphUrl;
217	}
218	$requestGraph = \Piwik\UrlHelper::getArrayFromQueryString($queryString);
219	$requestGraph['outputType'] = API::GRAPH_OUTPUT_PHP;
220	$requestGraph['format'] = 'original';
221	$requestGraph['serialize'] = 0;
222	$requestGraph['filter_truncate'] = '';
223	$requestGraph['width'] = $width;
224	$requestGraph['height'] = $height;
225	if ($segment != null) {
226	$requestGraph['segment'] = urlencode($segment['definition']);
227	}
228	$request = new Request($requestGraph);
229	try {
230	$imageGraph = $request->process();
231	// Get image data as string
232	ob_start();
233	imagepng($imageGraph);
234	$imageGraphData = ob_get_contents();
235	ob_end_clean();
236	imagedestroy($imageGraph);
237	return $imageGraphData;
238	} catch (Exception $e) {
239	throw new Exception("ImageGraph API returned an error: " . $e->getMessage() . "\n");
240	}
241	}
242	}
243