<?php
namespace RESTAPI;

/**
 * @author     Jan-Hendrik Willms <tleilax+studip@gmail.com>
 * @author     <mlunzena@uos.de>
 * @license    GPL 2 or later
 * @since      Stud.IP 3.0
 * @deprecated Since Stud.IP 5.0. Will be removed in Stud.IP 5.2.
 */
class UriTemplate
{
    public function __construct($uri_template, $conditions = [])
    {
        $this->uri_template = $uri_template;
        $this->conditions = $conditions;
    }

    /**
     * Tests whether an uri matches a template.
     *
     * The template may contain placeholders by prefixing an appropriate,
     * unique placeholder name with a colon (:).
     *
     * <code>$template = '/hello/:name';</code>
     *
     * If the uri matches the template, all evaluated placeholders will
     * be stored in the parameters array.
     *
     * @param String $uri        The uri to test
     * @param Array  $parameters Stores evaluated parameters on match (optional)
     *
     * @return bool Returns true if the uri matches the template
     */
    public function match($uri, &$parameters = null)
    {
        // Initialize parameters array
        $parameters = [];

        // Split and normalize uri and template
        $given = array_filter(explode('/', $uri), 'mb_strlen');
        $rules = array_filter(explode('/', $this->uri_template));

        // Leave if uri and template do not contain the same number of
        // elements
        if (count($given) !== count($rules)) {
            return false;
        }

        // Combine uri and template element-wise (simplifies iteration)
        $combined = array_combine($rules, $given);

        // Iterate over uri and template and compare element by element
        foreach ($combined as $rule => $actual) {
            if ($rule[0] === ':') {
                // Rule is a placeholder
                $parameter_name = mb_substr($rule, 1);

                if (isset($this->conditions[$parameter_name])
                    && !preg_match($this->conditions[$parameter_name], $actual)) {
                    return false;
                }

                $parameters[$parameter_name] = $actual;

            } elseif ($actual !== $rule) {
                // Elements do not match
                $parameters = [];
                return false;
            }
        }

        return true;
    }


    public function inject($params)
    {
        // Initialize parameters array
        $parameters = [];

        // Split and normalize template
        $rules = array_filter(explode('/', $this->uri_template));

        foreach ($rules as &$rule) {

            // Rule is a placeholder
            if ($rule[0] === ':') {
                $parameter_name = mb_substr($rule, 1);

                if (!isset($params[$parameter_name])) {
                    $reason = sprintf('UriTemplate parameter :%s missing.',
                                      htmlReady($parameter_name));
                    throw new \RuntimeException($reason);
                }

                $actual = $params[$parameter_name];

                if (isset($this->conditions[$parameter_name])
                    && !preg_match($this->conditions[$parameter_name], $actual)) {
                    $reason = sprintf('UriTemplate parameter :%s did not satisfy its condition.',
                                      htmlReady($parameter_name));
                    throw new \RuntimeException($reason);
                }

                $rule = htmlReady($actual);
            }
        }

        return join('/', $rules);
    }
}