<?php
// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
//
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
// $Id: wikiplugin_gauge.php 66112 2018-04-19 18:28:31Z luciash $

function wikiplugin_gauge_info()
{
	return [
		'name' => tra('Gauge'),
		'documentation' => 'PluginGauge',
		'description' => tra('Display a horizontal bar gauge'),
		'prefs' => ['wikiplugin_gauge'],
		'body' => tra('description'),
		'iconname' => 'chart',
		'tags' => [ 'basic' ],
		'format' => 'html',
		'introduced' => 1,
		'params' => [
			'value' => [
				'required' => true,
				'name' => tra('Value'),
				'description' => tra('Current value to be represented by the gauge'),
				'since' => '1',
				'filter' => 'digits',
				'default' => ''
			],
			'max' => [
				'required' => false,
				'name' => tra('Maximum Value'),
				'description' => tr('Maximum possible value. Default: %0', '<code>100</code>'),
				'since' => '1',
				'filter' => 'digits',
				'default' => 100
			],
			'label' => [
				'required' => false,
				'name' => tra('Label'),
				'description' => tra('Label displayed on the left side of the gauge.'),
				'since' => '1',
				'filter' => 'text',
				'default' => ''
			],
			'color' => [
				'required' => false,
				'name' => tra('Color'),
				'description' => tra('Main color of the gauge. Use HTML color codes or names.'),
				'since' => '1',
				'filter' => 'text',
				'accepted' => tra('Valid CSS color name or hex code'),
				'default' => '#FF0000'
			],
			'bgcolor' => [
				'required' => false,
				'name' => tra('Background Color'),
				'description' => tra('Background color of the gauge. Use HTML color codes or names.'),
				'since' => '1',
				'filter' => 'text',
				'accepted' => tra('Valid CSS color name or hex code'),
				'default' => '#0000FF'
			],
			'size' => [
				'required' => false,
				'name' => tra('Width'),
				'description' => tra('Bar width in pixels.'),
				'since' => '1',
				'filter' => 'digits',
				'default' => 150
			],
			'labelsize' => [
				'required' => false,
				'name' => tra('Label Width'),
				'description' => tra('Label width, in pixels.'),
				'since' => '1',
				'filter' => 'digits',
				'default' => 50
			],
			'perc' => [
				'required' => false,
				'name' => tra('Display Percentage'),
				'description' => tr('Set to %0 (Yes) to display a percentage of the maximum.', '<code>true</code>'),
				'since' => '1',
				'default' => false,
				'options' => [
					['text' => '', 'value' => ''],
					['text' => tra('Yes'), 'value' => true],
					['text' => tra('No'), 'value' => false]
				]
			],
			'showvalue' => [
				'required' => false,
				'name' => tra('Display Value'),
				'description' => tr('Set to %1 (No) to hide the numeric value (shown by default).', '<code>false</code>'),
				'default' => true,
				'since' => '3.0',
				'options' => [
					['text' => '', 'value' => ''],
					['text' => tra('Yes'), 'value' => true],
					['text' => tra('No'), 'value' => false]
				]
			],
			'height' => [
				'required' => false,
				'name' => tra('Height'),
				'description' => tra('Bar height in pixels.'),
				'since' => '1',
				'filter' => 'digits',
				'default' => 14
			],
		],
	];
}

function wikiplugin_gauge($data, $params)
{
	extract($params, EXTR_SKIP);

	if (! isset($value)) {
		return ("<b>missing value parameter for plugin</b><br />");
	}

	if (! isset($size)) {
		$size = 150;
	}

	if (! isset($height)) {
		$height = 14;
	}

	if (! isset($bgcolor)) {
		$bgcolor = '#0000FF';
	}

	if (! isset($color)) {
		$color = '#FF0000';
	}

	if (! isset($perc)) {
		$perc = false;
	}

	if (isset($showvalue) && $showvalue == 'false') {
		$showvalue = false;
	} else {
		$showvalue = true;
	}

	if (! isset($max) or ! $max) {
		$max = 100;
	}
	if ($max < $value) {
		//	maximum exceeded then change color
		$color = '#0E0E0E';
		$maxexceeded = true;
		$max = $value;
	} else {
		$maxexceeded = false;
	}

	if (! isset($labelsize)) {
		$labelsize = 50;
	}

	if (! isset($label)) {
		$label_td = '';
	} else {
		$label_td = '<td width="' . $labelsize . '">' . $label . '&nbsp;</td>';
	}

	if ($maxexceeded) {
		$perc_td = '<td style="text-align: right;" width="55">*******</td>';
	} else {
		if ($perc) {
			$perc = number_format($value / $max * 100, 2);
			$perc_td = '<td style="text-align: right;" width="55">&nbsp;' . $perc . '%</td>';
		} else {
			$perc = number_format($value, 2);
			$perc_td = '<td style="text-align: right;" width="55">&nbsp;' . $perc . '</td>';
		}
	}

	$h_size = floor($value / $max * 100);
	$h_size_rest = 100 - $h_size;

	if ($h_size == 100) {
		$h_td = '<td style="background:' . $color . ';">&nbsp;</td>';
	} else {
		if ($h_size_rest == 100) {
			$h_td = '<td style="background:' . $bgcolor . ';">&nbsp;</td>';
		} else {
			$h_td = '<td style="background:' . $color . ';" width="' . $h_size . '%' . '">&nbsp;</td>';
			$h_td .= '<td style="background:' . $bgcolor . ';" width="' . $h_size_rest . '%' . '">&nbsp;</td>';
		}
	}


	$html  = '<table class="plugin_gauge" border="0" width="100%"><tr>' . $label_td . '<td width="' . $size . '" height="' . $height . '">';
	$html .= '<table class="plugin_gauge-bar" border="0" width="100%"><tr>' . $h_td . '</tr></table>';
	$html .= '</td>' . ($showvalue ? $perc_td : '') . '<td>&nbsp;</td></tr>';

	if (! empty($data)) {
		$html .= '<tr><td colspan="3"><small>' . $data . '</small></td></tr>';
	}

	$html .= "</table>";
	return $html;
}
