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