1 /**
2 * This file Copyright (c) 2003-2018 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.lang3.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 info.magnolia.cms.i18n.AbstractI18nContentSupport} for details.
47 */
48 public class AbsolutePathTransformer implements LinkTransformer {
49
50 boolean addContextPath = true;
51
52 boolean useURI2RepositoryMapping = true;
53
54 boolean useI18N = true;
55
56 public AbsolutePathTransformer() {
57 }
58
59 /**
60 * Creates new transformer.
61 *
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 @Override
76 public String transform(Link uuidLink) {
77 String linkStr;
78 if (useURI2RepositoryMapping) {
79 linkStr = getURI2RepositoryManager().getURI(uuidLink);
80 } else {
81 linkStr = getURI2RepositoryManager().getDefaultMapping().getURI(uuidLink);
82 }
83 linkStr += getURISuffix(uuidLink);
84 if (useI18N) {
85 linkStr = Components.getComponent(I18nContentSupport.class).toI18NURI(linkStr);
86 }
87 linkStr = prefixLink(linkStr);
88 return linkStr;
89 }
90
91 protected URI2RepositoryManager getURI2RepositoryManager() {
92 return Components.getComponent(URI2RepositoryManager.class);
93 }
94
95 protected String prefixLink(String linkStr) {
96 if (addContextPath) {
97 return MgnlContext.getContextPath() + linkStr;
98 }
99 return linkStr;
100 }
101
102 /**
103 * Gets reminder of the URI after the path (i.e. anchor and parameters).
104 */
105 public String getURISuffix(Link uuidLink) {
106 String anchor = uuidLink.getAnchor();
107 String parameters = uuidLink.getParameters();
108
109 return "" + (StringUtils.isNotEmpty(anchor) ? "#" + anchor : "") +
110 (StringUtils.isNotEmpty(parameters) ? "?" + parameters : "");
111
112 }
113
114 public boolean isAddContextPath() {
115 return this.addContextPath;
116 }
117
118
119 public void setAddContextPath(boolean addContextPath) {
120 this.addContextPath = addContextPath;
121 }
122
123
124 public boolean isUseI18N() {
125 return this.useI18N;
126 }
127
128
129 public void setUseI18N(boolean useI18N) {
130 this.useI18N = useI18N;
131 }
132
133
134 public boolean isUseURI2RepositoryMapping() {
135 return this.useURI2RepositoryMapping;
136 }
137
138
139 public void setUseURI2RepositoryMapping(boolean useURI2RepositoryMapping) {
140 this.useURI2RepositoryMapping = useURI2RepositoryMapping;
141 }
142
143 }
144