From be2b23f83078b661b2c93d3faf7c192d862821ff Mon Sep 17 00:00:00 2001
From: Tim van Dijen <tvdijen@gmail.com>
Date: Sun, 16 Dec 2018 13:55:14 +0100
Subject: [PATCH] Add controler for statistics module
---
.../statistics/lib/StatisticsController.php | 233 ++++++++++++++++++
modules/statistics/routes.yaml | 6 +
2 files changed, 239 insertions(+)
create mode 100644 modules/statistics/lib/StatisticsController.php
create mode 100644 modules/statistics/routes.yaml
diff --git a/modules/statistics/lib/StatisticsController.php b/modules/statistics/lib/StatisticsController.php
new file mode 100644
index 000000000..f57f9e732
--- /dev/null
+++ b/modules/statistics/lib/StatisticsController.php
@@ -0,0 +1,233 @@
+<?php
+
+namespace SimpleSAML\Module\statistics;
+
+use SimpleSAML\HTTP\RunnableResponse;
+use SimpleSAML\Locale\Translate;
+use SimpleSAML\Utils\HTTP;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Controller class for the statistics module.
+ *
+ * This class serves the statistics views available in the module.
+ *
+ * @package SimpleSAML\Module\admin
+ */
+class StatisticsController
+{
+ /** @var \SimpleSAML\Configuration */
+ protected $config;
+
+ /** @var \SimpleSAML\Configuration */
+ protected $moduleConfig;
+
+ /** @var \SimpleSAML\Session */
+ protected $session;
+
+
+ /**
+ * StatisticsController constructor.
+ *
+ * @param \SimpleSAML\Configuration $config The configuration to use.
+ * @param \SimpleSAML\Session $session The current user session.
+ */
+ public function __construct(\SimpleSAML\Configuration $config, \SimpleSAML\Session $session)
+ {
+ $this->config = $config;
+ $this->moduleConfig = \SimpleSAML\Configuration::getConfig('module_statistics.php');
+ $this->session = $session;
+ }
+
+
+ /**
+ * Display statistics metadata.
+ *
+ * @param Request $request The current request.
+ *
+ * @return \SimpleSAML\XHTML\Template
+ */
+ public function metadata(Request $request)
+ {
+ \SimpleSAML\Module\statistics\AccessCheck::checkAccess($this->moduleConfig);
+
+ $aggr = new \SimpleSAML\Module\statistics\Aggregator();
+ $aggr->loadMetadata();
+ $metadata = $aggr->getMetadata();
+
+ if ($metadata !== null) {
+ if (in_array('lastrun', $metadata, true)) {
+ $metadata['lastrun'] = date('l jS \of F Y H:i:s', $metadata['lastrun']);
+ }
+ if (in_array('notBefore', $metadata, true)) {
+ $metadata['notBefore'] = date('l jS \of F Y H:i:s', $metadata['notBefore']);
+ }
+ if (in_array('memory', $metadata, true)) {
+ $metadata['memory'] = number_format($metadata['memory'] / (1024 * 1024), 2);
+ }
+ }
+
+ $t = new \SimpleSAML\XHTML\Template($this->config, 'statistics:statmeta.twig');
+ $t->data = [
+ 'metadata' => $metadata,
+ ];
+
+ return $t;
+ }
+
+
+ /**
+ * Display the main admin page.
+ *
+ * @return \SimpleSAML\XHTML\Template
+ */
+ public function main(Request $request)
+ {
+ \SimpleSAML\Module\statistics\AccessCheck::checkAccess($this->moduleConfig);
+
+ /*
+ * Check input parameters
+ */
+ $preferRule = $request->query->get('rule');
+ $preferRule2 = $request->query->get('rule2');
+ if ($preferRule2 === '_') {
+ $preferRule2 = null;
+ }
+
+ $preferTime = $request->query->get('time');
+ $preferTimeRes = $request->query->get('res');
+ $delimiter = $request->query->get('delimiler');
+
+ /*
+ * Create statistics data.
+ */
+ $ruleset = new \SimpleSAML\Module\statistics\Ruleset($this->moduleConfig);
+ $statrule = $ruleset->getRule($preferRule);
+ $rule = $statrule->getRuleID();
+
+ /*
+ * Prepare template.
+ */
+ $t = new \SimpleSAML\XHTML\Template($this->config, 'statistics:statistics.twig');
+ $t->data = [
+ 'delimiter' => $delimiter,
+ 'pageid' => 'statistics',
+ 'header' => 'stat',
+ 'available_rules' => $ruleset->availableRulesNames(),
+ 'selected_rule' => $rule,
+ 'selected_rule2' => $preferRule2,
+ ];
+
+ try {
+ $dataset = $statrule->getDataset($preferTimeRes, $preferTime);
+ $dataset->setDelimiter($delimiter);
+ $dataset->aggregateSummary();
+ $dataset->calculateMax();
+ } catch (\Exception $e) {
+ $t->data['error'] = "No data available";
+ return $t;
+ }
+
+ $delimiter = $dataset->getDelimiter();
+ $timeres = $dataset->getTimeRes();
+ $fileslot = $dataset->getFileslot();
+ $availableFileSlots = $statrule->availableFileSlots($timeres);
+ $timeNavigation = $statrule->getTimeNavigation($timeres, $preferTime);
+ $piedata = $dataset->getPieData();
+ $datasets = [$dataset->getPercentValues()];
+ $axis = $dataset->getAxis();
+ $maxes = [$dataset->getMax()];
+
+ $t->data['selected_rule'] = $rule;
+ $t->data['selected_time'] = $fileslot;
+ $t->data['selected_timeres'] = $timeres;
+ $t->data['post_d'] = $this->getBaseURL($t, 'post', 'd');
+ if (isset($preferRule2)) {
+ $statrule = $ruleset->getRule($preferRule2);
+ try {
+ $dataset2 = $statrule->getDataset($preferTimeRes, $preferTime);
+ $dataset2->aggregateSummary();
+ $dataset2->calculateMax();
+ $datasets[] = $dataset2->getPercentValues();
+ $maxes[] = $dataset2->getMax();
+
+ if ($request->query->get('format') === 'csv') {
+ header('Content-type: text/csv');
+ header('Content-Disposition: attachment; filename="simplesamlphp-data.csv"');
+ $data = $dataset->getDebugData();
+ foreach ($data as $de) {
+ if (isset($de[1])) {
+ echo '"'.$de[0].'",'.$de[1]."\n";
+ }
+ }
+ exit;
+ } else {
+ $t->data['error'] = 'Export format not supported';
+ return $t;
+ }
+ } catch (\Exception $e) {
+ $t->data['error'] = "No data available to compare";
+ return $t;
+ }
+ }
+
+ $dimx = $this->moduleConfig->getValue('dimension.x', 800);
+ $dimy = $this->moduleConfig->getValue('dimension.y', 350);
+ $grapher = new \SimpleSAML\Module\statistics\Graph\GoogleCharts($dimx, $dimy);
+ $t->data['imgurl'] = $grapher->show($axis['axis'], $axis['axispos'], $datasets, $maxes);
+
+ if (isset($piedata)) {
+ $t->data['pieimgurl'] = $grapher->showPie($dataset->getDelimiterPresentationPie(), $piedata);
+ }
+
+ $t->data['available_rules'] = $ruleset->availableRulesNames();
+ $t->data['available_times'] = $statrule->availableFileSlots($timeres);
+ $t->data['available_timeres'] = $statrule->availableTimeRes();
+ $t->data['available_times_prev'] = $timeNavigation['prev'];
+ $t->data['available_times_next'] = $timeNavigation['next'];
+ $t->data['current_rule'] = $t->data['available_rules'][$rule];
+ $t->data['selected_rule2'] = $preferRule2;
+ $t->data['selected_delimiter'] = $delimiter;
+ $t->data['debugdata'] = $dataset->getDebugData();
+ $t->data['results'] = $dataset->getResults();
+ $t->data['summaryDataset'] = $dataset->getSummary();
+ $t->data['topdelimiters'] = $dataset->getTopDelimiters();
+ $t->data['post_rule'] = $this->getBaseURL($t, 'post', 'rule');
+ $t->data['post_rule2'] = $this->getBaseURL($t, 'post', 'rule2');
+ $t->data['post_res'] = $this->getBaseURL($t, 'post', 'res');
+ $t->data['post_time'] = $this->getBaseURL($t, 'post', 'time');
+ $t->data['get_times_prev'] = $this->getBaseURL($t, 'get', 'time', $t->data['available_times_prev']);
+ $t->data['get_times_next'] = $this->getBaseURL($t, 'get', 'time', $t->data['available_times_next']);
+ $t->data['availdelimiters'] = $dataset->availDelimiters();
+ $t->data['delimiterPresentation'] = $dataset->getDelimiterPresentation();
+
+ return $t;
+ }
+
+ private function getBaseURL($t, $type = 'get', $key = null, $value = null)
+ {
+ $vars = [
+ 'rule' => $t->data['selected_rule'],
+ 'time' => $t->data['selected_time'],
+ 'res' => $t->data['selected_timeres'],
+ ];
+ if (isset($t->data['selected_delimiter'])) {
+ $vars['d'] = $t->data['selected_delimiter'];
+ }
+ if (!empty($t->data['selected_rule2']) && $t->data['selected_rule2'] !== '_') {
+ $vars['rule2'] = $t->data['selected_rule2'];
+ }
+ if (isset($key)) {
+ if (isset($vars[$key])) {
+ unset($vars[$key]);
+ }
+ if (isset($value)) {
+ $vars[$key] = $value;
+ }
+ }
+ if ($type === 'get') {
+ return \SimpleSAML\Module::getModuleURL("statistics/showstats.php").'?'.http_build_query($vars, '', '&');
+ }
+ return $vars;
+ }
+}
diff --git a/modules/statistics/routes.yaml b/modules/statistics/routes.yaml
new file mode 100644
index 000000000..e0fa51ae9
--- /dev/null
+++ b/modules/statistics/routes.yaml
@@ -0,0 +1,6 @@
+statistics-main:
+ path: /
+ defaults: { _controller: 'SimpleSAML\Module\statistics\StatisticsController::main' }
+statistics-metadata:
+ path: /metadata
+ defaults: { _controller: 'SimpleSAML\Module\statistics\StatisticsController::metadata' }
--
GitLab