VariableService::replaceTextVariablesSingle() - Code Metrics - Rello/analytics - Measure and Improve Code Quality continuously with Scrutinizer

VariableService::replaceTextVariablesSingle() B
last analyzed 2024-09-15 18:42 UTC

↳ Parent: VariableService

Complexity

Conditions	8
Paths	3

Size

Total Lines	20
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	8
eloc	14
c	1
b	0
f	0
nc	3
nop	1
dl	0
loc	20
rs	8.4444

<?php
/**
 * Analytics
 *
 * SPDX-FileCopyrightText: 2019-2022 Marcel Scherello
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Analytics\Service;

use OCA\Analytics\Db\DatasetMapper;
use OCP\IDateTimeFormatter;
filter:
    dependency_paths: ["lib/*"]
use Psr\Log\LoggerInterface;
filter:
    dependency_paths: ["lib/*"]

class VariableService {
	private $logger;
	private $DatasetMapper;
	private $IDateTimeFormatter;

	public function __construct(
		LoggerInterface    $logger,
		DatasetMapper      $DatasetMapper,
		IDateTimeFormatter $IDateTimeFormatter
	) {
		$this->logger = $logger;
		$this->DatasetMapper = $DatasetMapper;
		$this->IDateTimeFormatter = $IDateTimeFormatter;
	}

	/**
	 * replace %*% text variables in thresholds
	 *
	 * @param array $thresholds
	 * @return array
	 */
	public function replaceThresholdsVariables($thresholds) {
		foreach ($thresholds as &$threshold) {
			$fields = ['dimension1', 'dimension2'];
			foreach ($fields as $field) {
				isset($threshold[$field]) ? $name = $threshold[$field] : $name = '';
				$parsed = $this->parseFilter($name);
				if (!$parsed) break;

				$threshold[$field] = $parsed['6$startDate'];
			}
		}
		return $thresholds;
	}

	/**
	 * replace %*% text variables in name and subheader
	 *
	 * @param array $datasetMetadata
	 * @return array
	 */
	public function replaceTextVariables($datasetMetadata) {
		$fields = ['name', 'subheader'];
		foreach ($fields as $field) {
			isset($datasetMetadata[$field]) ? $name = $datasetMetadata[$field] : $name = '';

			preg_match_all("/%.*?%/", $name, $matches);
			if (count($matches[0]) > 0) {
				foreach ($matches[0] as $match) {
					$replace = null;
					if ($match === '%currentDate%') {
						$replace = $this->IDateTimeFormatter->formatDate(time(), 'short');
					} elseif ($match === '%currentTime%') {
						$replace = $this->IDateTimeFormatter->formatTime(time(), 'short');
					} elseif ($match === '%now%') {
						$replace = time();
					} elseif ($match === '%lastUpdateDate%') {
						$timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
						$replace = $this->IDateTimeFormatter->formatDate($timestamp, 'short');
					} elseif ($match === '%lastUpdateTime%') {
						$timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
						$replace = $this->IDateTimeFormatter->formatTime($timestamp, 'short');
					} elseif ($match === '%owner%') {
						$owner = $this->DatasetMapper->getOwner($datasetMetadata['dataset']);
						$replace = $owner;
					}
					if ($replace !== null) {
						$datasetMetadata[$field] = preg_replace('/' . $match . '/', $replace, $datasetMetadata[$field]);
					}
				}
			}
		}
		return $datasetMetadata;
	}

	/**
	 * replace variables in single field
	 * used in: API
	 *
	 * @param $field
	 * @return array
	 */
	public function replaceTextVariablesSingle($field) {
		if ($field !== null) {
			preg_match_all("/%.*?%/", $field, $matches);
			if (count($matches[0]) > 0) {
				foreach ($matches[0] as $match) {
					$replace = null;
					if ($match === '%currentDate%') {
						$replace = $this->IDateTimeFormatter->formatDate(time(), 'short');
					} elseif ($match === '%currentTime%') {
						$replace = $this->IDateTimeFormatter->formatTime(time(), 'short');
					} elseif ($match === '%now%') {
						$replace = time();
					}
					if ($replace !== null) {
						$field = preg_replace('/' . $match . '/', $replace, $field);
					}
				}
			}
		}
		return $field;
	}

	/**
	 * replace variables in single field
	 * used in: API
	 *
	 * @param $columns
	 * @return string
	 */
	public function replaceDatasourceColumns($columns) {
		$parsed = $this->parseFilter($columns);
		$format = $this->parseFormat($columns);
		if (!$parsed) return $columns;

		return date($format, $parsed['value']);
	}

	/**
	 * replace variables in filters and apply format
	 *
	 * @param $reportMetadata
	 * @return array
	 */
	public function replaceFilterVariables($reportMetadata) {
		if ($reportMetadata['filteroptions'] !== null) {
			$filteroptions = json_decode($reportMetadata['filteroptions'], true);
			if (isset($filteroptions['filter'])) {
				foreach ($filteroptions['filter'] as $key => $value) {
					$parsed = $this->parseFilter($value['value']);

					if (!$parsed) continue;


					// if a parser is selected in the chart options, it should also be valid here automatically
					if (isset($reportMetadata['chartoptions'])) {
						$chartOptions = json_decode($reportMetadata['chartoptions'], true);
						if (isset($chartOptions['scales']['xAxes']['time']['parser'])) {
							$format = $chartOptions['scales']['xAxes']['time']['parser'];

						}
					}
					$format = $this->parseFormat($value['value']);

					// translate commonly known X timestamp format to U for php
					if ($format === 'X') $format = 'U';

					$filteroptions['filter'][$key]['value'] = date($format, $parsed['value']);
					//$filteroptions['filter'][$key]['option'] = $parsed['option'];
				}
			}
			$reportMetadata['filteroptions'] = json_encode($filteroptions);
		}
		return $reportMetadata;
	}

	/**
	 * parsing of %*% variables
	 *
	 * @param $filter
	 * @return array|bool
	 */
	private function parseFilter($filter) {
		preg_match_all("/(?<=%).*(?=%)/", $filter, $matches);
		if (count($matches[0]) > 0) {
			$filter = $matches[0][0];
			preg_match('/(last|next|current|to|yester)?/', $filter, $directionMatch); // direction
			preg_match('/[0-9]+/', $filter, $offsetMatch); // how much
			preg_match('/(day|days|week|weeks|month|months|year|years)$/', $filter, $unitMatch); // unit

			if (!$directionMatch[0] || !$unitMatch[0]) {
				// no known text variables found
				return false;
			}

			// if no offset is specified, apply 1 as default
			!isset($offsetMatch[0]) ? $offset = 1 : $offset = $offsetMatch[0];

			// remove "s" to unify e.g. weeks => week
			$unit = rtrim($unitMatch[0], 's');

			if ($directionMatch[0] === "last" || $directionMatch[0] === "yester") {
				// go back
				$direction = '-';
			} elseif ($directionMatch[0] === "next") {
				// go forward
				$direction = '+';
			} else {
				// current
				$direction = '+';
				$offset = 0;
			}

			// create a usable string for php like "+3 days"
			$timeString = $direction . $offset . ' ' . $unit;
			// get a timestamp of the target date
			$baseDate = strtotime($timeString);

			// get the correct format depending of the unit. e.g. first day of the month in case unit is "month"
			if ($unit === 'day') {
				$startString = 'today';
			} else {
				$startString = 'first day of this ' . $unit;
			}
			$startTS = strtotime($startString, $baseDate);
			$start = date("Y-m-d", $startTS);

			$return = [
				'value' => $startTS,
				'option' => 'GT',
				'1$filter' => $filter,
				'2$timestring' => $timeString,
				'3$target' => $baseDate,
				'4$target_clean' => date("Y-m-d", $baseDate),
				'5$startString' => $startString,
				'6$startDate' => $start,
				'7$startTS' => $startTS,
			];
			//$this->logger->debug('parseFilter: '. json_encode($return));
		} else {
			$return = false;
		}
		return $return;
	}

	/**
	 * parsing of ( ) format instructions
	 *
	 * @param $filter
	 * @return string
	 */
	private function parseFormat($filter) {
		preg_match_all("/(?<=\().*(?=\))/", $filter, $matches);
		if (count($matches[0]) > 0) {
			return $matches[0][0];
		} else {
			return 'Y-m-d H:m:s';
		}
	}
}

1			<?php
2			/**
3			* Analytics
4			*
5			* SPDX-FileCopyrightText: 2019-2022 Marcel Scherello
6			* SPDX-License-Identifier: AGPL-3.0-or-later
7			*/
8
9			namespace OCA\Analytics\Service;
10
11			use OCA\Analytics\Db\DatasetMapper;
12			use OCP\IDateTimeFormatter;
			0 ignored issues – show Bug introduced 2023-08-25 06:43 UTC by Report Bug Copy Issue Report The type `OCP\IDateTimeFormatter` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
13			use Psr\Log\LoggerInterface;
			0 ignored issues – show Bug introduced 2023-08-25 06:43 UTC by Report Bug Copy Issue Report The type `Psr\Log\LoggerInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
14
15			class VariableService {
16			private $logger;
17			private $DatasetMapper;
18			private $IDateTimeFormatter;
19
20			public function __construct(
21			LoggerInterface $logger,
22			DatasetMapper $DatasetMapper,
23			IDateTimeFormatter $IDateTimeFormatter
24			) {
25			$this->logger = $logger;
26			$this->DatasetMapper = $DatasetMapper;
27			$this->IDateTimeFormatter = $IDateTimeFormatter;
28			}
29
30			/**
31			* replace %*% text variables in thresholds
32			*
33			* @param array $thresholds
34			* @return array
35			*/
36			public function replaceThresholdsVariables($thresholds) {
37			foreach ($thresholds as &$threshold) {
38			$fields = ['dimension1', 'dimension2'];
39			foreach ($fields as $field) {
40			isset($threshold[$field]) ? $name = $threshold[$field] : $name = '';
41			$parsed = $this->parseFilter($name);
42			if (!$parsed) break;
			0 ignored issues – show Bug Best Practice introduced 2022-03-06 18:44 UTC by Report Bug Copy Issue Report The expression `$parsed` of type `array<string,integer\|mixed\|string>` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
43			$threshold[$field] = $parsed['6$startDate'];
44			}
45			}
46			return $thresholds;
47			}
48
49			/**
50			* replace %*% text variables in name and subheader
51			*
52			* @param array $datasetMetadata
53			* @return array
54			*/
55			public function replaceTextVariables($datasetMetadata) {
56			$fields = ['name', 'subheader'];
57			foreach ($fields as $field) {
58			isset($datasetMetadata[$field]) ? $name = $datasetMetadata[$field] : $name = '';
59
60			preg_match_all("/%.*?%/", $name, $matches);
61			if (count($matches[0]) > 0) {
62			foreach ($matches[0] as $match) {
63			$replace = null;
64			if ($match === '%currentDate%') {
65			$replace = $this->IDateTimeFormatter->formatDate(time(), 'short');
66			} elseif ($match === '%currentTime%') {
67			$replace = $this->IDateTimeFormatter->formatTime(time(), 'short');
68			} elseif ($match === '%now%') {
69			$replace = time();
70			} elseif ($match === '%lastUpdateDate%') {
71			$timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
72			$replace = $this->IDateTimeFormatter->formatDate($timestamp, 'short');
73			} elseif ($match === '%lastUpdateTime%') {
74			$timestamp = $this->DatasetMapper->getLastUpdate($datasetMetadata['dataset']);
75			$replace = $this->IDateTimeFormatter->formatTime($timestamp, 'short');
76			} elseif ($match === '%owner%') {
77			$owner = $this->DatasetMapper->getOwner($datasetMetadata['dataset']);
78			$replace = $owner;
79			}
80			if ($replace !== null) {
81			$datasetMetadata[$field] = preg_replace('/' . $match . '/', $replace, $datasetMetadata[$field]);
82			}
83			}
84			}
85			}
86			return $datasetMetadata;
87			}
88
89			/**
90			* replace variables in single field
91			* used in: API
92			*
93			* @param $field
94			* @return array
95			*/
96			public function replaceTextVariablesSingle($field) {
97			if ($field !== null) {
98			preg_match_all("/%.*?%/", $field, $matches);
99			if (count($matches[0]) > 0) {
100			foreach ($matches[0] as $match) {
101			$replace = null;
102			if ($match === '%currentDate%') {
103			$replace = $this->IDateTimeFormatter->formatDate(time(), 'short');
104			} elseif ($match === '%currentTime%') {
105			$replace = $this->IDateTimeFormatter->formatTime(time(), 'short');
106			} elseif ($match === '%now%') {
107			$replace = time();
108			}
109			if ($replace !== null) {
110			$field = preg_replace('/' . $match . '/', $replace, $field);
111			}
112			}
113			}
114			}
115			return $field;
116			}
117
118			/**
119			* replace variables in single field
120			* used in: API
121			*
122			* @param $columns
123			* @return string
124			*/
125			public function replaceDatasourceColumns($columns) {
126			$parsed = $this->parseFilter($columns);
127			$format = $this->parseFormat($columns);
128			if (!$parsed) return $columns;
			0 ignored issues – show introduced 2023-07-14 21:38 UTC by Report Bug Copy Issue Report `$parsed` is a non-empty array, thus `! $parsed` is always `false`. Loading history... Bug Best Practice introduced 2022-09-05 20:03 UTC by Report Bug Copy Issue Report The expression `$parsed` of type `array<string,integer\|mixed\|string>` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
129			return date($format, $parsed['value']);
130			}
131
132			/**
133			* replace variables in filters and apply format
134			*
135			* @param $reportMetadata
136			* @return array
137			*/
138			public function replaceFilterVariables($reportMetadata) {
139			if ($reportMetadata['filteroptions'] !== null) {
140			$filteroptions = json_decode($reportMetadata['filteroptions'], true);
141			if (isset($filteroptions['filter'])) {
142			foreach ($filteroptions['filter'] as $key => $value) {
143			$parsed = $this->parseFilter($value['value']);
144
145			if (!$parsed) continue;
			0 ignored issues – show Bug Best Practice introduced 2023-07-14 21:38 UTC by Report Bug Copy Issue Report The expression `$parsed` of type `array<string,integer\|mixed\|string>` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
146
147			// if a parser is selected in the chart options, it should also be valid here automatically
148			if (isset($reportMetadata['chartoptions'])) {
149			$chartOptions = json_decode($reportMetadata['chartoptions'], true);
150			if (isset($chartOptions['scales']['xAxes']['time']['parser'])) {
151			$format = $chartOptions['scales']['xAxes']['time']['parser'];
			0 ignored issues – show Unused Code introduced 2024-04-04 21:49 UTC by Report Bug Copy Issue Report The assignment to `$format` is dead and can be removed. Loading history...
152			}
153			}
154			$format = $this->parseFormat($value['value']);
155
156			// translate commonly known X timestamp format to U for php
157			if ($format === 'X') $format = 'U';
158
159			$filteroptions['filter'][$key]['value'] = date($format, $parsed['value']);
160			//$filteroptions['filter'][$key]['option'] = $parsed['option'];
161			}
162			}
163			$reportMetadata['filteroptions'] = json_encode($filteroptions);
164			}
165			return $reportMetadata;
166			}
167
168			/**
169			* parsing of %*% variables
170			*
171			* @param $filter
172			* @return array\|bool
173			*/
174			private function parseFilter($filter) {
175			preg_match_all("/(?<=%).*(?=%)/", $filter, $matches);
176			if (count($matches[0]) > 0) {
177			$filter = $matches[0][0];
178			preg_match('/(last\|next\|current\|to\|yester)?/', $filter, $directionMatch); // direction
179			preg_match('/[0-9]+/', $filter, $offsetMatch); // how much
180			preg_match('/(day\|days\|week\|weeks\|month\|months\|year\|years)$/', $filter, $unitMatch); // unit
181
182			if (!$directionMatch[0] \|\| !$unitMatch[0]) {
183			// no known text variables found
184			return false;
185			}
186
187			// if no offset is specified, apply 1 as default
188			!isset($offsetMatch[0]) ? $offset = 1 : $offset = $offsetMatch[0];
189
190			// remove "s" to unify e.g. weeks => week
191			$unit = rtrim($unitMatch[0], 's');
192
193			if ($directionMatch[0] === "last" \|\| $directionMatch[0] === "yester") {
194			// go back
195			$direction = '-';
196			} elseif ($directionMatch[0] === "next") {
197			// go forward
198			$direction = '+';
199			} else {
200			// current
201			$direction = '+';
202			$offset = 0;
203			}
204
205			// create a usable string for php like "+3 days"
206			$timeString = $direction . $offset . ' ' . $unit;
207			// get a timestamp of the target date
208			$baseDate = strtotime($timeString);
209
210			// get the correct format depending of the unit. e.g. first day of the month in case unit is "month"
211			if ($unit === 'day') {
212			$startString = 'today';
213			} else {
214			$startString = 'first day of this ' . $unit;
215			}
216			$startTS = strtotime($startString, $baseDate);
217			$start = date("Y-m-d", $startTS);
218
219			$return = [
220			'value' => $startTS,
221			'option' => 'GT',
222			'1$filter' => $filter,
223			'2$timestring' => $timeString,
224			'3$target' => $baseDate,
225			'4$target_clean' => date("Y-m-d", $baseDate),
226			'5$startString' => $startString,
227			'6$startDate' => $start,
228			'7$startTS' => $startTS,
229			];
230			//$this->logger->debug('parseFilter: '. json_encode($return));
231			} else {
232			$return = false;
233			}
234			return $return;
235			}
236
237			/**
238			* parsing of ( ) format instructions
239			*
240			* @param $filter
241			* @return string
242			*/
243			private function parseFormat($filter) {
244			preg_match_all("/(?<=\().*(?=\))/", $filter, $matches);
245			if (count($matches[0]) > 0) {
246			return $matches[0][0];
247			} else {
248			return 'Y-m-d H:m:s';
249			}
250			}
251			}

Rello / analytics

VariableService::replaceTextVariablesSingle() B last analyzed 2024-09-15 18:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

VariableService::replaceTextVariablesSingle() B
last analyzed 2024-09-15 18:42 UTC