View Javadoc

1   /**
2    * This file Copyright (c) 2003-2014 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.beans.config;
35  
36  import info.magnolia.cms.util.UrlPattern;
37  import info.magnolia.context.MgnlContext;
38  import info.magnolia.context.WebContext;
39  
40  import java.util.HashMap;
41  import java.util.Iterator;
42  import java.util.List;
43  import java.util.Map;
44  
45  import org.apache.commons.lang.StringUtils;
46  
47  /**
48   * Simple VirtualURI mapping that can forward to a different url depending on the request host name. The "host" property
49   * must be a list of uri=destination strings. See below for a sample configuration:
50   * 
51   * <pre>
52   * [] virtualURIMapping
53   *    [] default
54   *     - class            info.magnolia.cms.beans.config.HostBasedVirtualURIMapping
55   *     - fromURI          /
56   *     - toURI            redirect:/.magnolia/pages/adminCentral.html
57   *       [] hosts
58   *        - 1             www.acme.com=forward:/acme/en/index.html
59   *        - 2             www.acme.de=forward:/acme/de/index.html
60   * </pre>
61   */
62  public class HostBasedVirtualURIMapping extends DefaultVirtualURIMapping {
63  
64      private UrlPattern pattern;
65  
66      protected Map<String, String> hosts = new HashMap<String, String>();
67  
68      /**
69       *
70       */
71      public HostBasedVirtualURIMapping() {
72          hosts = new HashMap<String, String>();
73      }
74  
75      // required by content2bean in order to make addHost work, do not remove!
76      public List<String> getHosts() {
77          return null;
78      }
79  
80      public void setHosts(List<String> hosts) {
81          String[] hostToPath = null;
82          for (String host : hosts) {
83              hostToPath = StringUtils.split(host, "=");
84              if (hostToPath != null && hostToPath.length == 2) {
85                  this.hosts.put(hostToPath[0], hostToPath[1]);
86              }
87          }
88      }
89  
90      /**
91       * Adds a host mapping (used by content2bean).
92       * 
93       * @param mapping in the form host=path
94       */
95      public void addHost(String mapping) {
96          String[] hostToPath = StringUtils.split(mapping, "=");
97          if (hostToPath != null && hostToPath.length == 2) {
98              synchronized (hosts) {
99                  hosts.put(hostToPath[0], hostToPath[1]);
100             }
101         }
102     }
103 
104     @Override
105     public MappingResult mapURI(String uri) {
106 
107         String destination = toURI;
108 
109         if (pattern != null && pattern.match(uri)) {
110             String hostMapping = this.tryToMapHost();
111             if (hostMapping != null) {
112                 destination = hostMapping;
113             }
114 
115             MappingResult r = new MappingResult();
116             r.setLevel(pattern.getLength());
117             r.setToURI(destination);
118             return r;
119         }
120         return null;
121     }
122 
123     protected String tryToMapHost() {
124         if (hosts != null && !hosts.isEmpty()) {
125             String requestHost = ((WebContext) MgnlContext.getInstance()).getRequest().getServerName();
126             Iterator<Map.Entry<String, String>> hostIt = hosts.entrySet().iterator();
127 
128             while (hostIt.hasNext()) {
129 
130                 Map.Entry<String, String> hk = hostIt.next();
131                 if (requestHost.endsWith(hk.getKey())) {
132                     return hk.getValue();
133                 }
134             }
135         }
136         return null;
137     }
138 
139     @Override
140     public String toString() {
141         return "[" + super.toString() + "[hosts:" + hosts + "]]";
142     }
143 
144 }