File size: 4,351 Bytes
78185c4 | 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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | <?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
declare(strict_types=1);
namespace Piwik\Plugins\BotTracking\Reports;
use Piwik\DataTable;
use Piwik\Piwik;
use Piwik\Plugin\Report;
use Piwik\Plugin\ViewDataTable;
use Piwik\Plugins\BotTracking\Columns\Metrics\AvgResponseSize;
use Piwik\Plugins\BotTracking\Columns\Metrics\AvgServerTime;
use Piwik\Plugins\BotTracking\Columns\Metrics\PageNotFound404Requests;
use Piwik\Plugins\BotTracking\Columns\Metrics\Requests;
use Piwik\Plugins\BotTracking\Columns\Metrics\ServerError5xxRequests;
use Piwik\Plugins\BotTracking\Metrics;
use Piwik\Report\ReportWidgetFactory;
use Piwik\Widget\WidgetsList;
/**
* Base class for the Pages and Documents content-URL reports.
*
* Owns the shared metric set, configureView() defaults, configureWidgets(), and the per-report
* scoped Requests documentation override. The error-status columns (page_not_found_404_requests,
* server_error_5xx_requests) are registered in $this->metrics so they remain available via the
* API, Custom Alerts, Scheduled Reports and Row Evolution — but the "show all columns" table
* toggle is disabled because that view uses the Visitor Engagement preset which doesn't match
* the BotTracking column schema (and would render an empty table).
*
* GetAIChatbotBrokenContent stays as a direct Report subclass — it has a different metric shape.
*/
abstract class AbstractAIChatbotContentUrlReport extends Report
{
protected function init(): void
{
parent::init();
$this->categoryId = 'General_AIAssistants';
$this->subcategoryId = 'BotTracking_AIChatbotsContentRequests';
$this->metrics = [new Requests(), new ServerError5xxRequests(), new PageNotFound404Requests()];
$this->processedMetrics = [new AvgServerTime(), new AvgResponseSize()];
$this->defaultSortColumn = Metrics::COLUMN_REQUESTS;
}
public function configureView(ViewDataTable $view): void
{
parent::configureView($view);
$view->config->setDefaultColumnsToDisplay(
['label', Metrics::COLUMN_REQUESTS, Metrics::COLUMN_AVG_SERVER_TIME, Metrics::COLUMN_AVG_RESPONSE_SIZE],
false,
false
);
// Show-all-columns switches to the Visitor Engagement preset, which doesn't fit this schema.
$view->config->show_table_all_columns = false;
// Insights and bar/pie/tag-cloud all assume visit metrics (nb_visits etc.) this report lacks,
// so they would render empty — the table is the only useful view.
$view->config->show_insights = false;
$view->config->show_bar_chart = false;
$view->config->show_pie_chart = false;
$view->config->show_tag_cloud = false;
// Render URL labels as clickable links (scheme-less normalized URLs; prepend https://).
$view->config->filters[] = function (DataTable $table) {
foreach ($table->getRows() as $row) {
if ($row->isSummaryRow()) {
continue;
}
$label = $row->getColumn('label');
if (is_string($label) && $label !== '') {
$row->setMetadata('url', 'https://' . $label);
}
}
};
SegmentNotSupportedMessageHelper::addSegmentNotSupportedMessage($view);
}
public function configureWidgets(WidgetsList $widgetsList, ReportWidgetFactory $factory): void
{
$widgetsList->addWidgetConfig($factory->createWidget()->setIsWide());
}
/**
* Returns the translation key for the scoped "Requests" tooltip for this report.
* Concrete subclasses return the key that scopes the tooltip to their action type
* (page URLs or document URLs).
*/
abstract protected function getRequestsDocumentationKey(): string;
/**
* @return array<string, string>
*/
public function getMetricsDocumentation(): array
{
$docs = parent::getMetricsDocumentation();
// Scope the "Requests" tooltip to this report's action type (page URLs or document URLs).
$docs[Metrics::COLUMN_REQUESTS] = Piwik::translate($this->getRequestsDocumentationKey());
return $docs;
}
}
|