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

matomo / app / core / ReportRenderer.php

matomo / app / core Last commit date

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

ReportRenderer.php

229 lines

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