View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.link;
35  
36  import java.util.Collection;
37  import java.util.Iterator;
38  
39  import info.magnolia.cms.beans.config.URI2RepositoryManager;
40  import info.magnolia.cms.beans.config.URI2RepositoryMapping;
41  import info.magnolia.cms.i18n.I18nContentSupportFactory;
42  import info.magnolia.context.MgnlContext;
43  
44  import org.apache.commons.lang.StringUtils;
45  
46  /**
47   * @author had
48   * @version $Id: AbsolutePathTransformer.java 32667 2010-03-13 00:37:06Z gjoseph $
49   * @deprecated since 4.0 use {@link info.magnolia.link.AbsolutePathTransformer} instead
50   */
51  public class AbsolutePathTransformer{
52  
53      boolean addContextPath = true;
54  
55      boolean useURI2RepositoryMapping = true;
56  
57      boolean useI18N = true;
58  
59      /**
60       * Creates new transformer.
61       * @param addContextPath Flag to specify whether or not to prepend context path to created links.
62       * @param useURI2RepositoryMapping Flag specifying whether or not to apply any URI2Repository mapping.
63       * @param useI18N Flag specifying whether or not to translate link path based on current locale value.
64       */
65      public AbsolutePathTransformer(boolean addContextPath, boolean useURI2RepositoryMapping, boolean useI18N) {
66          this.addContextPath = addContextPath;
67          this.useURI2RepositoryMapping = useURI2RepositoryMapping;
68          this.useI18N = useI18N;
69      }
70  
71      /**
72       * {@inheritDoc}
73       */
74      public String transform(UUIDLink uuidLink) {
75          String linkStr;
76          if(useURI2RepositoryMapping){
77              Collection mappings = getURI2RepositoryManager().getMappings();
78              for (Iterator iter = mappings.iterator(); iter.hasNext();) {
79                  URI2RepositoryMapping mapping = (URI2RepositoryMapping) iter.next();
80                  if (StringUtils.equals(mapping.getRepository(), uuidLink.getRepository()) && uuidLink.getHandle().startsWith(mapping.getHandlePrefix())) {
81                      return mapping.getURI(uuidLink.getHandle());
82                  }
83              }
84              return getURI2RepositoryManager().getDefaultMapping().getURI(uuidLink.getHandle());
85          }
86          else{
87              linkStr = getURI2RepositoryManager().getDefaultMapping().getURI(uuidLink.getHandle());
88          }
89          linkStr += getURISuffix(uuidLink);
90          if(useI18N){
91              linkStr = I18nContentSupportFactory.getI18nSupport().toI18NURI(linkStr);
92          }
93          linkStr = prefixLink(linkStr);
94          return linkStr;
95      }
96  
97      protected URI2RepositoryManager getURI2RepositoryManager() {
98          return URI2RepositoryManager.getInstance();
99      }
100 
101     protected String prefixLink(String linkStr) {
102         if(addContextPath){
103             return MgnlContext.getContextPath() + linkStr;
104         }
105         return linkStr;
106     }
107 
108     /**
109      * URI after the path
110      */
111     public String getURISuffix(UUIDLink uuidLink) {
112         String anchor = uuidLink.getAnchor();
113         String parameters = uuidLink.getParameters();
114 
115         return "" + (StringUtils.isNotEmpty(anchor)? "#" + anchor : "") +
116         (StringUtils.isNotEmpty(parameters)? "?" + parameters : "");
117 
118     }
119 
120     public boolean isAddContextPath() {
121         return this.addContextPath;
122     }
123 
124 
125     public void setAddContextPath(boolean addContextPath) {
126         this.addContextPath = addContextPath;
127     }
128 
129 
130     public boolean isUseI18N() {
131         return this.useI18N;
132     }
133 
134 
135     public void setUseI18N(boolean useI18N) {
136         this.useI18N = useI18N;
137     }
138 
139 
140     public boolean isUseURI2RepositoryMapping() {
141         return this.useURI2RepositoryMapping;
142     }
143 
144 
145     public void setUseURI2RepositoryMapping(boolean useURI2RepositoryMapping) {
146         this.useURI2RepositoryMapping = useURI2RepositoryMapping;
147     }
148 
149 }