<?php
/**
 * li₃: the most RAD framework for PHP (http://li3.me)
 *
 * Copyright 2009, Union of RAD. All rights reserved. This source
 * code is distributed under the terms of the BSD 3-Clause License.
 * The full license text can be found in the LICENSE.txt file.
 */

namespace lithium\util;

/**
 * Used for complex manipulation, comparison, and access of array data. Some methods allow for
 * XPath-like data access, as follows:
 *
 *  - `'/User/id'`: Similar to the classic {n}.User.id.
 *  - `'/User[2]/name'`: Selects the name of the second User.
 *  - `'/User[id>2]'`: Selects all Users with an id > 2.
 *  - `'/User[id>2][<5]'`: Selects all Users with an id > 2 but < 5.
 *  - `'/Post/Comment[author_name=John]/../name'`: Selects the name of
 *    all posts that have at least one comment written by John.
 *  - `'/Posts[name]'`: Selects all Posts that have a `'name'` key.
 *  - `'/Comment/.[1]'`: Selects the contents of the first comment.
 *  - `'/Comment/.[:last]'`: Selects the last comment.
 *  - `'/Comment/.[:first]'`: Selects the first comment.
 *  - `'/Comment[text=/lithium/i]`': Selects the all comments that have
 *    a text matching the regex `/lithium/i`.
 *  - `'/Comment/@*'`: Selects all key names of all comments.
 */
class Set {

	/**
	 * Add the keys/values in `$array2` that are not found in `$array` onto the end of `$array`.
	 *
	 * @param mixed $array Original array.
	 * @param mixed $array2 Second array to add onto the original.
	 * @return array An array containing all the keys of the second array not already present in the
	 *         first.
	 */
	public static function append(array $array, array $array2) {
		$arrays = func_get_args();
		$array = array_shift($arrays);
		foreach ($arrays as $array2) {
			if (!$array && $array2) {
				$array = $array2;
				continue;
			}
			foreach ($array2 as $key => $value) {
				if (!array_key_exists($key, $array)) {
					$array[$key] = $value;
				} elseif (is_array($value)) {
					$array[$key] = static::append($array[$key], $array2[$key]);
				}
			}
		}
		return $array;
	}

	/**
	 * Checks if a particular path is set in an array. Tests by key name, or dot-delimited key
	 * name, i.e.:
	 *
	 * ``` embed:lithium\tests\cases\util\SetTest::testCheck(1-4) ```
	 *
	 * @param mixed $data Data to check on.
	 * @param mixed $path A dot-delimited string.
	 * @return boolean `true` if path is found, `false` otherwise.
	 */
	public static function check($data, $path = null) {
		if (!$path) {
			return $data;
		}
		$path = is_array($path) ? $path : explode('.', $path);

		foreach ($path as $i => $key) {
			if (is_numeric($key) && (integer) $key > 0 || $key === '0') {
				$key = (integer) $key;
			}
			if ($i === count($path) - 1) {
				return (is_array($data) && isset($data[$key]));
			} else {
				if (!is_array($data) || !isset($data[$key])) {
					return false;
				}
				$data =& $data[$key];
			}
		}
	}

	/**
	 * Creates an associative array using a `$path1` as the path to build its keys, and optionally
	 * `$path2` as path to get the values. If `$path2` is not specified, all values will be
	 * initialized to `null` (useful for `Set::merge()`). You can optionally group the values by
	 * what is obtained when following the path specified in `$groupPath`.
	 *
	 * @param array $data Array from where to extract keys and values.
	 * @param mixed $path1 As an array, or as a dot-delimited string.
	 * @param mixed $path2 As an array, or as a dot-delimited string.
	 * @param string $groupPath As an array, or as a dot-delimited string.
	 * @return array Combined array.
	 */
	public static function combine($data, $path1 = null, $path2 = null, $groupPath = null) {
		if (!$data) {
			return [];
		}
		if (is_object($data)) {
			$data = get_object_vars($data);
		}
		if (is_array($path1)) {
			$format = array_shift($path1);
			$keys = static::format($data, $format, $path1);
		} else {
			$keys = static::extract($data, $path1);
		}
		$vals = [];
		if (!empty($path2) && is_array($path2)) {
			$format = array_shift($path2);
			$vals = static::format($data, $format, $path2);
		} elseif (!empty($path2)) {
			$vals = static::extract($data, $path2);
		}
		$valCount = count($vals);
		$count = count($keys);

		for ($i = $valCount; $i < $count; $i++) {
			$vals[$i] = null;
		}
		if ($groupPath) {
			$group = static::extract($data, $groupPath);
			if (!empty($group)) {
				$c = count($keys);
				for ($i = 0; $i < $c; $i++) {
					if (!isset($group[$i])) {
						$group[$i] = 0;
					}
					if (!isset($out[$group[$i]])) {
						$out[$group[$i]] = [];
					}
					$out[$group[$i]][$keys[$i]] = $vals[$i];
				}
				return $out;
			}
		}
		return array_combine($keys, $vals);
	}

	/**
	 * Determines if the array elements in `$array2` are wholly contained within `$array1`. Works
	 * recursively.
	 *
	 * @param array $array1 First value.
	 * @param array $array2 Second value.
	 * @return boolean Returns `true` if `$array1` wholly contains the keys and values of `$array2`,
	 *         otherwise, returns `false`. Returns `false` if either array is empty.
	 */
	public static function contains(array $array1, array $array2) {
		if (!$array1 || !$array2) {
			return false;
		}
		foreach ($array2 as $key => $val) {
			if (!isset($array1[$key]) || $array1[$key] !== $val) {
				return false;
			}
			if (is_array($val) && !static::contains($array1[$key], $val)) {
				return false;
			}
		}
		return true;
	}

	/**
	 * Counts the dimensions of an array. If `$all` is set to `false` (which is the default) it will
	 * only consider the dimension of the first element in the array.
	 *
	 * @param array $data Array to count dimensions on.
	 * @param array $options
	 * @return integer The number of dimensions in `$array`.
	 */
	public static function depth($data, array $options = []) {
		$defaults = ['all' => false, 'count' => 0];
		$options += $defaults;

		if (!$data) {
			return 0;
		}

		if (!$options['all']) {
			return (is_array(reset($data))) ? static::depth(reset($data)) + 1 : 1;
		}
		$depth = [$options['count']];

		if (is_array($data) && reset($data) !== false) {
			foreach ($data as $value) {
				$depth[] = static::depth($value, [
					'all' => $options['all'],
					'count' => $options['count'] + 1
				]);
			}
		}
		return max($depth);
	}

	/**
	 * Computes the difference between two arrays.
	 *
	 * @param array $val1 First value.
	 * @param array $val2 Second value.
	 * @return array Computed difference.
	 */
	public static function diff(array $val1, array $val2) {
		if (!$val1 || !$val2) {
			return $val2 ?: $val1;
		}
		$out = [];

		foreach ($val1 as $key => $val) {
			$exists = isset($val2[$key]);

			if (($exists && $val2[$key] !== $val) || !$exists) {
				$out[$key] = $val;
			}
			unset($val2[$key]);
		}

		foreach ($val2 as $key => $val) {
			if (!isset($out[$key])) {
				$out[$key] = $val;
			}
		}
		return $out;
	}

	/**
	 * Implements partial support for XPath 2.0.
	 *
	 * @param array $data An array of data to extract from.
	 * @param string $path An absolute XPath 2.0 path. Only absolute paths starting with a
	 *        single slash are supported right now. Implemented selectors:
	 *        - `'/User/id'`: Similar to the classic {n}.User.id.
	 *        - `'/User[2]/name'`: Selects the name of the second User.
	 *        - `'/User[id>2]'`: Selects all Users with an id > 2.
	 *        - `'/User[id>2][<5]'`: Selects all Users with an id > 2 but < 5.
	 *        - `'/Post/Comment[author_name=John]/../name'`: Selects the name of
	 *          all posts that have at least one comment written by John.
	 *        - `'/Posts[name]'`: Selects all Posts that have a `'name'` key.
	 *        - `'/Comment/.[1]'`: Selects the contents of the first comment.
	 *        - `'/Comment/.[:last]'`: Selects the last comment.
	 *        - `'/Comment/.[:first]'`: Selects the first comment.
	 *        - `'/Comment[text=/lithium/i]`': Selects the all comments that have
	 *          a text matching the regex `/lithium/i`.
	 *        - `'/Comment/@*'`: Selects all key names of all comments.
	 * @param array $options Currently only supports `'flatten'` which can be
	 *              disabled for higher XPath-ness.
	 * @return array An array of matched items.
	 */
	public static function extract(array $data, $path = null, array $options = []) {
		$defaults = ['flatten' => true];
		$options += $defaults;

		if (!$options['flatten']) {
			$message = 'Non-flatten mode in `Set::extract()` has been deprecated.';
			trigger_error($message, E_USER_DEPRECATED);
		}

		if (!$data) {
			return [];
		}
		if ($path === '/') {
			return array_filter($data, function($data) {
				return ($data === 0 || $data === '0' || !empty($data));
			});
		}
		$contexts = $data;

		if (!isset($contexts[0])) {
			$contexts = [$data];
		}

		$tokens = array_slice(preg_split('/(?<!=)\/(?![a-z-]*\])/', $path), 1);

		do {
			$token = array_shift($tokens);
			$conditions = false;

			if (preg_match_all('/\[([^=]+=\/[^\/]+\/|[^\]]+)\]/', $token, $m)) {
				$conditions = $m[1];
				$token = substr($token, 0, strpos($token, '['));
			}
			$matches = [];

			foreach ($contexts as $key => $context) {
				if (!isset($context['trace'])) {
					$context = ['trace' => [null], 'item' => $context, 'key' => $key];
				}
				if ($token === '..') {
					if (count($context['trace']) === 1) {
						$context['trace'][] = $context['key'];
					}

					array_pop($context['trace']);
					$parent = join('/', $context['trace']);
					$context['item'] = static::extract($data, $parent);
					array_pop($context['trace']);
					$context['item'] = array_shift($context['item']);
					$matches[] = $context;
					continue;
				}
				$match = false;

				if ($token === '@*' && is_array($context['item'])) {
					$matches[] = [
						'trace' => array_merge($context['trace'], (array) $key),
						'key' => $key,
						'item' => array_keys($context['item'])
					];
				} elseif (is_array($context['item']) && isset($context['item'][$token])) {
					$items = $context['item'][$token];
					if (!is_array($items)) {
						$items = [$items];
					} elseif (!isset($items[0])) {
						$current = current($items);
						if ((is_array($current) && count($items) <= 1) || !is_array($current)) {
							$items = [$items];
						}
					}

					foreach ($items as $key => $item) {
						$ctext = [$context['key']];
						if (!is_numeric($key)) {
							$ctext[] = $token;
							$token = array_shift($tokens);
							if (isset($items[$token])) {
								$ctext[] = $token;
								$item = $items[$token];
								$matches[] = [
									'trace' => array_merge($context['trace'], $ctext),
									'key' => $key,
									'item' => $item
								];
								break;
							} else {
								array_unshift($tokens, $token);
							}
						} else {
							$ctext[] = $token;
						}

						$matches[] = [
							'trace' => array_merge($context['trace'], $ctext),
							'key' => $key,
							'item' => $item
						];
					}
				} elseif (
					$key === $token || (is_numeric($token) && $key == $token) || $token === '.'
				) {
					$context['trace'][] = $key;
					$matches[] = [
						'trace' => $context['trace'],
						'key' => $key,
						'item' => $context['item']
					];
				}
			}
			if ($conditions) {
				foreach ($conditions as $condition) {
					$filtered = [];
					$length = count($matches);

					foreach ($matches as $i => $match) {
						if (static::matches($match['item'], [$condition], $i + 1, $length)) {
							$filtered[] = $match;
						}
					}
					$matches = $filtered;
				}
			}
			$contexts = $matches;

			if (empty($tokens)) {
				break;
			}
		} while (true);

		$r = [];

		foreach ($matches as $match) {
			$key = array_pop($match['trace']);
			$condition = (!is_int($key) && $key !== null);
			if ((!$options['flatten'] || is_array($match['item'])) && $condition) {
				$r[] = [$key => $match['item']];
			} else {
				$r[] = $match['item'];
			}
		}
		return $r;
	}

	/**
	 * Collapses a multi-dimensional array into a single dimension, using a delimited array path
	 * for each array element's key, i.e. [array('Foo' => ['Bar' => 'Far'])] becomes
	 * ['0.Foo.Bar' => 'Far'].
	 *
	 * @param array $data array to flatten
	 * @param array $options Available options are:
	 *        - `'separator'`: String to separate array keys in path (defaults to `'.'`).
	 *        - `'path'`: Starting point (defaults to null).
	 * @return array
	 */
	public static function flatten($data, array $options = []) {
		$defaults = ['separator' => '.', 'path' => null];
		$options += $defaults;
		$result = [];

		if ($options['path'] !== null) {
			$options['path'] .= $options['separator'];
		}
		foreach ($data as $key => $val) {
			if (!is_array($val)) {
				$result[$options['path'] . $key] = $val;
				continue;
			}
			$opts = ['separator' => $options['separator'], 'path' => $options['path'] . $key];
			$result += (array) static::flatten($val, $opts);
		}
		return $result;
	}

	/**
	 * Accepts a one-dimensional array where the keys are separated by a delimiter.
	 *
	 * @param array $data The one-dimensional array to expand.
	 * @param array $options The options used when expanding the array:
	 *        - `'separator'` _string_: The delimiter to use when separating keys. Defaults
	 *          to `'.'`.
	 * @return array Returns a multi-dimensional array expanded from a one dimensional
	 *         dot-separated array.
	 */
	public static function expand(array $data, array $options = []) {
		$defaults = ['separator' => '.'];
		$options += $defaults;
		$result = [];

		foreach ($data as $key => $val) {
			if (strpos($key, $options['separator']) === false) {
				if (!isset($result[$key])) {
					$result[$key] = $val;
				}
				continue;
			}
			list($path, $key) = explode($options['separator'], $key, 2);
			$path = is_numeric($path) ? (integer) $path : $path;
			$result[$path][$key] = $val;
		}
		foreach ($result as $key => $value) {
			if (is_array($value)) {
				$result[$key] = static::expand($value, $options);
			}
		}
		return $result;
	}

	/**
	 * Returns a series of values extracted from an array, formatted in a format string.
	 *
	 * @param array $data Source array from which to extract the data.
	 * @param string $format Format string into which values will be inserted using `sprintf()`.
	 * @param array $keys An array containing one or more `Set::extract()`-style key paths.
	 * @return array An array of strings extracted from `$keys` and formatted with `$format`.
	 * @link http://php.net/sprintf
	 */
	public static function format($data, $format, $keys) {
		$extracted = [];
		$count = count($keys);

		if (!$count) {
			return;
		}
		for ($i = 0; $i < $count; $i++) {
			$extracted[] = static::extract($data, $keys[$i]);
		}
		$out = [];
		$data = $extracted;
		$count = count($data[0]);

		if (preg_match_all('/\{([0-9]+)\}/msi', $format, $keys2) && isset($keys2[1])) {
			$keys = $keys2[1];
			$format = preg_split('/\{([0-9]+)\}/msi', $format);
			$count2 = count($format);

			for ($j = 0; $j < $count; $j++) {
				$formatted = '';
				for ($i = 0; $i <= $count2; $i++) {
					if (isset($format[$i])) {
						$formatted .= $format[$i];
					}
					if (isset($keys[$i]) && isset($data[$keys[$i]][$j])) {
						$formatted .= $data[$keys[$i]][$j];
					}
				}
				$out[] = $formatted;
			}
			return $out;
		}
		$count2 = count($data);

		for ($j = 0; $j < $count; $j++) {
			$args = [];

			for ($i = 0; $i < $count2; $i++) {
				if (isset($data[$i][$j])) {
					$args[] = $data[$i][$j];
				}
			}
			$out[] = vsprintf($format, $args);
		}
		return $out;
	}

	/**
	 * Inserts `$data` into an array as defined by `$path`.
	 *
	 * @param mixed $list Where to insert into.
	 * @param mixed $path A dot-delimited string.
	 * @param array $data Data to insert.
	 * @return array
	 */
	public static function insert($list, $path, $data = []) {
		if (!is_array($path)) {
			$path = explode('.', $path);
		}
		$_list =& $list;

		foreach ($path as $i => $key) {
			if (is_numeric($key) && (integer) $key > 0 || $key === '0') {
				$key = (integer) $key;
			}
			if ($i === count($path) - 1) {
				$_list[$key] = $data;
			} else {
				if (!isset($_list[$key])) {
					$_list[$key] = [];
				}
				$_list =& $_list[$key];
			}
		}
		return $list;
	}

	/**
	 * Checks to see if all the values in the array are numeric.
	 *
	 * @param array $array The array to check.  If null, the value of the current Set object.
	 * @return mixed `true` if values are numeric, `false` if not and `null` if the array to
	 *               check is empty.
	 */
	public static function isNumeric($array = null) {
		if (empty($array)) {
			return null;
		}
		if ($array === range(0, count($array) - 1)) {
			return true;
		}
		$numeric = true;
		$keys = array_keys($array);
		$count = count($keys);

		for ($i = 0; $i < $count; $i++) {
			if (!is_numeric($array[$keys[$i]])) {
				$numeric = false;
				break;
			}
		}
		return $numeric;
	}

	/**
	 * This function can be used to see if a single item or a given XPath
	 * match certain conditions.
	 *
	 * @param array $data An array of data to execute the match on.
	 * @param mixed $conditions An array of condition strings or an XPath expression.
	 * @param integer $i Optional: The 'nth'-number of the item being matched.
	 * @param integer $length
	 * @return boolean
	 */
	public static function matches($data, $conditions, $i = null, $length = null) {
		if (!$conditions) {
			return true;
		}
		if (is_string($conditions)) {
			return (boolean) static::extract($data, $conditions);
		}
		foreach ($conditions as $condition) {
			if ($condition === ':last') {
				if ($i !== $length) {
					return false;
				}
				continue;
			} elseif ($condition === ':first') {
				if ($i !== 1) {
					return false;
				}
				continue;
			}
			if (!preg_match('/(.+?)([><!]?[=]|[><])(.*)/', $condition, $match)) {
				if (ctype_digit($condition)) {
					if ($i !== (int) $condition) {
						return false;
					}
				} elseif (preg_match_all('/(?:^[0-9]+|(?<=,)[0-9]+)/', $condition, $matches)) {
					return in_array($i, $matches[0]);
				} elseif (!isset($data[$condition])) {
					return false;
				}
				continue;
			}
			list(,$key,$op,$expected) = $match;

			if (!isset($data[$key])) {
				return false;
			}
			$val = $data[$key];

			if ($op === '=' && $expected && $expected[0] === '/') {
				return preg_match($expected, $val);
			} elseif ($op === '=' && $val != $expected) {
				return false;
			} elseif ($op === '!=' && $val == $expected) {
				return false;
			} elseif ($op === '>' && $val <= $expected) {
				return false;
			} elseif ($op === '<' && $val >= $expected) {
				return false;
			} elseif ($op === '<=' && $val > $expected) {
				return false;
			} elseif ($op === '>=' && $val < $expected) {
				return false;
			}
		}
		return true;
	}

	/**
	 * This method can be thought of as a hybrid between PHP's `array_merge()`
	 * and `array_merge_recursive()`.  The difference to the two is that if an
	 * array key contains another array then the function behaves recursive
	 * (unlike `array_merge()`) but does not do if for keys containing strings
	 * (unlike `array_merge_recursive()`).  Please note: This function will work
	 * with an unlimited amount of arguments and typecasts non-array parameters
	 * into arrays.
	 *
	 * @param array $array1 The base array.
	 * @param array $array2 The array to be merged on top of the base array.
	 * @return array Merged array of all passed params.
	 */
	public static function merge(array $array1, array $array2) {
		$args = [$array1, $array2];

		if (!$array1 || !$array2) {
			return $array1 ?: $array2;
		}
		$result = (array) current($args);

		while (($arg = next($args)) !== false) {
			foreach ((array) $arg as $key => $val) {
				if (is_array($val) && isset($result[$key]) && is_array($result[$key])) {
					$result[$key] = static::merge($result[$key], $val);
				} elseif (is_int($key)) {
					$result[] = $val;
				} else {
					$result[$key] = $val;
				}
			}
		}
		return $result;
	}

	/**
	 * Normalizes a string or array list.
	 *
	 * ```
	 * Set::normalize('foo,bar'); // returns ['foo' => null, 'bar' => null];
	 * Set::normalize(['foo', 'bar' => 'baz']; // returns ['foo' => null, 'bar' => 'baz'];
	 * ```
	 *
	 * @param string|array $list List to normalize.
	 * @param boolean $assoc If `true`, `$list` will be converted to an associative array.
	 * @param string $sep If `$list` is a string, it will be split into an array with `$sep`.
	 * @param boolean $trim If `true`, separated strings will be trimmed.
	 * @return array
	 */
	public static function normalize($list, $assoc = true, $sep = ',', $trim = true) {
		if (is_string($list)) {
			$list = explode($sep, $list);
			$list = ($trim) ? array_map('trim', $list) : $list;
			return ($assoc) ? static::normalize($list) : $list;
		}

		if (!is_array($list)) {
			return $list;
		}

		$keys = array_keys($list);
		$count = count($keys);
		$numeric = true;

		if (!$assoc) {
			for ($i = 0; $i < $count; $i++) {
				if (!is_int($keys[$i])) {
					$numeric = false;
					break;
				}
			}
		}

		if (!$numeric || $assoc) {
			$newList = [];
			for ($i = 0; $i < $count; $i++) {
				if (is_int($keys[$i]) && is_scalar($list[$keys[$i]])) {
					$newList[$list[$keys[$i]]] = null;
				} else {
					$newList[$keys[$i]] = $list[$keys[$i]];
				}
			}
			$list = $newList;
		}
		return $list;
	}

	/**
	 * Removes an element from an array as defined by `$path`.
	 *
	 * @param mixed $list From where to remove.
	 * @param mixed $path A dot-delimited string.
	 * @return array Array with `$path` removed from its value.
	 */
	public static function remove($list, $path = null) {
		if (empty($path)) {
			return $list;
		}
		if (!is_array($path)) {
			$path = explode('.', $path);
		}
		$_list =& $list;

		foreach ($path as $i => $key) {
			if (is_numeric($key) && (integer) $key > 0 || $key === '0') {
				$key = (integer) $key;
			}
			if ($i === count($path) - 1) {
				unset($_list[$key]);
			} else {
				if (!isset($_list[$key])) {
					return $list;
				}
				$_list =& $_list[$key];
			}
		}
		return $list;
	}

	/**
	 * Sorts an array by any value, determined by a `Set`-compatible path.
	 *
	 * @param array $data
	 * @param string $path A `Set`-compatible path to the array value.
	 * @param string $dir Either `'asc'` (the default) or `'desc'`.
	 * @return array
	 */
	public static function sort($data, $path, $dir = 'asc') {
		$flatten = function($flatten, $results, $key = null) {
			$stack = [];
			foreach ((array) $results as $k => $r) {
				$id = $k;
				if ($key !== null) {
					$id = $key;
				}
				if (is_array($r)) {
					$stack = array_merge($stack, $flatten($flatten, $r, $id));
				} else {
					$stack[] = ['id' => $id, 'value' => $r];
				}
			}
			return $stack;
		};
		$extract = static::extract($data, $path);
		$result = $flatten($flatten, $extract);

		$keys = static::extract($result, '/id');
		$values = static::extract($result, '/value');

		$dir = ($dir === 'desc') ? SORT_DESC : SORT_ASC;
		array_multisort($values, $dir, $keys, $dir);
		$sorted = [];
		$keys = array_unique($keys);

		foreach ($keys as $k) {
			$sorted[] = $data[$k];
		}
		return $sorted;
	}

	/**
	 * Slices an array into two, separating them determined by an array of keys.
	 *
	 * Usage examples:
	 *
	 * ``` embed:lithium\tests\cases\util\SetTest::testSetSlice(1-4) ```
	 *
	 * @param array $subject Array that gets split apart
	 * @param array|string $keys An array of keys or a single key as string
	 * @return array An array containing both arrays, having the array with requested keys first and
	 *         the remainder as second element
	 */
	public static function slice(array $data, $keys) {
		$removed = array_intersect_key($data, array_fill_keys((array) $keys, true));
		$data = array_diff_key($data, $removed);
		return [$data, $removed];
	}

}

?>