1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.rss.web;
35
36 import com.sun.syndication.feed.WireFeed;
37 import com.sun.syndication.io.FeedException;
38 import com.sun.syndication.io.WireFeedOutput;
39
40 import fr.paris.lutece.plugins.rss.business.RssFeed;
41 import fr.paris.lutece.plugins.rss.business.RssFeedHome;
42 import fr.paris.lutece.plugins.rss.service.type.FeedTypeManager;
43 import fr.paris.lutece.portal.business.rss.IFeedResource;
44 import fr.paris.lutece.portal.business.rss.IResourceRss;
45 import fr.paris.lutece.portal.service.util.AppLogService;
46
47 import org.apache.commons.lang3.StringUtils;
48
49
50 /**
51 *
52 * RSSUtil.
53 */
54 public final class FeedUtil
55 {
56 /**
57 * Utility class
58 */
59 private FeedUtil( )
60 {
61 // nothing
62 }
63
64 /**
65 * Gets an XML for the given resource.
66 * @param resource resource
67 * @param strFeedType feed type
68 * @param strEncoding encoding
69 * @param nMaxItems max items
70 * @return the xml generated
71 */
72 public static String getFeed( IFeedResource resource, String strFeedType, String strEncoding, int nMaxItems )
73 {
74 if ( resource.getItems( ).isEmpty( ) )
75 {
76 return StringUtils.EMPTY;
77 }
78
79 // WireFeed does not contain enough data, but can be passed for output generation.
80 WireFeed wireFeed = FeedTypeManager.getManager( ).getWireFeed( strFeedType, resource, strEncoding, nMaxItems );
81
82 WireFeedOutput output = new WireFeedOutput( );
83 String strXML = StringUtils.EMPTY;
84
85 try
86 {
87 strXML = output.outputString( wireFeed );
88 }
89 catch ( IllegalArgumentException | FeedException e )
90 {
91 AppLogService.error( e.getMessage( ), e );
92 }
93
94 return strXML;
95 }
96
97 /**
98 * Gets an XML for the given resource.
99 * @param resourceRSS the resource
100 * @return the XML as String, encoding is {@link IResourceRss#getEncoding()}. Returns an empty String if no items.
101 * Returns <code>{@link IResourceRss#createHtmlRss()}</code> if {@link IResourceRss#getFeed()} is not implemented yet.
102 */
103 public static String getFeed( IResourceRss resourceRSS )
104 {
105 IFeedResource resource = resourceRSS.getFeed( );
106
107 if ( resource == null )
108 {
109 // no implementation - use the deprecated
110 return RssFeedHome.create( (RssFeed) resourceRSS ).toString( );
111 }
112
113 if ( resource.getItems( ).isEmpty( ) )
114 {
115 // an empty feed will fail
116 return StringUtils.EMPTY;
117 }
118
119 return getFeed( resource, resourceRSS.getFeedType( ), resourceRSS.getEncoding( ), resourceRSS.getMaxItems( ) );
120 }
121 }