/**
    * This file Copyright (c) 2010-2014 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.module.blossom.view;
  
  import java.util.Locale;
  
  import org.springframework.beans.factory.BeanInitializationException;
  import org.springframework.beans.factory.InitializingBean;
  import org.springframework.core.Ordered;
  import org.springframework.web.servlet.View;
  import org.springframework.web.servlet.ViewResolver;
  
  import info.magnolia.context.MgnlContext;
  import info.magnolia.repository.RepositoryConstants;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  /**
   * Adds support for redirects based on uuids. By default supports the formats "website:uuid" and "dms:uuid" for sending
   * redirects for the website and dms workspaces. The prefixes and the workspaces they map to are configurable and
   * can be changed to support more workspaces.
   *
   * @see UuidRedirectView
   * @since 1.2
   */
  public class UuidRedirectViewResolver implements ViewResolver, Ordered, InitializingBean {
  
      public static final String REDIRECT_MAIN_CONTENT_PLACEHOLDER = "magnolia-redirect:main-content";
      public static final String REDIRECT_CURRENT_CONTENT_PLACEHOLDER = "magnolia-redirect:current-content";
  
      private String[] workspaces = new String[]{RepositoryConstants.WEBSITE, "dms"};
      private String[] prefixes;
      private boolean http10Compatible = true;
      private int order = Integer.MAX_VALUE;
      private boolean exposeModelAttributes = true;
  
      @Override
      public int getOrder() {
          return order;
      }
  
      public void setOrder(int order) {
          this.order = order;
      }
  
      public String[] getWorkspaces() {
          return workspaces;
      }
  
      public void setWorkspaces(String[] workspaces) {
          this.workspaces = workspaces;
      }
  
      public void setWorkspace(String workspace) {
          this.workspaces = new String[]{workspace};
      }
  
      @Deprecated
      public String[] getRepositories() {
          return workspaces;
      }
  
      @Deprecated
      public void setRepositories(String[] repositories) {
          this.workspaces = repositories;
      }
  
     @Deprecated
     public void setRepository(String repository) {
         this.workspaces = new String[]{repository};
     }
 
     public String[] getPrefixes() {
         return prefixes;
     }
 
     public void setPrefixes(String[] prefixes) {
         this.prefixes = prefixes;
     }
 
     public void setPrefix(String prefix) {
         this.prefixes = new String[]{prefix};
     }
 
     public boolean isHttp10Compatible() {
         return http10Compatible;
     }
 
     public void setHttp10Compatible(boolean http10Compatible) {
         this.http10Compatible = http10Compatible;
     }
 
     public boolean isExposeModelAttributes() {
         return exposeModelAttributes;
     }
 
     public void setExposeModelAttributes(boolean exposeModelAttributes) {
         this.exposeModelAttributes = exposeModelAttributes;
     }
 
     @Override
     public View resolveViewName(String viewName, Locale locale) throws Exception {
         if (viewName.equals(REDIRECT_MAIN_CONTENT_PLACEHOLDER)) {
             return createView(MgnlContext.getAggregationState().getMainContentNode());
         }
         if (viewName.equals(REDIRECT_CURRENT_CONTENT_PLACEHOLDER)) {
             return createView(MgnlContext.getAggregationState().getCurrentContentNode());
         }
         for (int i = 0; i < prefixes.length; i++) {
             String prefix = prefixes[i];
             if (viewName.startsWith(prefix)) {
                 return createView(workspaces[i], viewName.substring(prefix.length()));
             }
         }
         return null;
     }
 
     protected View createView(Node node) throws RepositoryException {
         return createView(node.getSession().getWorkspace().getName(), node.getIdentifier());
     }
 
     protected View createView(String workspace, String uuid) {
         UuidRedirectView view = new UuidRedirectView(workspace, uuid);
         view.setHttp10Compatible(http10Compatible);
         view.setExposeModelAttributes(exposeModelAttributes);
         return view;
     }
 
     @Override
     public void afterPropertiesSet() throws Exception {
         if (prefixes == null) {
             prefixes = new String[workspaces.length];
             for (int i = 0; i < workspaces.length; i++) {
                 prefixes[i] = workspaces[i] + ":";
             }
         }
         if (prefixes.length != workspaces.length) {
             throw new BeanInitializationException("The number of prefixes configured must match the number of workspaces.");
         }
     }
 }