View Javadoc
1   /*
2    * Copyright (c) 2002-2024, City of 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.blog.web.insertservice;
35  
36  import java.util.ArrayList;
37  import java.util.List;
38  
39  import javax.servlet.http.HttpServletRequest;
40  
41  import org.apache.commons.collections4.CollectionUtils;
42  
43  import fr.paris.lutece.plugins.blog.business.Blog;
44  import fr.paris.lutece.plugins.blog.business.insertservice.BlogLinkPOJO;
45  import fr.paris.lutece.plugins.blog.service.BlogService;
46  import fr.paris.lutece.plugins.blog.utils.BlogUtils;
47  import fr.paris.lutece.util.url.UrlItem;
48  
49  public class BlogResourceInsertServiceJspBean extends AbstractBlogInsertServiceJspBean
50  {
51      private static final long serialVersionUID = 6107987688167050292L;
52  
53      // Parameters
54      private static final String PARAMETER_SELECTED_DOCUMENT_ID = "selected_document_id";
55  
56      // Blog Servlet URL
57      private static final String DOCUMENT_RESOURCE_SERVLET_URL = "servlet/plugins/blogs/file";
58  
59      // Constants
60      private static final String CONSTANT_BLOG_RESOURCE_INSERT_SERVICE = "blog_resource_insert_service";
61      private static final String CONSTANT_ID_FILE = "id_file";
62  
63      /**
64       * {@inheritDoc}
65       */
66      @Override
67      public String getInsertServiceSelectorUI( HttpServletRequest request )
68      {
69          setInsertServiceType( CONSTANT_BLOG_RESOURCE_INSERT_SERVICE );
70          return super.getInsertServiceSelectorUI( request );
71      }
72  
73      /**
74       * {@inheritDoc}
75       */
76      @Override
77      public String doSearchBlogLink( HttpServletRequest request )
78      {
79          List<Integer> blogIdsList = getBlogIdsWithFilter( request );
80          // List of Blog object returned to the user
81          List<Blog> blogResultList = new ArrayList<>( );
82  
83          for ( Integer blogId : blogIdsList )
84          {
85              Blog blog = BlogService.getInstance( ).loadBlog( blogId );
86              // Check if the specified blog exists and contains any document
87              if ( blog != null && CollectionUtils.isNotEmpty( blog.getDocContent( ) ) )
88              {
89                  blogResultList.add( blog );
90              }
91          }
92          setBlogList( blogResultList );
93  
94          // Reload the main view to display the list of blogs matching the user's search
95          return getInsertServiceSelectorUI( request );
96      }
97  
98      /**
99       * {@inheritDoc}
100      */
101     @Override
102     public String doInsertBlogLink( HttpServletRequest request )
103     {
104         String strInput = request.getParameter( PARAMETER_INPUT );
105 
106         // Retrieve the specified values (url, text...) for the link being created
107         BlogLinkPOJO blogLinkContent = getSelectedBlogData( request );
108 
109         // Retrieve the ID of the document Resource which has been selected
110         String strSelectedDocumentId = request.getParameter( PARAMETER_SELECTED_DOCUMENT_ID );
111         int documentId = Integer.parseInt( strSelectedDocumentId );
112 
113         // Build the complete link
114         String strBlogLink = buildBlogResourceLink( documentId, blogLinkContent.getBlogLinkText( ), blogLinkContent.getBlogLinkTitle( ),
115                 blogLinkContent.getBlogLinkTargetedWindow( ) );
116 
117         // Insert the link in the editor
118         return insertUrlWithoutEscape( request, strInput, strBlogLink );
119     }
120 
121     /**
122      * {@inheritDoc}
123      */
124     @Override
125     protected BlogLinkPOJO getSelectedBlogData( HttpServletRequest request )
126     {
127         // Get the text to display on the blog link
128         String blogLinkText = request.getParameter( PARAMETER_LINK_TEXT );
129 
130         // Get the title of the link
131         String blogLinkTitle = request.getParameter( PARAMETER_LINK_TITLE );
132 
133         // Get the type of target window to use for the links
134         String targetedWindow = BlogUtils.CONSTANT_LINK_TARGET_NEW_WINDOW;
135 
136         return new BlogLinkPOJO( blogLinkText, blogLinkTitle, targetedWindow, null );
137     }
138 
139     /**
140      * Build a URL link to reach a blog's Resource (file, image...)
141      * 
142      * @param blogResourceId
143      *            The ID of the resource
144      * @param customlinkText
145      *            The text shown in the link
146      * @param customLinkTitle
147      *            The title of the link
148      * @param targetedWindow
149      *            The window targeted when the link is clicked
150      * @return an HTML link for the Resource's URL
151      */
152     private String buildBlogResourceLink( int blogResourceId, String customlinkText, String customLinkTitle, String targetedWindow )
153     {
154         // Build the URL of the blog's Resource document
155         UrlItem url = new UrlItem( DOCUMENT_RESOURCE_SERVLET_URL );
156         url.addParameter( CONSTANT_ID_FILE, blogResourceId );
157 
158         return BlogUtils.buildCustomBlogLink( url.getUrl( ), customlinkText, customLinkTitle, targetedWindow );
159     }
160 
161     /**
162      * {@inheritDoc}
163      */
164     @Override
165     protected String buildBlogLink( Blog blog, String customlinkText, String customLinkTitle, String targetedWindow )
166     {
167         return null;
168     }
169 }