<?php

/*
	Phoronix Test Suite
	URLs: http://www.phoronix.com, http://www.phoronix-test-suite.com/
	Copyright (C) 2008 - 2012, Phoronix Media
	Copyright (C) 2008 - 2012, Michael Larabel
	pts_module_option.php: The object for handling persistent module options that can be controlled by the end-user

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

class pts_module_option
{
	private $option_identifier;
	private $option_question;
	private $option_supported_values;
	private $option_default_value;
	private $option_function_check;
	private $option_setup_check;

	public function __construct($identifier, $question_string, $supported_values = null, $default_value = null, $function_to_check = null, $setup_check = true)
	{
		$this->option_identifier = $identifier;
		$this->option_question = $question_string;
		$this->option_supported_values = $supported_values;
		$this->option_default_value = $default_value;
		$this->option_function_check = $function_to_check;
		$this->option_setup_check = $setup_check;
	}
	public function setup_check_needed()
	{
		return $this->option_setup_check;
	}
	public function get_identifier()
	{
		return $this->option_identifier;
	}
	public function get_question()
	{
		return $this->option_question;
	}
	public function get_default_value()
	{
		return $this->option_default_value;
	}
	public function get_formatted_question()
	{
		$question_string = $this->get_question();

		if($this->get_default_value() != null)
		{
			$question_string .= ' [' . $this->get_default_value() . ']';
		}

		$question_string .= ': ';

		return $question_string;
	}
	public function is_supported_value($input)
	{
		$supported = false;

		if(is_array($this->option_supported_values))
		{
			if(in_array($input, $this->option_supported_values))
			{
				$supported = true;
			}
		}
		else if(empty($input) && $this->option_default_value != null)
		{
			$supported = true;
		}
		else
		{
			switch($this->option_supported_values)
			{
				case 'NUMERIC':
					if(is_numeric($input))
					{
						$supported = true;
					}
					break;
				case 'NUMERIC_DASH':
					if(!empty($input) && pts_strings::string_only_contains($input, pts_strings::CHAR_NUMERIC | pts_strings::CHAR_DASH))
					{
						$supported = true;
					}
					break;
				case 'ALPHA_NUMERIC':
					if(!empty($input) && pts_strings::string_only_contains($input, pts_strings::CHAR_NUMERIC | pts_strings::CHAR_LETTER))
					{
						$supported = true;
					}
					break;
				case 'HTTP_URL':
					if(substr($input, 0, 7) == 'http://')
					{
						$supported = true;
					}
					break;
				case 'LOCAL_DIRECTORY':
					if(is_dir($input))
					{
						$supported = true;
					}
					break;
				case 'LOCAL_FILE':
					if(is_file($input))
					{
						$supported = true;
					}
					break;
				case 'LOCAL_EXECUTABLE':
					if(is_executable($input))
					{
						$supported = true;
					}
					break;
				case 'PTS_TEST_RESULT':
					if(pts_result_file::is_test_result_file($input))
					{
						$supported = true;
					}
				case 'INSTALLED_TEST':
					if(in_array($input, pts_tests::installed_tests()))
					{
						$supported = true;
					}
				case 'VALID_SAVE_NAME':
					if(!empty($input) && pts_types::identifier_to_object($input) == false)
					{
						$supported = true;
					}
				case 'NOT_EMPTY':
					if(!empty($input))
					{
						$supported = true;
					}
				case '':
					$supported = true;
					break;
			}
		}

		if($supported && !empty($this->option_function_check))
		{
			$supported = (call_user_func($this->option_function_check, $input) == true);
		}

		return $supported;
	}
}

?>
