zabbix-frontend-php 1:1.8.11-1 / usr / share / zabbix / api / classes / class.citemkey.php

<?php
/*
** Zabbix
** Copyright (C) 2000-2011 Zabbix SIA
**
** 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 2 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, write to the Free Software
** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
**/
?>
<?php

/**
 * Class is used to validate and parse item keys
 * Example of usage:
 *      $itemKey = new cItemKey('test.key[a, b, c]');
 *      echo $itemKey->isValid(); // true
 *      echo $itemKey->getKeyId(); // test.key
 *      print_r($itemKey->parameters()); // array('a', 'b', 'c')
 */
class cItemKey{

	private $key;

	// variables required for parsing
	private $currentByte = 0;
	private $nestLevel;
	private $state;
	private $currParamNo;
	private $keyIdHasComma = false; // this is required, because key ids with "," cannot have params (simple checks)
	// key info (is available after parsing)
	private $keyByteCnt;
	private $isValid = true;        // let's hope for the best :)
	private $error = '';            // if key is invalid
	private $parameters = array();  // array of key parameters
	private $keyId = '';            // main part of the key (for 'key[1, 2, 3]' key id would be 'key')

	/**
	 * Parse key and determine if it is valid
	 * @param string $key
	 */
	public function __construct($key){

		$this->key = $key;

		// get key length
		$this->keyByteCnt = strlen($this->key);

		// checking if key is empty
		if($this->keyByteCnt == 0){
			$this->isValid = false;
			$this->error = S_KEY_CANNOT_BE_EMPTY;
		}
		else{
			// getting key id out of the key
			$this->parseKeyId();
			if($this->isValid){
				// and parameters ($currentByte now points to start of parameters)
				$this->parseKeyParameters();
			}
		}
	}


	/**
	 * Get the key id and put $currentByte after it
	 * @return void
	 */
	private function parseKeyId(){
		// checking every byte, one by one, until first 'not key_id' char is reached
		for($this->currentByte = 0; $this->currentByte < $this->keyByteCnt; $this->currentByte++) {
			if(!isKeyIdChar($this->key[$this->currentByte])) {
				break; // $this->currentByte now points to a first 'not a key name' char
			}
		}
		if($this->currentByte == 0){ // no key id
			$this->isValid = false;
			$this->error = S_NO_KEY_ID_PROVIDED;
		}
		else{
			$this->keyId = substr($this->key, 0, $this->currentByte);
		}
		// checking for something like telnet,1023
		if ($this->currentByte < $this->keyByteCnt && $this->key[$this->currentByte] == ',') {
			$this->keyIdHasComma = true;
		}
	}


	/**
	 * Parse key parameters and put them into $this->parameters array
	 * @return void
	 */
	private function parseKeyParameters(){

		// no parameters?
		if($this->currentByte == $this->keyByteCnt){
			return;
		}

		if ($this->keyIdHasComma) {
			// +1 because currentByte points to ','
			$keyParam = substr($this->key, $this->currentByte + 1);

			if (!preg_match('/^\d*$/', $keyParam) && !preg_match('/^'.ZBX_PREG_EXPRESSION_USER_MACROS.'$/', $keyParam)) {
				$this->isValid = false;
				$this->error = S_INCORRECT_SIMPLE_CHECK_PARAMETER;
				return;
			}
			else {
				return;
			}
		}

		// invalid symbol instead of '[', which would be the beginning of params
		if($this->key[$this->currentByte] != '['){
			$this->isValid = false;
			$this->error = S_NO_ITEM_KEY_PROVIDED;
			return;
		}

		// let the parsing begin!
		$this->state = 0;   // 0 - initial
							// 1 - inside quoted param
							// 2 - inside unquoted param
		$this->nestLevel = 0;
		$this->currParamNo = 0;
		$this->parameters[$this->currParamNo] = '';

		// for every byte, starting after '['
		for($this->currentByte++; $this->currentByte < $this->keyByteCnt; $this->currentByte++) {
			switch($this->state){
				// initial state
				case 0:
					if($this->key[$this->currentByte] == ',') {
						if($this->nestLevel == 0){
							$this->currParamNo++;
							$this->parameters[$this->currParamNo] = '';
						}
						else{
							$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
						}
					}
					// Zapcat: '][' is treated as ','
					else if($this->key[$this->currentByte] == ']' && isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] == '[' && $this->nestLevel == 0) {
						$this->currParamNo++;
						$this->parameters[$this->currParamNo] = '';
						$this->currentByte++;
					}
					// entering quotes
					else if($this->key[$this->currentByte] == '"') {
						$this->state = 1;
						// in key[["a"]] param is "a"
						if($this->nestLevel > 0){
							$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
						}
					}
					// next nesting level
					else if($this->key[$this->currentByte] == '[') {
						if($this->nestLevel > 0){
							$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
						}
						$this->nestLevel++;
					}
					// one of the nested sets ended
					else if($this->key[$this->currentByte] == ']' && $this->nestLevel > 0) {

						$this->nestLevel--;

						if($this->nestLevel > 0){
							$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
						}

						// skipping spaces
						while(isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] == ' ') {
							$this->currentByte++;
							if($this->nestLevel > 0){
								$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
							}
						}
						// all nestings are closed correctly
						if ($this->nestLevel == 0 && isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] == ']' && !isset($this->key[$this->currentByte+2])) {
							return;
						}

						if(
							!isset($this->key[$this->currentByte+1])
							|| $this->key[$this->currentByte+1] != ','
							&& !(
								$this->nestLevel > 0
								&& isset($this->key[$this->currentByte+1])
								&& $this->key[$this->currentByte+1] == ']'
							)
							// Zapcat - '][' is the same as ','
							&& $this->key[$this->currentByte+1] != ']'
							&& $this->key[$this->currentByte+2] != '['
						){
							$this->isValid = false;
							$this->error = sprintf(S_INCORRECT_SYNTAX_NEAR, $this->key[$this->currentByte]);
							return;
						}
					}
					// looks like we have reached final ']'
					else if($this->key[$this->currentByte] == ']' && $this->nestLevel == 0) {
						if (!isset($this->key[$this->currentByte+1])){
							return;
						}

						// nothing else is allowed after final ']'
						$this->isValid = false;
						$this->error = sprintf(S_INCORRECT_USAGE_OF_BRACKET_SYMBOLS, $this->key[$this->currentByte+1]);
						return;
					}
					else if($this->key[$this->currentByte] != ' ') {
						$this->state = 2;
						// this is a first symbol of unquoted param
						$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
					}
					else if($this->nestLevel > 0){
						$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
					}

				break;

				// quoted
				case 1:
					// ending quote is reached
					if($this->key[$this->currentByte] == '"' && $this->key[$this->currentByte-1] != '\\'){
						// skipping spaces
						while(isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] == ' ') {
							$this->currentByte++;
							if($this->nestLevel > 0){
								$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
							}
						}

						// Zapcat
						if($this->nestLevel == 0 && isset($this->key[$this->currentByte+1]) && isset($this->key[$this->currentByte+2]) && $this->key[$this->currentByte+1] == ']' && $this->key[$this->currentByte+2] == '['){
							$this->state = 0;
							break;
						}

						if ($this->nestLevel == 0 && isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] == ']' && !isset($this->key[$this->currentByte+2])){
							return;
						}
						else if($this->nestLevel == 0 && $this->key[$this->currentByte+1] == ']' && isset($this->key[$this->currentByte+2])){
							// nothing else is allowed after final ']'
							$this->isValid = false;
							$this->error = sprintf(S_INCORRECT_USAGE_OF_BRACKET_SYMBOLS, $this->key[$this->currentByte+1]);
							return;
						}

						if ((!isset($this->key[$this->currentByte+1]) || $this->key[$this->currentByte+1] != ',') //if next symbol is not ','
							&& !($this->nestLevel != 0 && isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] == ']'))
						{
							// nothing else is allowed after final ']'
							$this->isValid = false;
							$this->error = sprintf(S_INCORRECT_USAGE_OF_BRACKET_SYMBOLS, $this->key[$this->currentByte], $this->currentByte);
							return;
						}

						// in key[["a"]] param is "a"
						if($this->nestLevel > 0){
							$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
						}

						$this->state = 0;
					}
					//escaped quote (\")
					else if($this->key[$this->currentByte] == '\\' && isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] == '"') {
						if($this->nestLevel > 0){
							$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
						}
					}
					else{
						$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
					}
				break;

				// unquoted
				case 2:
					// Zapcat
					if($this->nestLevel == 0 && $this->key[$this->currentByte] == ']' && isset($this->key[$this->currentByte+1]) && $this->key[$this->currentByte+1] =='[' ){
						$this->currentByte--;
						$this->state = 0;
					}
					else if($this->key[$this->currentByte] == ',' || ($this->key[$this->currentByte] == ']' && $this->nestLevel > 0)) {
						$this->currentByte--;
						$this->state = 0;
					}
					else if($this->key[$this->currentByte] == ']' && $this->nestLevel == 0) {
						if (isset($this->key[$this->currentByte+1])){
							// nothing else is allowed after final ']'
							$this->isValid = false;
							$this->error = sprintf(S_INCORRECT_USAGE_OF_BRACKET_SYMBOLS, $this->key[$this->currentByte+1]);
							return;
						}
						else {
							return;
						}
					}
					else{
						$this->parameters[$this->currParamNo] .= $this->key[$this->currentByte];
					}
				break;
			}
		}
		$this->isValid = false;
		$this->error = S_INVALID_KEY_FORMAT;
	}


	/**
	 * Is key valid?
	 * @return bool
	 */
	public function isValid(){
		return $this->isValid;
	}


	/**
	 * Get the error if key is invalid
	 * @return string
	 */
	public function getError(){
		return $this->error;
	}


	/**
	 * Get the list of key parameters
	 * @return array
	 */
	public function getParameters(){
		return $this->parameters;
	}


	/**
	 * Get the key id (first part of the key)
	 * @return string
	 */
	public function getKeyId(){
		return $this->keyId;
	}
}

?>