View Javadoc

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.module.forum.frontend;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.security.SecurityUtil;
38  import info.magnolia.context.MgnlContext;
39  import info.magnolia.module.admininterface.PageMVCHandler;
40  import info.magnolia.module.forum.ForumManager;
41  import info.magnolia.link.LinkUtil;
42  import org.apache.commons.lang.StringUtils;
43  
44  import javax.jcr.RepositoryException;
45  import javax.servlet.http.HttpServletRequest;
46  import javax.servlet.http.HttpServletResponse;
47  import java.io.IOException;
48  
49  /**
50   * @author gjoseph
51   * @version $Revision: $ ($Author: $)
52   */
53  public class ForumController extends PageMVCHandler {
54      private final ForumManager forumManager;
55  
56      /** for tests and when we have ioc! */
57      protected ForumController(String name, HttpServletRequest request, HttpServletResponse response, ForumManager forumManager) {
58          super(name, request, response);
59          this.forumManager = forumManager;
60      }
61  
62      public ForumController(String name, HttpServletRequest request, HttpServletResponse response) {
63          this(name, request, response, ForumManager.Factory.getInstance());
64      }
65  
66      public String getCommand() {
67          return mandatoryParam("command");
68      }
69  
70      /**
71       * executes the method named after the return value of getCommand()
72       */
73      public String execute(String command) {
74          // TODO : maybe review, this will try to find a command in the catalog first,
75          // while we'd really like to just use super.super.execute()
76          return super.execute(command);
77      }
78  
79      /**
80       * This implementation does a redirect:
81       * - to the view parameter, using it as a url.
82       * - to the referer if the view argument was null. (i.e. if the command method was void or returned null explicitely)
83       */
84      public void renderHtml(final String view) throws IOException {
85          final String targetUrl;
86          if (view == null) {
87              targetUrl = request.getHeader("referer");
88          } else {
89              targetUrl = view;
90          }
91  
92          mandatory(targetUrl, "referer or target view");
93          response.sendRedirect(targetUrl);
94      }
95  
96      public void init() {
97          // do not populate this with beanutils, as super.init() does
98      }
99  
100     // ---------------- commands - these methods are called through reflection --------------------
101     // the regular return value for these should be the name of the "view" to show, but we're reaching the limits here
102     // and return an absolute url instead. renderHtml() knows about this.
103     public String createThread() throws RepositoryException {
104         final String forumId = mandatoryParam("forumId");
105         final String threadTitle = mandatoryParam("threadTitle");
106         final String messageText = mandatoryParam("messageText");
107         Content newThread;
108         
109         if (!SecurityUtil.isAnonymous()) {
110             final String userId = getUserId();
111             newThread = forumManager.createThread(forumId, threadTitle, messageText, userId, false);
112         } else {
113             final String anonymousUsername = mandatoryParam("anonymousUsername");
114             newThread = forumManager.createThread(forumId, threadTitle, messageText, anonymousUsername, true);
115         }
116 
117         // TODO : maybe the construction of the url should be left to the user/dialog and we should just replace parameters like {0}
118         // TODO : use/improve the link api to handle parameters
119         final String targetPageUUID = mandatoryParam("targetPage");
120         final String targetPage = LinkUtil.createAbsoluteLink("website", targetPageUUID);
121         return targetPage + "?threadId=" + newThread.getUUID() + "&forumId=" + forumId;
122     }
123 
124     public String replyToThread() throws RepositoryException {
125         final String threadId = mandatoryParam("threadId");
126         final String messageTitle = param("messageTitle");
127         final String messageText = mandatoryParam("messageText");
128         final String inReplyTo = param("inReplyTo");
129         
130         if (!SecurityUtil.isAnonymous()) {
131             final String userId = getUserId();
132             forumManager.replyToThread(threadId, inReplyTo, messageTitle, messageText, userId, false);
133         } else {
134             final String anonymousUsername = mandatoryParam("anonymousUsername");
135             forumManager.replyToThread(threadId, inReplyTo, messageTitle, messageText, anonymousUsername, true);
136         }
137 
138         final String targetPageUUID = param("targetPage");
139         if (StringUtils.isNotEmpty(targetPageUUID)) {
140             final String targetPage = LinkUtil.createAbsoluteLink("website", targetPageUUID);
141             return targetPage + "?threadId=" + threadId;
142         } else {
143             return null;
144         }
145 
146     }
147 
148     // TODO : use UUID ?
149     protected String getUserId() {
150         return MgnlContext.getUser().getName();
151     }
152 
153     private String param(String paramName) {
154         final String value = request.getParameter(paramName);
155         return StringUtils.stripToNull(value);
156     }
157 
158     private String mandatoryParam(String paramName) {
159         final String value = param(paramName);
160         mandatory(value, paramName);
161         return value;
162     }
163 
164     private void mandatory(String s, String desc) {
165         if (StringUtils.isEmpty(s)) {
166             throw new RuntimeException(desc + " is mandatory and is missing from the request.");
167         }
168     }
169 }