View Javadoc
1   /**
2    * This file Copyright (c) 2017 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.context;
35  
36  import info.magnolia.cms.beans.runtime.MultipartForm;
37  import info.magnolia.cms.core.AggregationState;
38  import info.magnolia.cms.core.HTMLEscapingAggregationState;
39  import info.magnolia.cms.core.HierarchyManager;
40  import info.magnolia.cms.core.search.QueryManager;
41  import info.magnolia.cms.i18n.Messages;
42  import info.magnolia.cms.security.AccessManager;
43  import info.magnolia.cms.security.User;
44  import info.magnolia.objectfactory.Components;
45  
46  import java.io.IOException;
47  import java.io.Writer;
48  import java.util.Collection;
49  import java.util.Locale;
50  import java.util.Map;
51  import java.util.Set;
52  import java.util.function.BiConsumer;
53  import java.util.function.BiFunction;
54  import java.util.function.Function;
55  
56  import javax.jcr.LoginException;
57  import javax.jcr.RepositoryException;
58  import javax.jcr.Session;
59  import javax.security.auth.Subject;
60  import javax.servlet.ServletContext;
61  import javax.servlet.ServletException;
62  import javax.servlet.http.HttpServletRequest;
63  import javax.servlet.http.HttpServletResponse;
64  import javax.servlet.jsp.PageContext;
65  
66  /**
67   * A wrapper around {@link WebContext} which will return an escaped {@link AggregationState}.
68   *
69   * @see HTMLEscapingAggregationState
70   * @see #getAggregationState()
71   */
72  public class HTMLEscapingWebContextWrapper implements WebContext {
73  
74      private WebContext original;
75  
76      public HTMLEscapingWebContextWrapper(WebContext original) {
77          this.original = original;
78      }
79  
80      /**
81       * @return the unwrapped/original {@link WebContext}
82       */
83      public WebContext unwrap() {
84          return original;
85      }
86  
87      @Override
88      public void init(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext) {
89          original.init(request, response, servletContext);
90      }
91  
92      /**
93       * @return AggregationState wrapped as {@link HTMLEscapingAggregationState}.
94       */
95      @Override
96      public AggregationState getAggregationState() {
97          return Components.getComponent(HTMLEscapingAggregationState.class);
98      }
99  
100     @Override
101     public void resetAggregationState() {
102         original.resetAggregationState();
103     }
104 
105     @Override
106     public MultipartForm getPostedForm() {
107         return original.getPostedForm();
108     }
109 
110     @Override
111     public String getParameter(String name) {
112         return original.getParameter(name);
113     }
114 
115     @Override
116     public Map<String, String> getParameters() {
117         return original.getParameters();
118     }
119 
120     @Override
121     public String getContextPath() {
122         return original.getContextPath();
123     }
124 
125     @Override
126     public HttpServletRequest getRequest() {
127         return original.getRequest();
128     }
129 
130     @Override
131     public HttpServletResponse getResponse() {
132         return original.getResponse();
133     }
134 
135     @Override
136     public User getUser() {
137         return original.getUser();
138     }
139 
140     @Override
141     public Subject getSubject() {
142         return original.getSubject();
143     }
144 
145     @Override
146     public void setLocale(Locale locale) {
147         original.setLocale(locale);
148     }
149 
150     @Override
151     public ServletContext getServletContext() {
152         return original.getServletContext();
153     }
154 
155     @Override
156     public Locale getLocale() {
157         return original.getLocale();
158     }
159 
160     @Override
161     public Session getJCRSession(String workspaceName) throws LoginException, RepositoryException {
162         return original.getJCRSession(workspaceName);
163     }
164 
165     @Override
166     public void include(String path, Writer out) throws ServletException, IOException {
167         original.include(path, out);
168     }
169 
170     @Override
171     @Deprecated
172     public HierarchyManager getHierarchyManager(String workspaceName) {
173         return original.getHierarchyManager(workspaceName);
174     }
175 
176     @Override
177     public AccessManager getAccessManager(String name) {
178         return original.getAccessManager(name);
179     }
180 
181     @Override
182     public void setPageContext(PageContext pageContext) {
183         original.setPageContext(pageContext);
184     }
185 
186     @Override
187     @Deprecated
188     public QueryManager getQueryManager(String workspaceName) {
189         return original.getQueryManager(workspaceName);
190     }
191 
192     @Override
193     public PageContext getPageContext() {
194         return original.getPageContext();
195     }
196 
197     @Override
198     public void push(HttpServletRequest request, HttpServletResponse response) {
199         original.push(request, response);
200     }
201 
202     @Override
203     public void pop() {
204         original.pop();
205     }
206 
207     @Override
208     public void setAttribute(String name, Object value, int scope) {
209         original.setAttribute(name, value, scope);
210     }
211 
212     @Override
213     public String[] getParameterValues(String name) {
214         return original.getParameterValues(name);
215     }
216 
217     @Override
218     public <T> T getAttribute(String name, int scope) {
219         return original.getAttribute(name, scope);
220     }
221 
222     @Override
223     public <T> T getAttribute(String name) {
224         return original.getAttribute(name);
225     }
226 
227     @Override
228     public Map<String, Object> getAttributes(int scope) {
229         return original.getAttributes(scope);
230     }
231 
232     @Override
233     public void removeAttribute(String name, int scope) {
234         original.removeAttribute(name, scope);
235     }
236 
237     @Override
238     public Map<String, Object> getAttributes() {
239         return original.getAttributes();
240     }
241 
242     @Override
243     public Messages getMessages() {
244         return original.getMessages();
245     }
246 
247     @Override
248     public Messages getMessages(String basename) {
249         return original.getMessages(basename);
250     }
251 
252     @Override
253     public void release() {
254         original.release();
255     }
256 
257     @Override
258     public int size() {
259         return original.size();
260     }
261 
262     @Override
263     public boolean isEmpty() {
264         return original.isEmpty();
265     }
266 
267     @Override
268     public boolean containsKey(Object key) {
269         return original.containsKey(key);
270     }
271 
272     @Override
273     public boolean containsValue(Object value) {
274         return original.containsValue(value);
275     }
276 
277     @Override
278     public Object get(Object key) {
279         return original.get(key);
280     }
281 
282     @Override
283     public Object put(Object key, Object value) {
284         return original.put(key, value);
285     }
286 
287     @Override
288     public Object remove(Object key) {
289         return original.remove(key);
290     }
291 
292     @Override
293     public void putAll(Map m) {
294         original.putAll(m);
295     }
296 
297     @Override
298     public void clear() {
299         original.clear();
300     }
301 
302     @Override
303     public Set keySet() {
304         return original.keySet();
305     }
306 
307     @Override
308     public Collection values() {
309         return original.values();
310     }
311 
312     @Override
313     public Set<Entry> entrySet() {
314         return original.entrySet();
315     }
316 
317     @Override
318     public boolean equals(Object o) {
319         return original.equals(o);
320     }
321 
322     @Override
323     public int hashCode() {
324         return original.hashCode();
325     }
326 
327     @Override
328     public Object getOrDefault(Object key, Object defaultValue) {
329         return original.getOrDefault(key, defaultValue);
330     }
331 
332     @Override
333     public void forEach(BiConsumer action) {
334         original.forEach(action);
335     }
336 
337     @Override
338     public void replaceAll(BiFunction function) {
339         original.replaceAll(function);
340     }
341 
342     @Override
343     public Object putIfAbsent(Object key, Object value) {
344         return original.putIfAbsent(key, value);
345     }
346 
347     @Override
348     public boolean remove(Object key, Object value) {
349         return original.remove(key, value);
350     }
351 
352     @Override
353     public boolean replace(Object key, Object oldValue, Object newValue) {
354         return original.replace(key, oldValue, newValue);
355     }
356 
357     @Override
358     public Object replace(Object key, Object value) {
359         return original.replace(key, value);
360     }
361 
362     @Override
363     public Object computeIfAbsent(Object key, Function mappingFunction) {
364         return original.computeIfAbsent(key, mappingFunction);
365     }
366 
367     @Override
368     public Object computeIfPresent(Object key, BiFunction remappingFunction) {
369         return original.computeIfPresent(key, remappingFunction);
370     }
371 
372     @Override
373     public Object compute(Object key, BiFunction remappingFunction) {
374         return original.compute(key, remappingFunction);
375     }
376 
377     @Override
378     public Object merge(Object key, Object value, BiFunction remappingFunction) {
379         return original.merge(key, value, remappingFunction);
380     }
381 }