View Javadoc

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