1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portlet.blogs.action;
16  
17  import com.liferay.portal.kernel.log.Log;
18  import com.liferay.portal.kernel.log.LogFactoryUtil;
19  import com.liferay.portal.kernel.util.ContentTypes;
20  import com.liferay.portal.kernel.util.GetterUtil;
21  import com.liferay.portal.kernel.util.HttpUtil;
22  import com.liferay.portal.kernel.util.ParamUtil;
23  import com.liferay.portal.kernel.util.StringBundler;
24  import com.liferay.portal.kernel.util.StringPool;
25  import com.liferay.portal.kernel.util.Validator;
26  import com.liferay.portal.kernel.workflow.WorkflowConstants;
27  import com.liferay.portal.security.auth.PrincipalException;
28  import com.liferay.portal.service.ServiceContext;
29  import com.liferay.portal.service.ServiceContextFactory;
30  import com.liferay.portal.service.UserLocalServiceUtil;
31  import com.liferay.portal.struts.ActionConstants;
32  import com.liferay.portal.struts.PortletAction;
33  import com.liferay.portal.theme.ThemeDisplay;
34  import com.liferay.portal.util.Portal;
35  import com.liferay.portal.util.PortalUtil;
36  import com.liferay.portal.util.WebKeys;
37  import com.liferay.portlet.PortletPreferencesFactoryUtil;
38  import com.liferay.portlet.blogs.NoSuchEntryException;
39  import com.liferay.portlet.blogs.model.BlogsEntry;
40  import com.liferay.portlet.blogs.util.LinkbackConsumerUtil;
41  import com.liferay.portlet.messageboards.model.MBMessage;
42  import com.liferay.portlet.messageboards.model.MBMessageDisplay;
43  import com.liferay.portlet.messageboards.model.MBThread;
44  import com.liferay.portlet.messageboards.service.MBMessageLocalServiceUtil;
45  import com.liferay.util.servlet.ServletResponseUtil;
46  
47  import javax.portlet.ActionRequest;
48  import javax.portlet.ActionResponse;
49  import javax.portlet.PortletConfig;
50  import javax.portlet.PortletPreferences;
51  
52  import javax.servlet.http.HttpServletRequest;
53  import javax.servlet.http.HttpServletResponse;
54  
55  import org.apache.struts.action.ActionForm;
56  import org.apache.struts.action.ActionMapping;
57  
58  /**
59   * <a href="TrackbackAction.java.html"><b><i>View Source</i></b></a>
60   *
61   * @author Alexander Chow
62   */
63  public class TrackbackAction extends PortletAction {
64  
65      public void processAction(
66              ActionMapping mapping, ActionForm form, PortletConfig portletConfig,
67              ActionRequest actionRequest, ActionResponse actionResponse)
68          throws Exception {
69  
70          try {
71              addTrackback(actionRequest, actionResponse);
72          }
73          catch (NoSuchEntryException nsee) {
74              if (_log.isWarnEnabled()) {
75                  _log.warn(nsee, nsee);
76              }
77          }
78          catch (Exception e) {
79              _log.error(e, e);
80          }
81  
82          setForward(actionRequest, ActionConstants.COMMON_NULL);
83      }
84  
85      protected void addTrackback(
86              ActionRequest actionRequest, ActionResponse actionResponse)
87          throws Exception {
88  
89          ThemeDisplay themeDisplay = (ThemeDisplay)actionRequest.getAttribute(
90              WebKeys.THEME_DISPLAY);
91  
92          String title = ParamUtil.getString(actionRequest, "title");
93          String excerpt = ParamUtil.getString(actionRequest, "excerpt");
94          String url = ParamUtil.getString(actionRequest, "url");
95          String blogName = ParamUtil.getString(actionRequest, "blog_name");
96  
97          if (!isCommentsEnabled(actionRequest)) {
98              sendError(
99                  actionRequest, actionResponse,
100                 "Comments have been disabled for this blog entry.");
101 
102             return;
103         }
104 
105         if (Validator.isNull(url)) {
106             sendError(
107                 actionRequest, actionResponse,
108                 "Trackback requires a valid permanent URL.");
109 
110             return;
111         }
112 
113         HttpServletRequest request = PortalUtil.getHttpServletRequest(
114             actionRequest);
115 
116         String remoteIp = request.getRemoteAddr();
117 
118         String trackbackIp = HttpUtil.getIpAddress(url);
119 
120         if (!remoteIp.equals(trackbackIp)) {
121             sendError(
122                 actionRequest, actionResponse,
123                 "Remote IP " + remoteIp +
124                     " does not match trackback URL's IP " + trackbackIp + ".");
125 
126             return;
127         }
128 
129         try {
130             ActionUtil.getEntry(actionRequest);
131         }
132         catch (PrincipalException pe) {
133             sendError(
134                 actionRequest, actionResponse,
135                 "Blog entry must have guest view permissions to enable " +
136                     "trackbacks.");
137 
138             return;
139         }
140 
141         BlogsEntry entry = (BlogsEntry)actionRequest.getAttribute(
142             WebKeys.BLOGS_ENTRY);
143 
144         if (!entry.isAllowTrackbacks()) {
145             sendError(
146                 actionRequest, actionResponse,
147                 "Trackbacks are not enabled on this blog entry.");
148 
149             return;
150         }
151 
152         long userId = UserLocalServiceUtil.getDefaultUserId(
153             themeDisplay.getCompanyId());
154         long groupId = entry.getGroupId();
155         String className = BlogsEntry.class.getName();
156         long classPK = entry.getEntryId();
157 
158         MBMessageDisplay messageDisplay =
159             MBMessageLocalServiceUtil.getDiscussionMessageDisplay(
160                 userId, groupId, className, classPK,
161                 WorkflowConstants.STATUS_APPROVED);
162 
163         MBThread thread = messageDisplay.getThread();
164 
165         long threadId = thread.getThreadId();
166         long parentMessageId = thread.getRootMessageId();
167         String body =
168             "[...] " + excerpt + " [...] [url=" + url + "]" +
169                 themeDisplay.translate("read-more") + "[/url]";
170 
171         ServiceContext serviceContext = ServiceContextFactory.getInstance(
172             MBMessage.class.getName(), actionRequest);
173 
174         MBMessage message = MBMessageLocalServiceUtil.addDiscussionMessage(
175             null, userId, blogName, groupId, className, classPK, threadId,
176             parentMessageId, title, body, serviceContext);
177 
178         String entryURL =
179             PortalUtil.getLayoutFullURL(themeDisplay) +
180                 Portal.FRIENDLY_URL_SEPARATOR + "blogs/" +
181                     entry.getUrlTitle();
182 
183         LinkbackConsumerUtil.addNewTrackback(
184             message.getMessageId(), url, entryURL);
185 
186         sendSuccess(actionRequest, actionResponse);
187     }
188 
189     protected boolean isCheckMethodOnProcessAction() {
190         return _CHECK_METHOD_ON_PROCESS_ACTION;
191     }
192 
193     protected boolean isCommentsEnabled(ActionRequest actionRequest)
194         throws Exception {
195 
196         PortletPreferences preferences = actionRequest.getPreferences();
197 
198         String portletResource = ParamUtil.getString(
199             actionRequest, "portletResource");
200 
201         if (Validator.isNotNull(portletResource)) {
202             preferences = PortletPreferencesFactoryUtil.getPortletSetup(
203                 actionRequest, portletResource);
204         }
205 
206         return GetterUtil.getBoolean(
207             preferences.getValue("enable-comments", null), true);
208     }
209 
210     protected void sendError(
211             ActionRequest actionRequest, ActionResponse actionResponse,
212             String msg)
213         throws Exception {
214 
215         sendResponse(actionRequest, actionResponse, msg, false);
216     }
217 
218     protected void sendResponse(
219             ActionRequest actionRequest, ActionResponse actionResponse,
220             String msg, boolean success)
221         throws Exception {
222 
223         StringBundler sb = new StringBundler(7);
224 
225         sb.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
226         sb.append("<response>");
227 
228         if (success) {
229             sb.append("<error>0</error>");
230         }
231         else {
232             sb.append("<error>1</error>");
233             sb.append("<message>");
234             sb.append(msg);
235             sb.append("</message>");
236         }
237 
238         sb.append("</response>");
239 
240         HttpServletRequest request = PortalUtil.getHttpServletRequest(
241             actionRequest);
242         HttpServletResponse response = PortalUtil.getHttpServletResponse(
243             actionResponse);
244 
245         ServletResponseUtil.sendFile(
246             request, response, null, sb.toString().getBytes(StringPool.UTF8),
247             ContentTypes.TEXT_XML_UTF8);
248     }
249 
250     protected void sendSuccess(
251             ActionRequest actionRequest, ActionResponse actionResponse)
252         throws Exception {
253 
254         sendResponse(actionRequest, actionResponse, null, true);
255     }
256 
257     private static final boolean _CHECK_METHOD_ON_PROCESS_ACTION = false;
258 
259     private static Log _log = LogFactoryUtil.getLog(TrackbackAction.class);
260 
261 }