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.link;
35
36 import info.magnolia.cms.beans.config.URI2RepositoryManager;
37 import info.magnolia.cms.i18n.I18nContentSupport;
38 import info.magnolia.context.MgnlContext;
39 import info.magnolia.objectfactory.Components;
40
41 import org.apache.commons.lang.StringUtils;
42
43 /**
44 * Creates links with the absolute path. Alternatively can prefix links with the webapp context path as well.
45 * Transformer is also capable of applying URI2Repository mapping and i18n (mapping links to different path
46 * based on the current locale value). See {@link AbstractI18nContentSupport} for details.
47 * @author had
48 * @version $Id:$
49 */
50 public class AbsolutePathTransformer implements LinkTransformer {
51
52 boolean addContextPath = true;
53
54 boolean useURI2RepositoryMapping = true;
55
56 boolean useI18N = true;
57
58 public AbsolutePathTransformer() {
59 }
60
61 /**
62 * Creates new transformer.
63 * @param addContextPath Flag to specify whether or not to prepend context path to created links.
64 * @param useURI2RepositoryMapping Flag specifying whether or not to apply any URI2Repository mapping.
65 * @param useI18N Flag specifying whether or not to translate link path based on current locale value.
66 */
67 public AbsolutePathTransformer(boolean addContextPath, boolean useURI2RepositoryMapping, boolean useI18N) {
68 this.addContextPath = addContextPath;
69 this.useURI2RepositoryMapping = useURI2RepositoryMapping;
70 this.useI18N = useI18N;
71 }
72
73 /**
74 * {@inheritDoc}
75 */
76 @Override
77 public String transform(Link uuidLink) {
78 String linkStr;
79 if(useURI2RepositoryMapping){
80 linkStr = getURI2RepositoryManager().getURI(uuidLink);
81 }
82 else{
83 linkStr = getURI2RepositoryManager().getDefaultMapping().getURI(uuidLink);
84 }
85 linkStr += getURISuffix(uuidLink);
86 if(useI18N){
87 linkStr = Components.getComponent(I18nContentSupport.class).toI18NURI(linkStr);
88 }
89 linkStr = prefixLink(linkStr);
90 return linkStr;
91 }
92
93 protected URI2RepositoryManager getURI2RepositoryManager() {
94 return Components.getComponent(URI2RepositoryManager.class);
95 }
96
97 protected String prefixLink(String linkStr) {
98 if(addContextPath){
99 return MgnlContext.getContextPath() + linkStr;
100 }
101 return linkStr;
102 }
103
104 /**
105 * Gets reminder of the URI after the path (i.e. anchor and parameters).
106 */
107 public String getURISuffix(Link uuidLink) {
108 String anchor = uuidLink.getAnchor();
109 String parameters = uuidLink.getParameters();
110
111 return "" + (StringUtils.isNotEmpty(anchor)? "#" + anchor : "") +
112 (StringUtils.isNotEmpty(parameters)? "?" + parameters : "");
113
114 }
115
116 public boolean isAddContextPath() {
117 return this.addContextPath;
118 }
119
120
121 public void setAddContextPath(boolean addContextPath) {
122 this.addContextPath = addContextPath;
123 }
124
125
126 public boolean isUseI18N() {
127 return this.useI18N;
128 }
129
130
131 public void setUseI18N(boolean useI18N) {
132 this.useI18N = useI18N;
133 }
134
135
136 public boolean isUseURI2RepositoryMapping() {
137 return this.useURI2RepositoryMapping;
138 }
139
140
141 public void setUseURI2RepositoryMapping(boolean useURI2RepositoryMapping) {
142 this.useURI2RepositoryMapping = useURI2RepositoryMapping;
143 }
144
145 }
146