From 9d33c74b02dfab0f025b608a4a0217e044b993eb Mon Sep 17 00:00:00 2001 From: Lukasz Lenart Date: Fri, 7 Sep 2012 05:48:49 +0000 Subject: [PATCH] WW-2749 adds support for Tiles in Porlets as a dedicated plugin with new PortletTilesResult git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@1381887 13f79535-47bb-0310-9956-ffa450edef68 --- plugins/pom.xml | 1 + plugins/portlet-tiles/pom.xml | 67 +++++++ .../views/tiles/PortletTilesResult.java | 78 ++++++++ .../src/main/resources/LICENSE.txt | 174 ++++++++++++++++++ .../src/main/resources/NOTICE.txt | 5 + .../src/main/resources/struts-plugin.xml | 42 +++++ .../tiles/StrutsTilesRequestContext.java | 24 +-- 7 files changed, 377 insertions(+), 14 deletions(-) create mode 100644 plugins/portlet-tiles/pom.xml create mode 100644 plugins/portlet-tiles/src/main/java/org/apache/struts2/views/tiles/PortletTilesResult.java create mode 100644 plugins/portlet-tiles/src/main/resources/LICENSE.txt create mode 100644 plugins/portlet-tiles/src/main/resources/NOTICE.txt create mode 100644 plugins/portlet-tiles/src/main/resources/struts-plugin.xml diff --git a/plugins/pom.xml b/plugins/pom.xml index 597db9db5..9ce70c6f9 100644 --- a/plugins/pom.xml +++ b/plugins/pom.xml @@ -57,6 +57,7 @@ dojo rest portlet + portlet-tiles junit testng dwr diff --git a/plugins/portlet-tiles/pom.xml b/plugins/portlet-tiles/pom.xml new file mode 100644 index 000000000..c1776c6db --- /dev/null +++ b/plugins/portlet-tiles/pom.xml @@ -0,0 +1,67 @@ + + + + 4.0.0 + + org.apache.struts + struts2-plugins + 2.3.5-SNAPSHOT + + org.apache.struts + struts2-portlet-tiles-plugin + jar + Struts 2 Portlet Tiles Plugin + + + scm:svn:http://svn.apache.org/repos/asf/struts/struts2/trunk/plugins/portlet-tiles/ + scm:svn:https://svn.apache.org/repos/asf/struts/struts2/trunk/plugins/portlet-tiles/ + http://svn.apache.org/viewcvs.cgi/struts/struts2/trunk/plugins/portlet-tiles/ + + + + + org.apache.struts + struts2-tiles-plugin + + + org.apache.struts + struts2-portlet-plugin + + + javax.servlet + jsp-api + provided + + + javax.portlet + portlet-api + provided + + + org.apache.tiles + tiles-jsp + runtime + + + diff --git a/plugins/portlet-tiles/src/main/java/org/apache/struts2/views/tiles/PortletTilesResult.java b/plugins/portlet-tiles/src/main/java/org/apache/struts2/views/tiles/PortletTilesResult.java new file mode 100644 index 000000000..c08a99bb3 --- /dev/null +++ b/plugins/portlet-tiles/src/main/java/org/apache/struts2/views/tiles/PortletTilesResult.java @@ -0,0 +1,78 @@ +package org.apache.struts2.views.tiles; + +import com.opensymphony.xwork2.ActionInvocation; +import freemarker.template.TemplateException; +import org.apache.struts2.ServletActionContext; +import org.apache.struts2.dispatcher.ServletDispatcherResult; +import org.apache.struts2.portlet.PortletConstants; +import org.apache.struts2.portlet.context.PortletActionContext; +import org.apache.tiles.TilesContainer; +import org.apache.tiles.TilesException; +import org.apache.tiles.access.TilesAccess; + +import javax.portlet.ActionResponse; +import javax.portlet.PortletException; +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.Map; + +/** + * JIRA WW-2749 (STRUTS). + */ +public class PortletTilesResult extends ServletDispatcherResult { + + private static final long serialVersionUID = -3806939435493086244L; + + public PortletTilesResult() { + super(); + } + + public PortletTilesResult(String location) { + super(location); + } + + // FIXME PATCH du JIRA WW-2749 (STRUTS) + public void doExecute(String location, ActionInvocation invocation) + throws IOException, TemplateException, PortletException, TilesException { + + if (PortletActionContext.getPhase().isAction() || PortletActionContext.getPhase().isEvent()) { + executeActionResult(location, invocation); + } else { + executeRenderResult(location); + } + } + + /** + * @param location + * @throws TilesException + */ + protected void executeRenderResult(String location) throws TilesException { + setLocation(location); + + ServletContext servletContext = ServletActionContext.getServletContext(); + TilesContainer container = TilesAccess.getContainer(servletContext); + + HttpServletRequest request = ServletActionContext.getRequest(); + HttpServletResponse response = ServletActionContext.getResponse(); + + container.render(location, request, response); + } + + /** + * @param location + * @param invocation + */ + protected void executeActionResult(String location, ActionInvocation invocation) { + ActionResponse res = PortletActionContext.getActionResponse(); + + res.setRenderParameter(PortletConstants.ACTION_PARAM, "tilesDirect"); + + Map sessionMap = invocation.getInvocationContext().getSession(); + sessionMap.put(PortletConstants.RENDER_DIRECT_LOCATION, location); + + res.setRenderParameter(PortletConstants.MODE_PARAM, PortletActionContext.getRequest().getPortletMode().toString()); + } + +} diff --git a/plugins/portlet-tiles/src/main/resources/LICENSE.txt b/plugins/portlet-tiles/src/main/resources/LICENSE.txt new file mode 100644 index 000000000..c6055ec8f --- /dev/null +++ b/plugins/portlet-tiles/src/main/resources/LICENSE.txt @@ -0,0 +1,174 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. diff --git a/plugins/portlet-tiles/src/main/resources/NOTICE.txt b/plugins/portlet-tiles/src/main/resources/NOTICE.txt new file mode 100644 index 000000000..12fa3b83d --- /dev/null +++ b/plugins/portlet-tiles/src/main/resources/NOTICE.txt @@ -0,0 +1,5 @@ +Apache Struts +Copyright 2000-2011 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). \ No newline at end of file diff --git a/plugins/portlet-tiles/src/main/resources/struts-plugin.xml b/plugins/portlet-tiles/src/main/resources/struts-plugin.xml new file mode 100644 index 000000000..425a21b51 --- /dev/null +++ b/plugins/portlet-tiles/src/main/resources/struts-plugin.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + ${location} + + + + + diff --git a/plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsTilesRequestContext.java b/plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsTilesRequestContext.java index 9c7b2e33d..6a397e2a1 100644 --- a/plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsTilesRequestContext.java +++ b/plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsTilesRequestContext.java @@ -21,21 +21,19 @@ package org.apache.struts2.tiles; -import java.io.IOException; - -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.apache.struts2.ServletActionContext; -import org.apache.struts2.views.freemarker.FreemarkerResult; -import org.apache.tiles.context.TilesRequestContext; -import org.apache.tiles.context.TilesRequestContextWrapper; - import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.ActionInvocation; import com.opensymphony.xwork2.inject.Container; import com.opensymphony.xwork2.util.logging.Logger; import com.opensymphony.xwork2.util.logging.LoggerFactory; +import org.apache.struts2.ServletActionContext; +import org.apache.struts2.views.freemarker.FreemarkerResult; +import org.apache.tiles.context.TilesRequestContext; +import org.apache.tiles.context.TilesRequestContextWrapper; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; /** * Default implementation of TilesUtil. @@ -52,7 +50,6 @@ public class StrutsTilesRequestContext extends TilesRequestContextWrapper { private static final Logger LOG = LoggerFactory.getLogger(StrutsTilesRequestContext.class); - /** * The mask used to detect requests which should be intercepted. */ @@ -74,14 +71,13 @@ public class StrutsTilesRequestContext extends TilesRequestContextWrapper { * @param mask * @param context */ - public StrutsTilesRequestContext(TilesRequestContext context, - String mask) { + public StrutsTilesRequestContext(TilesRequestContext context, String mask) { super(context); this.mask = mask; } public void dispatch(String include) throws IOException { - if (include.endsWith(mask)) { + if (include.endsWith(mask) || include.endsWith(".jsp")) { // FIXME This way FreeMarker results still don't have a content-type! include(include); } else {