001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.assetpublisher.action;
016    
017    import com.liferay.portal.kernel.language.LanguageUtil;
018    import com.liferay.portal.kernel.portlet.LiferayPortletRequest;
019    import com.liferay.portal.kernel.portlet.LiferayPortletResponse;
020    import com.liferay.portal.kernel.util.GetterUtil;
021    import com.liferay.portal.kernel.util.Http;
022    import com.liferay.portal.kernel.util.StringBundler;
023    import com.liferay.portal.kernel.util.StringPool;
024    import com.liferay.portal.kernel.util.Validator;
025    import com.liferay.portal.model.Layout;
026    import com.liferay.portal.theme.PortletDisplay;
027    import com.liferay.portal.theme.ThemeDisplay;
028    import com.liferay.portal.util.Portal;
029    import com.liferay.portal.util.PortalUtil;
030    import com.liferay.portal.util.WebKeys;
031    import com.liferay.portlet.asset.AssetRendererFactoryRegistryUtil;
032    import com.liferay.portlet.asset.model.AssetEntry;
033    import com.liferay.portlet.asset.model.AssetRenderer;
034    import com.liferay.portlet.asset.model.AssetRendererFactory;
035    import com.liferay.portlet.assetpublisher.util.AssetPublisherUtil;
036    import com.liferay.util.RSSUtil;
037    
038    import com.sun.syndication.feed.synd.SyndContent;
039    import com.sun.syndication.feed.synd.SyndContentImpl;
040    import com.sun.syndication.feed.synd.SyndEntry;
041    import com.sun.syndication.feed.synd.SyndEntryImpl;
042    import com.sun.syndication.feed.synd.SyndFeed;
043    import com.sun.syndication.feed.synd.SyndFeedImpl;
044    import com.sun.syndication.feed.synd.SyndLink;
045    import com.sun.syndication.feed.synd.SyndLinkImpl;
046    
047    import java.util.ArrayList;
048    import java.util.Date;
049    import java.util.List;
050    
051    import javax.portlet.PortletPreferences;
052    import javax.portlet.PortletRequest;
053    import javax.portlet.PortletResponse;
054    import javax.portlet.ResourceRequest;
055    import javax.portlet.ResourceResponse;
056    
057    /**
058     * @author Brian Wing Shun Chan
059     * @author Julio Camarero
060     */
061    public class RSSAction extends com.liferay.portal.struts.RSSAction {
062    
063            protected String exportToRSS(
064                            PortletRequest portletRequest, PortletResponse portletResponse,
065                            String name, String description, String format, double version,
066                            String displayStyle, String linkBehavior,
067                            List<AssetEntry> assetEntries)
068                    throws Exception {
069    
070                    ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
071                            WebKeys.THEME_DISPLAY);
072    
073                    SyndFeed syndFeed = new SyndFeedImpl();
074    
075                    syndFeed.setDescription(GetterUtil.getString(description, name));
076    
077                    List<SyndEntry> syndEntries = new ArrayList<SyndEntry>();
078    
079                    syndFeed.setEntries(syndEntries);
080    
081                    for (AssetEntry assetEntry : assetEntries) {
082                            String link = getEntryURL(
083                                    portletRequest, portletResponse, linkBehavior, assetEntry);
084    
085                            if (Validator.isBlank(link)) {
086                                    continue;
087                            }
088    
089                            SyndEntry syndEntry = new SyndEntryImpl();
090    
091                            syndEntry.setLink(link);
092    
093                            String author = PortalUtil.getUserName(assetEntry);
094    
095                            syndEntry.setAuthor(author);
096    
097                            SyndContent syndContent = new SyndContentImpl();
098    
099                            syndContent.setType(RSSUtil.ENTRY_TYPE_DEFAULT);
100    
101                            String value = null;
102    
103                            String languageId = LanguageUtil.getLanguageId(portletRequest);
104    
105                            if (displayStyle.equals(RSSUtil.DISPLAY_STYLE_TITLE)) {
106                                    value = StringPool.BLANK;
107                            }
108                            else {
109                                    value = assetEntry.getSummary(languageId, true);
110                            }
111    
112                            syndContent.setValue(value);
113    
114                            syndEntry.setDescription(syndContent);
115    
116                            syndEntry.setPublishedDate(assetEntry.getPublishDate());
117                            syndEntry.setTitle(assetEntry.getTitle(languageId, true));
118                            syndEntry.setUpdatedDate(assetEntry.getModifiedDate());
119                            syndEntry.setUri(syndEntry.getLink());
120    
121                            syndEntries.add(syndEntry);
122                    }
123    
124                    syndFeed.setFeedType(RSSUtil.getFeedType(format, version));
125    
126                    List<SyndLink> syndLinks = new ArrayList<SyndLink>();
127    
128                    syndFeed.setLinks(syndLinks);
129    
130                    SyndLink selfSyndLink = new SyndLinkImpl();
131    
132                    syndLinks.add(selfSyndLink);
133    
134                    String feedURL = getFeedURL(portletRequest);
135    
136                    selfSyndLink.setHref(feedURL);
137    
138                    selfSyndLink.setRel("self");
139    
140                    SyndLink alternateSyndLink = new SyndLinkImpl();
141    
142                    syndLinks.add(alternateSyndLink);
143    
144                    alternateSyndLink.setHref(PortalUtil.getLayoutFullURL(themeDisplay));
145                    alternateSyndLink.setRel("alternate");
146    
147                    syndFeed.setPublishedDate(new Date());
148                    syndFeed.setTitle(name);
149                    syndFeed.setUri(feedURL);
150    
151                    return RSSUtil.export(syndFeed);
152            }
153    
154            protected List<AssetEntry> getAssetEntries(
155                            PortletRequest portletRequest,
156                            PortletPreferences portletPreferences)
157                    throws Exception {
158    
159                    ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
160                            WebKeys.THEME_DISPLAY);
161    
162                    int rssDelta = GetterUtil.getInteger(
163                            portletPreferences.getValue("rssDelta", "20"));
164    
165                    return AssetPublisherUtil.getAssetEntries(
166                            portletPreferences, themeDisplay.getLayout(),
167                            themeDisplay.getScopeGroupId(), rssDelta, true);
168            }
169    
170            protected String getAssetPublisherURL(PortletRequest portletRequest)
171                    throws Exception {
172    
173                    ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
174                            WebKeys.THEME_DISPLAY);
175    
176                    Layout layout = themeDisplay.getLayout();
177    
178                    PortletDisplay portletDisplay = themeDisplay.getPortletDisplay();
179    
180                    StringBundler sb = new StringBundler(7);
181    
182                    String layoutFriendlyURL = GetterUtil.getString(
183                            PortalUtil.getLayoutFriendlyURL(layout, themeDisplay));
184    
185                    if (!layoutFriendlyURL.startsWith(Http.HTTP_WITH_SLASH) &&
186                            !layoutFriendlyURL.startsWith(Http.HTTPS_WITH_SLASH)) {
187    
188                            sb.append(themeDisplay.getPortalURL());
189                    }
190    
191                    sb.append(layoutFriendlyURL);
192                    sb.append(Portal.FRIENDLY_URL_SEPARATOR);
193                    sb.append("asset_publisher/");
194                    sb.append(portletDisplay.getInstanceId());
195                    sb.append(StringPool.SLASH);
196    
197                    return sb.toString();
198            }
199    
200            protected String getEntryURL(
201                            PortletRequest portletRequest, PortletResponse portletResponse,
202                            String linkBehavior, AssetEntry assetEntry)
203                    throws Exception {
204    
205                    if (linkBehavior.equals("viewInPortlet")) {
206                            return getEntryURLViewInContext(
207                                    portletRequest, portletResponse, assetEntry);
208                    }
209                    else {
210                            return getEntryURLAssetPublisher(
211                                    portletRequest, portletResponse, assetEntry);
212                    }
213            }
214    
215            protected String getEntryURLAssetPublisher(
216                            PortletRequest portletRequest, PortletResponse portletResponse,
217                            AssetEntry assetEntry)
218                    throws Exception {
219    
220                    AssetRendererFactory assetRendererFactory =
221                            AssetRendererFactoryRegistryUtil.getAssetRendererFactoryByClassName(
222                                    assetEntry.getClassName());
223    
224                    if (assetRendererFactory == null) {
225                            return StringPool.BLANK;
226                    }
227    
228                    StringBundler sb = new StringBundler(4);
229    
230                    sb.append(getAssetPublisherURL(portletRequest));
231                    sb.append(assetRendererFactory.getType());
232                    sb.append("/id/");
233                    sb.append(assetEntry.getEntryId());
234    
235                    return sb.toString();
236            }
237    
238            protected String getEntryURLViewInContext(
239                            PortletRequest portletRequest, PortletResponse portletResponse,
240                            AssetEntry assetEntry)
241                    throws Exception {
242    
243                    AssetRendererFactory assetRendererFactory =
244                            AssetRendererFactoryRegistryUtil.getAssetRendererFactoryByClassName(
245                                    assetEntry.getClassName());
246    
247                    if (assetRendererFactory == null) {
248                            return StringPool.BLANK;
249                    }
250    
251                    AssetRenderer assetRenderer = assetRendererFactory.getAssetRenderer(
252                            assetEntry.getClassPK());
253    
254                    String viewInContextURL = assetRenderer.getURLViewInContext(
255                            (LiferayPortletRequest)portletRequest,
256                            (LiferayPortletResponse)portletResponse, null);
257    
258                    if (Validator.isNotNull(viewInContextURL) &&
259                            !viewInContextURL.startsWith(Http.HTTP_WITH_SLASH) &&
260                            !viewInContextURL.startsWith(Http.HTTPS_WITH_SLASH)) {
261    
262                            ThemeDisplay themeDisplay =
263                                    (ThemeDisplay)portletRequest.getAttribute(
264                                            WebKeys.THEME_DISPLAY);
265    
266                            viewInContextURL = themeDisplay.getPortalURL() + viewInContextURL;
267                    }
268    
269                    return viewInContextURL;
270            }
271    
272            protected String getFeedURL(PortletRequest portletRequest)
273                    throws Exception {
274    
275                    String feedURL = getAssetPublisherURL(portletRequest);
276    
277                    return feedURL.concat("rss");
278            }
279    
280            @Override
281            protected byte[] getRSS(
282                            ResourceRequest portletRequest, ResourceResponse portletResponse)
283                    throws Exception {
284    
285                    PortletPreferences portletPreferences = portletRequest.getPreferences();
286    
287                    String selectionStyle = portletPreferences.getValue(
288                            "selectionStyle", "dynamic");
289    
290                    if (!selectionStyle.equals("dynamic")) {
291                            return new byte[0];
292                    }
293    
294                    String assetLinkBehavior = portletPreferences.getValue(
295                            "assetLinkBehavior", "showFullContent");
296                    String rssDisplayStyle = portletPreferences.getValue(
297                            "rssDisplayStyle", RSSUtil.DISPLAY_STYLE_ABSTRACT);
298                    String rssFeedType = portletPreferences.getValue(
299                            "rssFeedType", RSSUtil.FEED_TYPE_DEFAULT);
300                    String rssName = portletPreferences.getValue("rssName", null);
301    
302                    String format = RSSUtil.getFeedTypeFormat(rssFeedType);
303                    double version = RSSUtil.getFeedTypeVersion(rssFeedType);
304    
305                    String rss = exportToRSS(
306                            portletRequest, portletResponse, rssName, null, format, version,
307                            rssDisplayStyle, assetLinkBehavior,
308                            getAssetEntries(portletRequest, portletPreferences));
309    
310                    return rss.getBytes(StringPool.UTF8);
311            }
312    
313            @Override
314            protected boolean isRSSFeedsEnabled(PortletRequest portletRequest)
315                    throws Exception {
316    
317                    if (!super.isRSSFeedsEnabled(portletRequest)) {
318                            return false;
319                    }
320    
321                    PortletPreferences portletPreferences = portletRequest.getPreferences();
322    
323                    return GetterUtil.getBoolean(
324                            portletPreferences.getValue("enableRss", null));
325            }
326    
327    }