/**
    * This file Copyright (c) 2003-2015 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.cms.beans.config;
  
  import info.magnolia.context.MgnlContext;
  import info.magnolia.context.WebContext;
  
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  
  import org.apache.commons.lang3.StringUtils;
  
  /**
   * Simple VirtualURI mapping that can forward to a different url depending on the request host name. The "mappings" node
   * contains a list of nodes with "host" and "toURI" properties.
   * See below for a sample configuration:
   *
   * <pre>
   * [] virtualURIMapping
   *    [] default
   *     - class            info.magnolia.cms.beans.config.HostBasedVirtualURIMapping
   *     - fromURI          /
   *     - toURI            redirect:/.magnolia/pages/adminCentral.html
   *       [] mappings
   *        - [] com
   *          - host      www.acme.com
   *          - toURI     forward:/acme/en/index.html
   *        - [] de
   *          - host      www.acme.de
   *          - toURI     forward:/acme/de/index.html
   * </pre>
   *
   * For backwards compatibility The "host" property may still be used, it contains
   * a list of uri=destination strings.
   * This technique is deprecated primarily because the properties of a node do not have a deterministic order.
   * See below for a sample configuration of the deprecated approach using 'hosts' node.:
   *
   * <pre>
   * [] virtualURIMapping
   *    [] default
   *     - class            info.magnolia.cms.beans.config.HostBasedVirtualURIMapping
   *     - fromURI          /
   *     - toURI            redirect:/.magnolia/pages/adminCentral.html
   *       [] hosts
   *        - 1             www.acme.com=forward:/acme/en/index.html
   *        - 2             www.acme.de=forward:/acme/de/index.html
   * </pre>
   */
  
  public class HostBasedVirtualURIMapping extends DefaultVirtualURIMapping {
  
      protected ArrayList<HostURIMapping> hosts;
  
      /**
       *
       */
      public HostBasedVirtualURIMapping() {
          hosts = new ArrayList<HostURIMapping>();
      }
  
      // required by content2bean in order to make addMapping work, do not remove!
      public List<HostURIMapping> getMappings() {
          return null;
      }
  
      /**
       * Adds a mapping (used by content2bean).
      *
      * @param mapping object.
      */
     public void addMapping(HostURIMapping mapping) {
         if (mapping.getHost() != null && mapping.getToURI() != null) {
             synchronized (hosts) {
                 hosts.add(mapping);
             }
         }
     }
 
     // required by content2bean in order to make addHost work, do not remove!
     // @Deprecated since 4.5.18, content2bean mechanism will recognize getMappings() method to call the addMapping method.
     @Deprecated
     public List<String> getHosts() {
         return null;
     }
 
 
     /**
      * @param mapping in the form host=path
      * @Deprecated since 4.5.18, Use {@link #addMapping(HostURIMapping))} instead.
      * Adds a host mapping (used by content2bean).
      */
     @Deprecated
     public void addHost(String mapping) {
         String[] hostToPath = StringUtils.split(mapping, "=");
         if (hostToPath != null && hostToPath.length == 2) {
             synchronized (hosts) {
                 hosts.add(new HostURIMapping(hostToPath[0], hostToPath[1]));
             }
         }
     }
 
     @Override
     public MappingResult mapURI(String uri) {
 
         String destination = toURI;
 
         if (pattern != null && pattern.match(uri)) {
             String hostMapping = this.tryToMapHost();
             if (hostMapping != null) {
                 destination = hostMapping;
             }
 
             MappingResult r = new MappingResult();
             r.setLevel(pattern.getLength());
             r.setToURI(destination);
             return r;
         }
         return null;
     }
 
     /**
      * Choose the mapping host that matches the request host, with the least number of additional characters.
      *
      * @return The URI to map to.
      */
     protected String tryToMapHost() {
         final int NO_MATCHED_MAPPINGS = -1;
         int bestMatchValue = NO_MATCHED_MAPPINGS;
         String toURI = null;
 
         if (hosts != null && !hosts.isEmpty()) {
             String requestHost = ((WebContext) MgnlContext.getInstance()).getRequest().getServerName();
 
             Iterator<HostURIMapping> hostIt = hosts.iterator();
 
             while (hostIt.hasNext()) {
                 HostURIMapping hk = hostIt.next();
                 if (requestHost.endsWith(hk.getHost())) {
                     int matchValue = (requestHost.length() - hk.getHost().length());
                     if (bestMatchValue == NO_MATCHED_MAPPINGS || matchValue < bestMatchValue) {
                         bestMatchValue = matchValue;
                         toURI = hk.getToURI();
                     }
                 }
             }
         }
         return toURI;
     }
 
     @Override
     public String toString() {
         return "[" + super.toString() + "[hosts:" + hosts.toString() + "]]";
     }
 
     /**
      * HostURIMapping object to receive "mapping" nodes in configuration.
      */
     public static class HostURIMapping {
 
         // Empty constructor required for content2bean.
         public HostURIMapping() {
         }
 
         public HostURIMapping(String host, String toURI) {
             this.host = host;
             this.toURI = toURI;
         }
 
         private String host;
 
         private String toURI;
 
         public String getHost() {
             return this.host;
         }
 
         public void setHost(String host) {
             this.host = host;
         }
 
         public String getToURI() {
             return this.toURI;
         }
 
         public void setToURI(String toURI) {
             this.toURI = toURI;
         }
 
         @Override
         public String toString() {
             return getHost() + "=" + getToURI();
 
         }
     }
 
 }