// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.rest;

import static org.apache.juneau.internal.StringUtils.*;

import java.util.*;
import java.util.regex.*;

import org.apache.juneau.rest.annotation.*;

/**
 * A parsed path pattern constructed from a {@link RestMethod#path() @RestMethod.path()} value.
 * 
 * <p>
 * Handles aspects of matching and precedence ordering.
 */
public final class UrlPathPattern implements Comparable<UrlPathPattern> {

   private final Pattern pattern;
   private final String patternString;
   private final boolean isOnlyDotAll, isDotAll;
   private final String[] vars;

   /**
    * Constructor.
    * 
    * @param patternString The raw pattern string from the {@link RestMethod#path() @RestMethod.path()} annotation.
    */
   public UrlPathPattern(String patternString) {
      this.patternString = patternString;
      Builder b = new Builder(patternString);
      pattern = b.pattern;
      isDotAll = b.isDotAll;
      isOnlyDotAll = b.isOnlyDotAll;
      vars = b.vars.toArray(new String[b.vars.size()]);
   }

   private final class Builder {
      boolean isDotAll, isOnlyDotAll;
      Pattern pattern;
      List<String> vars = new LinkedList<>();

      Builder(String patternString) {
         if (! startsWith(patternString, '/'))
            patternString = '/' + patternString;
         if (patternString.equals("/*")) {
            isOnlyDotAll = true;
            return;
         }
         if (patternString.endsWith("/*"))
            isDotAll = true;

         // Find all {xxx} variables.
         Pattern p = Pattern.compile("\\{([^\\}]+)\\}");
         Matcher m = p.matcher(patternString);
         while (m.find())
            vars.add(m.group(1));

         patternString = patternString.replaceAll("\\{[^\\}]+\\}", "([^\\/]+)");
         patternString = patternString.replaceAll("\\/\\*$", "((?:)|(?:\\/.*))");
         pattern = Pattern.compile(patternString);
      }
   }

   /**
    * Returns a non-<jk>null</jk> value if the specified path matches this pattern.
    * 
    * @param path The path to match against.
    * @return
    *    An array of values matched against <js>"{var}"</js> variable in the pattern, or an empty array if the
    *    pattern matched but no vars were present, or <jk>null</jk> if the specified path didn't match the pattern.
    */
   protected String[] match(String path) {

      if (isOnlyDotAll) {
         // Remainder always gets leading slash trimmed.
         if (path != null)
            path = path.substring(1);
         return new String[]{path};
      }

      if (path == null)
         return (patternString.equals("/") ? new String[]{} : null);

      // If we're not doing a /* match, ignore all trailing slashes.
      if (! isDotAll)
         while (path.length() > 1 && path.charAt(path.length()-1) == '/')
            path = path.substring(0, path.length()-1);

      Matcher m = pattern.matcher(path);
      if (! m.matches())
         return null;

      int len = m.groupCount();
      String[] v = new String[len];

      for (int i = 0; i < len; i++) {
         if (isDotAll && i == len-1)
            v[i] = m.group(i+1).isEmpty() ? null : m.group(i+1).substring(1);
         else
         v[i] = urlDecode(m.group(i+1));
      }

      return v;
   }

   /**
    * Comparator for this object.
    * 
    * <p>
    * The comparator is designed to order URL pattern from most-specific to least-specific.
    * For example, the following patterns would be ordered as follows:
    * <ol>
    *    <li><code>/foo/bar</code>
    *    <li><code>/foo/bar/*</code>
    *    <li><code>/foo/{id}/bar</code>
    *    <li><code>/foo/{id}/bar/*</code>
    *    <li><code>/foo/{id}</code>
    *    <li><code>/foo/{id}/*</code>
    *    <li><code>/foo</code>
    *    <li><code>/foo/*</code>
    * </ol>
    */
   @Override /* Comparable */
   public int compareTo(UrlPathPattern o) {
      String s1 = patternString.replaceAll("\\{[^\\}]+\\}", ".").replaceAll("\\w+", "X").replaceAll("\\.", "W");
      String s2 = o.patternString.replaceAll("\\{[^\\}]+\\}", ".").replaceAll("\\w+", "X").replaceAll("\\.", "W");
      if (s1.isEmpty())
         s1 = "+";
      if (s2.isEmpty())
         s2 = "+";
      if (! s1.endsWith("/*"))
         s1 = s1 + "/W";
      if (! s2.endsWith("/*"))
         s2 = s2 + "/W";
      int c = s2.compareTo(s1);
      if (c == 0)
         return o.toRegEx().compareTo(toRegEx());
      return c;
   }

   @Override /* Object */
   public boolean equals(Object o) {
      if (! (o instanceof UrlPathPattern))
         return false;
      return (compareTo((UrlPathPattern)o) == 0);
   }

   @Override /* Object */
   public int hashCode() {
      return super.hashCode();
   }

   @Override /* Object */
   public String toString() {
      return patternString;
   }

   /**
    * Returns this path pattern as the compiled regular expression.
    * 
    * <p>
    * Useful for debugging.
    * 
    * @return The path pattern.
    */
   public String toRegEx() {
      return isOnlyDotAll ? "*" : pattern.pattern();
   }

   /**
    * Bean property getter:  <property>vars</property>.
    * 
    * @return The value of the <property>vars</property> property on this bean, or <jk>null</jk> if it is not set.
    */
   public String[] getVars() {
      return vars;
   }

   /**
    * Bean property getter:  <property>patternString</property>.
    * 
    * @return The value of the <property>patternString</property> property on this bean, or <jk>null</jk> if it is not set.
    */
   public String getPatternString() {
      return patternString;
   }
}